Fuman
\

\Fuman_Template_Parser

This class is the default fuman template engine

Summary

Methods
Properties
Constants
__construct()
addStandardProcessors()
stripPlaceholders()
addValueProcessor()
getValueProcessor()
hasValueProcessor()
getValueProcessorNames()
parse()
extractValue()
invalidateCaches()
No public properties found
PLACEHOLDER_PATTERN
DO_NOT_PARSE
INNER_PATTERN
PLACEHOLDER_VALUE_PATTERN
EXTRACT_STRING_VALUE_PATTERN
TYPE_TEXT
TYPE_VALUE
TYPE_PROCESS
TYPE_PIPE
TYPE_INNER
KEY_TYPE
KEY_VALUE
KEY_PARAM
DEBUG_MODE
CONTAINER_NAME
_toString()
_partToString()
_parseDataByObject()
_parseTree()
_addInnerValues()
_addRefValue()
_getParsingTreeFromFile()
_buildParsingTree()
_cleanupModifiedObjects()
$_parsedFiles
$_cacheType
$_valueProcessors
$_parseLevels
$_modifiedObjects
$_processors
N/A
No private methods found
No private properties found
N/A

Constants

PLACEHOLDER_PATTERN

PLACEHOLDER_PATTERN

DO_NOT_PARSE

DO_NOT_PARSE

INNER_PATTERN

INNER_PATTERN

PLACEHOLDER_VALUE_PATTERN

PLACEHOLDER_VALUE_PATTERN

EXTRACT_STRING_VALUE_PATTERN

EXTRACT_STRING_VALUE_PATTERN

TYPE_TEXT

TYPE_TEXT

TYPE_VALUE

TYPE_VALUE

TYPE_PROCESS

TYPE_PROCESS

TYPE_PIPE

TYPE_PIPE

TYPE_INNER

TYPE_INNER

KEY_TYPE

KEY_TYPE

KEY_VALUE

KEY_VALUE

KEY_PARAM

KEY_PARAM

DEBUG_MODE

DEBUG_MODE

CONTAINER_NAME

CONTAINER_NAME

Session container for action descriptors

Properties

$_parsedFiles

$_parsedFiles : array|null

Type

array|null

$_cacheType

$_cacheType :

Type

$_valueProcessors

$_valueProcessors :

Type

$_parseLevels

$_parseLevels :

Type

$_modifiedObjects

$_modifiedObjects :

Type

$_processors

$_processors :

Type

Methods

__construct()

__construct()

Constructor

addStandardProcessors()

addStandardProcessors() : void

Initializes the parser Registers instance,global,translation,inlinetranslation,config,if,response processors by default Adds some processors

stripPlaceholders()

stripPlaceholders(string  $value) : string

Strips place holders ({.

..})

Parameters

string $value

Returns

string

addValueProcessor()

addValueProcessor(\Fuman_Template_Processor  $processor) : void

Adds a processor

Parameters

\Fuman_Template_Processor $processor

getValueProcessor()

getValueProcessor(string  $name) : \Fuman_Template_Processor

Gets processor for name

Parameters

string $name

Returns

\Fuman_Template_Processor

hasValueProcessor()

hasValueProcessor(string  $name) : boolean

Is a given processor registered

Parameters

string $name

Returns

boolean

getValueProcessorNames()

getValueProcessorNames() : array

Gets the registered processor names

Returns

array

parse()

parse(\stdClass|\Fuman_Response_Data  $data, null|string  $templateString = null) : string

Parse

Parameters

\stdClass|\Fuman_Response_Data $data
null|string $templateString

Throws

\Fuman_Exception

Returns

string

extractValue()

extractValue(string  $valuePath, mixed  $data,   $modifiedObjects = null) : null|object|array|string

Extracts value for given valuePath integer-values and single-quoted strings are treated as parameters that are not present in data-set

Parameters

string $valuePath
mixed $data
$modifiedObjects

Returns

null|object|array|string

invalidateCaches()

invalidateCaches()

Deletes internal caches if any

_toString()

_toString(  $parsingTree) : string

To string

Parameters

$parsingTree

Returns

string

_partToString()

_partToString(array  $parsingTreePart) : string

Part to string

Parameters

array $parsingTreePart

Returns

string

_parseDataByObject()

_parseDataByObject(array  $parsingTree, \Fuman_Template_Parser_State  $parserObject, mixed  $data, mixed|null  $parentData = null) : array|mixed|null

Parse data by object

Parameters

array $parsingTree
\Fuman_Template_Parser_State $parserObject
mixed $data
mixed|null $parentData

Returns

array|mixed|null

_parseTree()

_parseTree(array  $parsingTree, \Fuman_Template_Parser_State  $parserObject, mixed  $data, mixed|null  $parentData = null) : array|null

Parse tree

Parameters

array $parsingTree
\Fuman_Template_Parser_State $parserObject
mixed $data
mixed|null $parentData

Throws

\Fuman_Exception

Returns

array|null

_addInnerValues()

_addInnerValues(array  $resultTree, array  $innerValues,   $refValue)

Adds inner values

Parameters

array $resultTree
array $innerValues
$refValue

_addRefValue()

_addRefValue(array  $resultTree,   $refValue)

Adds reference value

Parameters

array $resultTree
$refValue

_getParsingTreeFromFile()

_getParsingTreeFromFile(\Fuman_Response_Data  $data) : mixed

Gets parsing tree from file

Parameters

\Fuman_Response_Data $data

Returns

mixed

_buildParsingTree()

_buildParsingTree(mixed  $data,   $parsedParts, string|null  $templateString = null)

Bild parsing tree

Parameters

mixed $data
$parsedParts
string|null $templateString

Throws

\Fuman_Exception

_cleanupModifiedObjects()

_cleanupModifiedObjects(  $modifiedObjects)

Resets all added References and values on the manipulated objects after that, empty the container

Parameters

$modifiedObjects