NAME

RPC::ExtDirect::Config - Centralized configuration handling for RPC::ExtDirect

SYNOPSIS

use RPC::ExtDirect::Config;

my $cfg = RPC::ExtDirect::Config->new(
    option1 => 'value1',
    option2 => 42,
    ...
);

my $option1 = $cfg->option1();
$cfg->option1('value2');

DESCRIPTION

This package implements configuration handling for various RPC::ExtDirect modules in a centralized and consistent fashion.

RPC::ExtDirect::Config also supports the legacy configuration approach via package global variables, as implemented in RPC::ExtDirect 1.x and 2.x. Note that using package global vars is deprecated, and Config will emit a warning for every such variable. The value in the variable will still take effect, despite the warning.

CHAINED OPTIONS

Besides simple configuration options, RPC::ExtDirect::Config supports "chained" options that fall back to another option when no value is provided.

Assume an option foo that is chained to option bar. When assigning values, Config will set both foo and bar independently. When retrieving value for option bar, Config will first look if bar has any value defined for it and return it if there is one. However, when there is no value defined for bar, Config will then "fall back" to the value of foo, and return it instead.

This allows for very granular configuration of different parts of the RPC::ExtDirect stack. For example, you can turn on global debugging with the "debug" option, and turn off Request debugging by setting "debug_request" to falsy value.

It is possible to add your own configuration options, both simple and chained. Read RPC::ExtDirect::Config source to see how it is done.

ACCESSOR METHODS

For every option held in a Config instance, there are two accessor methods created automatically: a getter/setter, and a predicate. Assuming an option named foo, these accessors will be:

has_foo(): A predicate method is used to check if a value has been set for an option, even if that value is undefined. Note that a predicate is never chained, and if a foo value does not exist the predicate will return false without falling back to bar.
foo(): A getter/setter method can be used to read and write the value. Called with no arguments, it acts as a getter and returns the value for an option; when called with one or more arguments, it will replace the existing value with the first argument, ignoring any others.

OPTIONS

The stock RPC::ExtDirect::Config supports the following options:

api_action_class

Class name to use instead of RPC::ExtDirect::API::Action when creating the API tree. Action objects instantiated from this class will hold collections of Method objects.

Use this option to override or inject new functionality in Action objects.

Default: 'RPC::ExtDirect::API::Action'.

api_method_class

Class name to use instead of RPC::ExtDirect::API::Method when creating the API tree. Method objects will be instantiated from this class.

Use this option to override or inject new functionality in Method objects.

Default: 'RPC::ExtDirect::API::Method'.

api_hook_class

Class name to be used instead of RPC::ExtDirect::API::Hook when creating the API tree. Hook objects will be instantiated from this class.

Use this option to override or inject new functionality in Hook objects.

Default: 'RPC::ExtDirect::API::Hook'.

api_full_action_names

When set to truthy value, API Action names will default to package name with '::' replaced with dots: 'Foo::Bar::Baz' -> 'Foo.Bar.Baz', instead of using only the last chunk of the package name: 'Foo::Bar::Baz' -> 'Baz'.

Default: !1 (false).

debug

Turn global debugging flag on or off.

Default: !1 (false).

debug_api

Turn API debugging on or off. At this time, the only effect is that the API JavaScript is pretty printed when debugging.