https://github.com/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
https://github.com/samcrosoft/constantaccess

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/samcrosoft/constantaccess
• Owner: samcrosoft
• Created: 2013-02-10T00:06:24.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2015-11-28T15:55:28.000Z (over 9 years ago)
• Last Synced: 2025-01-29T12:30:18.659Z (5 months ago)
• Language: PHP
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/samcrosoft/constantaccess.svg?branch=master)](https://travis-ci.org/samcrosoft/constantaccess)

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




## Example

Create an object of the constant access library and then start creating or reading constants


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







## 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**

e.g


	$aData = array(

					'const1'  => 2,

					'const2'  => 22,

					'_const3' => 'another constant'

				   );


 // then create it now as

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






### 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






### Throwing Exceptions

To create a valid php constant, the following conditions must be met

- 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

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




### Enabling Exceptions

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

 - At the creation of the class object

 - By using the **setThrowException** method

 **e.g**

 

 1 - $oConst = new Samcrosoft\ConstantAccess\ConstantAccess(array(), true);

 2 - $oConst->setThrowException(false);

 





### 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


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


 $oConst->setValueReturnIfNotDefined(null);

 hence, $oConst->UNDEFINED; would return null






### Reading / Accessing Constants


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






### Tests

 just run Phpunit in the folder where you have placed the library




### Examples

examples are located in the **/examples** folder