objconfig.processor package

Submodules

objconfig.processor.processorinterface module

This is a port of zend-config to Python

Some idioms of PHP are still employed, but where possible I have Pythonized it

Following is the header as given in zend-config:

/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the
 *            canonical source repository
 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc.
 *            (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

class objconfig.processor.processorinterface.ProcessorInterface

Bases: object

The following is an ‘interface’ (abstraction) to be implemented by all configuration processors

process(value)

Following is the header as given in zend-config:

/**
 * Process the whole Config structure and recursively parse all its values.
 *
 * @param  Config $value
 * @return Config
 */

processValue(value)

Following is the header as given in zend-config:

/**
 * Process a single value
 *
 * @param  mixed $value
 * @return mixed
 */

objconfig.processor.token module

This is a port of zend-config to Python

Some idioms of PHP are still employed, but where possible I have Pythonized it

Following is the header as given in zend-config:

/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the
 *            canonical source repository
 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc.
 *            (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

class objconfig.processor.token.Token(tokens=None, prefix=”, suffix=”)

Bases: objconfig.processor.processorinterface.ProcessorInterface

Following is the class documentation as given in zend-config:

No class documentation was given.

addToken(token, value)

Following is the class documentation as given in zend-config:

/**
 * Add new token.
 *
 * @param  string $token
 * @param  mixed $value
 * @return Token
 * @throws Exception\InvalidArgumentException
 */

buildMap()

Following is the class documentation as given in zend-config:

/**
 * Build replacement map
 *
 * @return array
 */

doProcess(value, replacements)

CHANGELOG: objconfig v1.1: edit value in place rather than return copy - 3/2/2017

Following is the class documentation as given in zend-config:

/**
 * Applies replacement map to the given value by modifying the value itself
 *
 * @param mixed $value
 * @param array $replacements
 *
 * @return mixed
 *
 * @throws Exception\InvalidArgumentException if the provided value is a read-only {@see Config}
 */

getPrefix()

Following is the class documentation as given in zend-config:

/**
 * @return string
 */

getSuffix()

Following is the class documentation as given in zend-config:

/**
 * @return string
 */

getTokens()

Following is the class documentation as given in zend-config:

/**
 * Get current token registry.
 *
 * @return array
 */

process(config)

Following is the class documentation as given in zend-config:

/**
 * Process
 *
 * @param  Config $config
 * @return Config
 * @throws Exception\InvalidArgumentException
 */

processValue(value)

Following is the class documentation as given in zend-config:

/**
 * Process a single value
 *
 * @param $value
 * @return mixed
 */

setPrefix(prefix)

Following is the class documentation as given in zend-config:

/**
 * @param  string $prefix
 * @return Token
 */

setSuffix(suffix)

Following is the class documentation as given in zend-config:

/**
 * @param  string $suffix
 * @return Token
 */

setToken(token, value)

Following is the class documentation as given in zend-config:

/**
 * Add new token.
 *
 * @param string $token
 * @param mixed $value
 * @return Token
 */

setTokens(tokens)

Following is the class documentation as given in zend-config:

/**
 * Set token registry.
 *
 * @param  array|Config|Traversable  $tokens  Associative array of TOKEN => value
 *                                            to replace it with
 * @return Token
 * @throws Exception\InvalidArgumentException
 */

Module contents