Parser
class Parser extends SSTemplateParser
Parser that scans through a template and extracts the parameters to the _t and <%t calls
Methods
No description
Override the function that constructs the result arrays to also prepare a 'php' item in the array
Set the closed blocks that the template parser should use
Set the open blocks that the template parser should use
Add a closed block callable to allow <% name %><% end_name %> syntax
Add a closed block callable to allow <% name %> syntax
Values are bare words in templates, but strings in PHP. We rely on PHP's type conversion to back-convert strings to numbers when needed.
The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj) depending on the context the lookup is used in.
No description
No description
No description
No description
No description
If we get a bare value, we don't know enough to determine exactly what php would be the translation, because we don't know if the position of use indicates a lookup or a string argument.
As mentioned in the parser comment, block handling is kept fairly generic for extensibility. The match rule builds up two important elements in the match result array: 'ArgumentCount' - how many arguments were passed in the opening tag 'Arguments' an array of the Argument match rule result arrays
This is an example of a block handler function. This one handles the loop tag.
This is an open block handler, for the <% debug %> utility tag
This is an open block handler, for the <% base_tag %> tag
This is an open block handler, for the <% current_page %> tag
The TopTemplate also includes the opening stanza to start off the template
Compiles some passed template source code into the php code that will execute as per the template source.
Compiles some file that contains template source code, and returns the php code that will execute as per that source
Parses a template and returns any translatable entities
No description
Details
at line 45
__construct(string $string, bool $warnIfEmpty = true)
in SSTemplateParser at line 99
construct($matchrule, $name, $arguments = null)
Override the function that constructs the result arrays to also prepare a 'php' item in the array
in SSTemplateParser at line 116
setClosedBlocks(array $closedBlocks)
Set the closed blocks that the template parser should use
This method will delete any existing closed blocks, please use addClosedBlock if you don't want to overwrite
in SSTemplateParser at line 132
setOpenBlocks(array $openBlocks)
Set the open blocks that the template parser should use
This method will delete any existing open blocks, please use addOpenBlock if you don't want to overwrite
in SSTemplateParser at line 146
addClosedBlock(string $name, callable $callable)
Add a closed block callable to allow <% name %><% end_name %> syntax
in SSTemplateParser at line 158
addOpenBlock(string $name, callable $callable)
Add a closed block callable to allow <% name %> syntax
in SSTemplateParser at line 194
match_Template($stack = array())
in SSTemplateParser at line 442
Template_STR($res, $sub)
in SSTemplateParser at line 449
match_Word($stack = array())
in SSTemplateParser at line 461
match_NamespacedWord($stack = array())
in SSTemplateParser at line 473
match_Number($stack = array())
in SSTemplateParser at line 485
match_Value($stack = array())
in SSTemplateParser at line 497
match_CallArguments($stack = array())
in SSTemplateParser at line 550
CallArguments_Argument($res, $sub)
Values are bare words in templates, but strings in PHP. We rely on PHP's type conversion to back-convert strings to numbers when needed.
in SSTemplateParser at line 562
match_Call($stack = array())
in SSTemplateParser at line 620
match_LookupStep($stack = array())
in SSTemplateParser at line 653
match_LastLookupStep($stack = array())
in SSTemplateParser at line 667
match_Lookup($stack = array())
in SSTemplateParser at line 743
Lookup__construct($res)
in SSTemplateParser at line 754
Lookup_AddLookupStep($res, $sub, $method)
The basic generated PHP of LookupStep and LastLookupStep is the same, except that LookupStep calls 'obj' to get the next ViewableData in the sequence, and LastLookupStep calls different methods (XML_val, hasValue, obj) depending on the context the lookup is used in.
in SSTemplateParser at line 767
Lookup_LookupStep($res, $sub)
in SSTemplateParser at line 772
Lookup_LastLookupStep($res, $sub)
in SSTemplateParser at line 781
match_Translate($stack = array())
in SSTemplateParser at line 894
match_InjectionVariables($stack = array())
in SSTemplateParser at line 939
match_Entity($stack = array())
at line 55
Translate__construct($res)
at line 61
Translate_Entity($res, $sub)
at line 67
Translate_Default($res, $sub)
at line 72
Translate_Context($res, $sub)
in SSTemplateParser at line 971
Translate_InjectionVariables($res, $sub)
at line 77
Translate__finalise($res)
in SSTemplateParser at line 981
InjectionVariables__construct($res)
in SSTemplateParser at line 986
InjectionVariables_InjectionName($res, $sub)
in SSTemplateParser at line 991
InjectionVariables_Argument($res, $sub)
in SSTemplateParser at line 996
InjectionVariables__finalise($res)
in SSTemplateParser at line 1007
match_SimpleInjection($stack = array())
in SSTemplateParser at line 1032
match_BracketInjection($stack = array())
in SSTemplateParser at line 1059
match_Injection($stack = array())
in SSTemplateParser at line 1090
Injection_STR($res, $sub)
in SSTemplateParser at line 1097
match_DollarMarkedLookup($stack = array())
in SSTemplateParser at line 1110
DollarMarkedLookup_STR($res, $sub)
in SSTemplateParser at line 1117
match_QuotedString($stack = array())
in SSTemplateParser at line 1153
match_FreeString($stack = array())
in SSTemplateParser at line 1169
match_Argument($stack = array())
in SSTemplateParser at line 1280
Argument_DollarMarkedLookup($res, $sub)
If we get a bare value, we don't know enough to determine exactly what php would be the translation, because we don't know if the position of use indicates a lookup or a string argument.
Instead, we record 'ArgumentMode' as a member of this matches results node, which can be: - lookup if this argument was unambiguously a lookup (marked as such) - string is this argument was unambiguously a string (marked as such, or impossible to parse as lookup) - default if this argument needs to be handled as per 2.4
In the case of 'default', there is no php member of the results node, but instead 'lookup_php', which should be used by the parent if the context indicates a lookup, and 'string_php' which should be used if the context indicates a string
in SSTemplateParser at line 1286
Argument_QuotedString($res, $sub)
in SSTemplateParser at line 1292
Argument_Lookup($res, $sub)
in SSTemplateParser at line 1304
Argument_FreeString($res, $sub)
in SSTemplateParser at line 1312
match_ComparisonOperator($stack = array())
in SSTemplateParser at line 1423
match_Comparison($stack = array())
in SSTemplateParser at line 1456
Comparison_Argument($res, $sub)
in SSTemplateParser at line 1469
Comparison_ComparisonOperator($res, $sub)
in SSTemplateParser at line 1476
match_PresenceCheck($stack = array())
in SSTemplateParser at line 1519
PresenceCheck_Not($res, $sub)
in SSTemplateParser at line 1524
PresenceCheck_Argument($res, $sub)
in SSTemplateParser at line 1538
match_IfArgumentPortion($stack = array())
in SSTemplateParser at line 1569
IfArgumentPortion_STR($res, $sub)
in SSTemplateParser at line 1576
match_BooleanOperator($stack = array())
in SSTemplateParser at line 1604
match_IfArgument($stack = array())
in SSTemplateParser at line 1653
IfArgument_IfArgumentPortion($res, $sub)
in SSTemplateParser at line 1658
IfArgument_BooleanOperator($res, $sub)
in SSTemplateParser at line 1665
match_IfPart($stack = array())
in SSTemplateParser at line 1708
match_ElseIfPart($stack = array())
in SSTemplateParser at line 1751
match_ElsePart($stack = array())
in SSTemplateParser at line 1786
match_If($stack = array())
in SSTemplateParser at line 1842
If_IfPart($res, $sub)
in SSTemplateParser at line 1850
If_ElseIfPart($res, $sub)
in SSTemplateParser at line 1858
If_ElsePart($res, $sub)
in SSTemplateParser at line 1868
match_Require($stack = array())
in SSTemplateParser at line 1929
Require_Call($res, $sub)
in SSTemplateParser at line 1944
match_CacheBlockArgument($stack = array())
in SSTemplateParser at line 2041
CacheBlockArgument_DollarMarkedLookup($res, $sub)
in SSTemplateParser at line 2046
CacheBlockArgument_QuotedString($res, $sub)
in SSTemplateParser at line 2051
CacheBlockArgument_Lookup($res, $sub)
in SSTemplateParser at line 2058
match_CacheBlockArguments($stack = array())
in SSTemplateParser at line 2106
CacheBlockArguments_CacheBlockArgument($res, $sub)
in SSTemplateParser at line 2120
match_CacheBlockTemplate($stack = array())
in SSTemplateParser at line 2338
match_UncachedBlock($stack = array())
in SSTemplateParser at line 2491
UncachedBlock_Template($res, $sub)
in SSTemplateParser at line 2499
match_CacheRestrictedTemplate($stack = array())
in SSTemplateParser at line 2747
CacheRestrictedTemplate_CacheBlock($res, $sub)
in SSTemplateParser at line 2753
CacheRestrictedTemplate_UncachedBlock($res, $sub)
in SSTemplateParser at line 2765
match_CacheBlock($stack = array())
in SSTemplateParser at line 3001
CacheBlock__construct($res)
in SSTemplateParser at line 3006
CacheBlock_CacheBlockArguments($res, $sub)
in SSTemplateParser at line 3011
CacheBlock_Condition($res, $sub)
in SSTemplateParser at line 3016
CacheBlock_CacheBlock($res, $sub)
in SSTemplateParser at line 3021
CacheBlock_UncachedBlock($res, $sub)
in SSTemplateParser at line 3026
CacheBlock_CacheBlockTemplate($res, $sub)
in SSTemplateParser at line 3063
match_OldTPart($stack = array())
in SSTemplateParser at line 3173
match_N($stack = array())
in SSTemplateParser at line 3184
OldTPart__construct($res)
in SSTemplateParser at line 3189
OldTPart_QuotedString($res, $sub)
in SSTemplateParser at line 3199
OldTPart_CallArguments($res, $sub)
in SSTemplateParser at line 3204
OldTPart__finalise($res)
in SSTemplateParser at line 3211
match_OldTTag($stack = array())
in SSTemplateParser at line 3236
OldTTag_OldTPart($res, $sub)
in SSTemplateParser at line 3243
match_OldSprintfTag($stack = array())
in SSTemplateParser at line 3296
OldSprintfTag__construct($res)
in SSTemplateParser at line 3301
OldSprintfTag_OldTPart($res, $sub)
in SSTemplateParser at line 3306
OldSprintfTag_CallArguments($res, $sub)
in SSTemplateParser at line 3313
match_OldI18NTag($stack = array())
in SSTemplateParser at line 3344
OldI18NTag_STR($res, $sub)
in SSTemplateParser at line 3351
match_NamedArgument($stack = array())
in SSTemplateParser at line 3381
NamedArgument_Name($res, $sub)
in SSTemplateParser at line 3386
NamedArgument_Value($res, $sub)
in SSTemplateParser at line 3405
match_Include($stack = array())
in SSTemplateParser at line 3482
Include__construct($res)
in SSTemplateParser at line 3487
Include_Template($res, $sub)
in SSTemplateParser at line 3492
Include_NamedArgument($res, $sub)
in SSTemplateParser at line 3497
Include__finalise($res)
in SSTemplateParser at line 3516
match_BlockArguments($stack = array())
in SSTemplateParser at line 3565
match_NotBlockTag($stack = array())
in SSTemplateParser at line 3720
match_ClosedBlock($stack = array())
in SSTemplateParser at line 3828
ClosedBlock__construct($res)
As mentioned in the parser comment, block handling is kept fairly generic for extensibility. The match rule builds up two important elements in the match result array: 'ArgumentCount' - how many arguments were passed in the opening tag 'Arguments' an array of the Argument match rule result arrays
Once a block has successfully been matched against, it will then look for the actual handler, which should be on this class (either defined or extended on) as ClosedBlock_Handler_Name(&$res), where Name is the tag name, first letter captialized (i.e Control, Loop, With, etc).
This function will be called with the match rule result array as it's first argument. It should return the php result of this block as it's return value, or throw an error if incorrect arguments were passed.
in SSTemplateParser at line 3833
ClosedBlock_BlockArguments($res, $sub)
in SSTemplateParser at line 3844
ClosedBlock__finalise($res)
in SSTemplateParser at line 3862
ClosedBlock_Handle_Loop($res)
This is an example of a block handler function. This one handles the loop tag.
in SSTemplateParser at line 3893
ClosedBlock_Handle_With($res)
The closed block handler for with blocks
in SSTemplateParser at line 3914
match_OpenBlock($stack = array())
in SSTemplateParser at line 3976
OpenBlock__construct($res)
in SSTemplateParser at line 3981
OpenBlock_BlockArguments($res, $sub)
in SSTemplateParser at line 3992
OpenBlock__finalise($res)
in SSTemplateParser at line 4010
OpenBlock_Handle_Debug($res)
This is an open block handler, for the <% debug %> utility tag
in SSTemplateParser at line 4031
OpenBlock_Handle_Base_tag($res)
This is an open block handler, for the <% base_tag %> tag
in SSTemplateParser at line 4042
OpenBlock_Handle_Current_page($res)
This is an open block handler, for the <% current_page %> tag
in SSTemplateParser at line 4052
match_MismatchedEndBlock($stack = array())
in SSTemplateParser at line 4079
MismatchedEndBlock__finalise($res)
in SSTemplateParser at line 4088
match_MalformedOpenTag($stack = array())
in SSTemplateParser at line 4166
MalformedOpenTag__finalise($res)
in SSTemplateParser at line 4174
match_MalformedCloseTag($stack = array())
in SSTemplateParser at line 4231
MalformedCloseTag__finalise($res)
in SSTemplateParser at line 4240
match_MalformedBlock($stack = array())
in SSTemplateParser at line 4274
match_Comment($stack = array())
in SSTemplateParser at line 4325
Comment__construct($res)
in SSTemplateParser at line 4333
match_TopTemplate($stack = array())
in SSTemplateParser at line 4605
TopTemplate__construct($res)
The TopTemplate also includes the opening stanza to start off the template
in SSTemplateParser at line 4619
match_Text($stack = array())
in SSTemplateParser at line 4826
Text__finalise($res)
We convert text
in SSTemplateParser at line 4865
string
compileString(string $string, string $templateName = "", bool $includeDebuggingComments = false, bool $topTemplate = true)
Compiles some passed template source code into the php code that will execute as per the template source.
in SSTemplateParser at line 4944
mixed|string
compileFile($template)
Compiles some file that contains template source code, and returns the php code that will execute as per that source
at line 110
static array
getTranslatables(string $template, bool $warnIfEmpty = true)
Parses a template and returns any translatable entities