\midcom_services_rcs_config

The config class is used to generate the RCS configuration.

Summary

Methods
Properties
Constants
__construct()
get_handler()
get_rcs_root()
use_rcs()
get_bin_prefix()
test_rcs_config()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
_get_handler_class()
$config
N/A

Properties

$config

$config : array

The array of configuration options

Type

array

Methods

__construct()

__construct(  $config_array) 

Constructor

Parameters

$config_array

get_handler()

get_handler(  $object) : \midcom_services_rcs_backend

Factory function for the handler object.

Parameters

$object

Returns

\midcom_services_rcs_backend

get_rcs_root()

get_rcs_root() 

Returns the root of the directory containing the RCS files.

use_rcs()

use_rcs() : boolean

If the RCS service is enabled (set by midcom_services_rcs_use)

Returns

boolean —

true if it is enabled

get_bin_prefix()

get_bin_prefix() 

Returns the prefix for the rcs utilities.

test_rcs_config()

test_rcs_config() 

Checks if the basic rcs service is usable.

_get_handler_class()

_get_handler_class() : string

Loads the backend file needed and returns the class.

Returns

string —

of the backend to start