samcrosoft/constantaccess

This library makes it possible to create and read (access) constants using an array-like object or a typical class object to make it possible to use constants in strings without the need of concatenation of strings

, _(*1)

constantaccess

This library makes it possible to create and read (access) constants using an array-like object or a typical class object to make it possible to use constants in strings without the need of concatenation of strings, _(*2)

br/, _(*3)

Example

Create an object of the constant access library and then start creating or reading constants, _(*4)

$oConst = new Samcrosoft\ConstantAccess\ConstantAccess();

br/, _(*5)

Instantiating The Constant Class With An Array

you can supply an array key=>pair values for constants to create, NOTE: this array should be a 1 dimensional array, _(*6)

e.g, _(*7)

    $aData = array(
                    'const1'  => 2,
                    'const2'  => 22,
                    '_const3' => 'another constant'
                   );

 // then create it now as

 $oConst = new Samcrosoft\ConstantAccess\ConstantAccess($aData);

br/, _(*8)

Creating Constants Using Object Method or Array Access

$oConst->CONST1 = 23;               This creates a constant called CONST1
$oConst['CONST2'] = "constant 2";   This creates another constant called CONST2

br/, _(*9)

Throwing Exceptions

To create a valid php constant, the following conditions must be met, _(*10)

• A constant key can only be a valid php variable name
• A Constant value can only be a value of scalar type,

Before creating a constant, the above tests are conducted, hence there are possibilities of exceptions been thrown if any of the above listed conditions are not adhered to or met, _(*11)

The ConstantAccess dies silently i.e it does not throw any exception by default but for good programming practice, you should handle all possibilites of exceptions, _(*12)

br/, _(*13)

Enabling Exceptions

You can enable the exceptions in two(2) ways,, _(*14)

• At the creation of the class object

• By using the setThrowException method, _(*15)

  e.g, _(*16)

 1 - $oConst = new Samcrosoft\ConstantAccess\ConstantAccess(array(), true);
 2 - $oConst->setThrowException(false);
 

br/, _(*17)

Default Return Value

If a constant is not defined, you can configure a default return value that is returned in that case instead of breaking ur application, _(*18)

 e.g To set the default return value to null, you do the following

 $oConst->setValueReturnIfNotDefined(null);

 hence, $oConst->UNDEFINED; would return null

br/, _(*19)

Reading / Accessing Constants

print "this is a trial message with {$oConst->CONST1} or another {$oConst->CONST2}";

br/, _(*20)

Tests

just run Phpunit in the folder where you have placed the library, _(*21)

br/, _(*22)

Examples

examples are located in the /examples folder, _(*23)