Class Token

Summary

Fully Qualified Name: Laminas\Config\Processor\Token
Implements: ProcessorInterface

Description

Methods

Name Description Defined By
__construct() Token Processor walks through a Config structure and replaces all occurrences of tokens with supplied values. Token
addToken() Add new token. Token
enableKeyProcessing() Enable processing keys as well as values. Token
getPrefix() Token
getSuffix() Token
getTokens() Get current token registry. Token
process() Process Token
processValue() Process a single value Token
setPrefix() Token
setSuffix() Token
setToken() Add new token. Token
setTokens() Set token registry. Token

Method Details

__construct()

Token Processor walks through a Config structure and replaces all occurrences of tokens with supplied values.

Parameter Name Type Description
$tokens array|\Config|\Traversable Associative
$prefix string
$suffix string
$enableKeyProcessing bool Whether

Returns:

addToken()

Add new token.

Parameter Name Type Description
$token string
$value mixed

Returns: self

enableKeyProcessing()

Enable processing keys as well as values.

Returns: void

getPrefix()

Returns: string

getSuffix()

Returns: string

getTokens()

Get current token registry.

Returns: array

process()

Process

Parameter Name Type Description
$config \Config

Returns: \Config

processValue()

Process a single value

Parameter Name Type Description
$value
$value

Returns: mixed

setPrefix()

Parameter Name Type Description
$prefix string

Returns: self

setSuffix()

Parameter Name Type Description
$suffix string

Returns: self

setToken()

Add new token.

Parameter Name Type Description
$token string
$value mixed

Returns: self

setTokens()

Set token registry.

Parameter Name Type Description
$tokens array|\Config|\Traversable Associative

Returns: self

Top