Summary

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

Description

Methods

Name	Description	Defined By
__construct()	Constant Processor walks through a Config structure and replaces all PHP constants with their respective values	Constant
addToken()	Add new token.	Token
enableKeyProcessing()	Enable processing keys as well as values.	Token
getPrefix()		Token
getSuffix()		Token
getTokens()	Get current token registry.	Constant
getUserOnly()		Constant
loadConstants()	Load all currently defined constants into parser.	Constant
process()	Process	Token
processValue()	Process a single value	Token
setPrefix()		Token
setSuffix()		Token
setToken()	Add new token.	Token
setTokens()	Set token registry.	Token
setUserOnly()	Should we use only user-defined constants?	Constant

Method Details

__construct()

Constant Processor walks through a Config structure and replaces all PHP constants with their respective values

Parameter Name	Type	Description
$userOnly	bool	True
$prefix	string	Optional
$suffix	string	Optional
$enableKeyProcessing	bool	Whether

Returns: \Laminas\Config\Processor\Constant

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

getUserOnly()

Returns: bool

loadConstants()

Load all currently defined constants into parser.

Returns: void

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

setUserOnly()

Should we use only user-defined constants?

Parameter Name	Type	Description
$userOnly	bool

Returns: self