NAME

Data::Object::Config

ABSTRACT

Data-Object Package Configuration

SYNOPSIS

  use Data::Object::Config;

DESCRIPTION

Data::Object::Config is used to configure the consuming package based on arguments passed to the import statement.

FUNCTIONS

This package implements the following functions.

choose

  choose(Str $arg1) : ArrayRef

The choose function returns the configuration (plans) based on the argument passed.

choose example
  choose('class');

config

  config(ArrayRef $arg1) : ArrayRef

The config function returns plans for configuring a package with the standard Data::Object setup.

config example
  my $plans = config;

config_array

  config_array() : ArrayRef

The config_array function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Array.

config_array example
  my $plans = config_array;

config_class

  config_class() : ArrayRef

The config_class function returns plans for configuring the package to be a Data::Object::Class.

config_class example
  my $plans = config_class;

config_cli

  config_cli() : ArrayRef

The config_cli function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Cli.

config_cli example
  my $plans = config_cli;

config_code

  config_code() : ArrayRef

The config_code function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Code.

config_code example
  my $plans = config_code;

config_dispatch

  config_dispatch() : ArrayRef

The config_dispatch function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Dispatch.

config_dispatch example
  my $plans = config_dispatch;

config_exception

  config_exception() : ArrayRef

The config_exception function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Exception.

config_exception example
  my $plans = config_exception;

config_float

  config_float() : ArrayRef

The config_float function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Float.

config_float example
  my $plans = config_float;

config_hash

  config_hash() : ArrayRef

The config_hash function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Hash.

config_hash example
  my $plans = config_hash;

config_integer

  config_integer() : ArrayRef

The config_integer function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Integer.

config_integer example
  my $plans = config_integer;

config_json

  config_json() : ArrayRef

The config_json function returns plans for configuring the package to have a json function that loads a Data::Object::Json object.

config_json example
  my $plans = config_json;

config_kind

  config_kind() : ArrayRef

The config_kind function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Kind.

config_kind example
  my $plans = config_kind;

config_number

  config_number() : ArrayRef

The config_number function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Number.

config_number example
  my $plans = config_number;

config_path

  config_path() : ArrayRef

The config_path function returns plans for configuring the package to have a path function that loads a Data::Object::Path object.

config_path example
  my $plans = config_path;

config_regexp

  config_regexp() : ArrayRef

The config_regexp function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Regexp.

config_regexp example
  my $plans = config_regexp;

config_replace

  config_replace() : ArrayRef

The config_replace function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Replace.

config_replace example
  my $plans = config_replace;

config_role

  config_role() : ArrayRef

The config_role function returns plans for configuring the package to be a Data::Object::Role.

config_role example
  my $plans = config_role;

config_rule

  config_rule() : ArrayRef

The config_rule function returns plans for configuring a package to be a Data::Object::Rule.

config_rule example
  my $plans = config_rule;

config_scalar

  config_scalar() : ArrayRef

The config_scalar function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Scalar.

config_scalar example
  my $plans = config_scalar;
  config_search() : ArrayRef

The config_search function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Search.

config_search example
  my $plans = config_search;

config_state

  config_state() : ArrayRef

The config_state function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::State.

config_state example
  my $plans = config_state;

config_string

  config_string() : ArrayRef

The config_string function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::String.

config_string example
  my $plans = config_string;

config_tmpl

  config_tmpl() : ArrayRef

The config_tmpl function returns plans for configuring the package to have a tmpl function that loads a Data::Object::Template object.

config_tmpl example
  my $plans = config_tmpl;

config_try

  config_try() : ArrayRef

The config_try function returns plans for configuring the package to have try and catch constructs for trapping exceptions.

config_try example
  my $plans = config_try;

config_type

  config_type() : ArrayRef

The config_type function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Type.

config_type example
  my $plans = config_type;

config_undef

  config_undef() : ArrayRef

The config_undef function returns plans for configuring the package to be a Data::Object::Class which extends Data::Object::Undef.

config_undef example
  my $plans = config_undef;

config_yaml

  config_yaml() : ArrayRef

The config_yaml function returns plans for configuring the package to have a yaml function that loads a Data::Object::Yaml object.

config_yaml example
  my $plans = config_yaml;

prepare

  prepare(Str $arg1, Str $arg2) : ArrayRef

The prepare function returns configuration plans based on the arguments passed.

prepare example
  prepare($package, $type);

prepare_add

  prepare_add(Str $arg1, Str $arg2) : ArrayRef

The prepare_add function returns an add-plan for the arguments passed.

prepare_add example
  prepare_add($package, $function);

prepare_call

  prepare_call(Str $arg1, Any @args) : ArrayRef

The prepare_call function returns a call-plan for the arguments passed.

prepare_call example
  prepare_call($function, @args);

prepare_use

  prepare_use(Str $arg1, Any @args) : ArrayRef

The prepare_use function returns a use-plan for the arguments passed.

prepare_use example
  prepare_use($package, @args);

process

  process(Str $arg1, ArrayRef $arg2) : Any

The process function executes a series of plans on behalf of the caller.

process example
  process($caller, $plans);

process_add

  process_add(Str $arg1, ArrayRef $arg2) : Any

The process_add function executes the add-plan on behalf of the caller.

process_add example
  process_add($caller, $plan);

process_call

  process_call(Str $arg1, ArrayRef $arg2) : Any

The process_call function executes the call-plan on behalf of the caller.

process_call example
  process_call($caller, $plan);

process_use

  process_use(Str $arg1, ArrayRef $arg2) : Any

The process_use function executes the use-plan on behalf of the caller.

process_use example
  process_use($caller, $plan);

subject

  subject(Str $arg1, Str $arg2) : Int

The subject function returns truthy if both arguments match alphanumerically (not case-sensitive).

subject example
  subject('-Role', 'Role');