Package Template

This class represents a PHPBoost template. Templates are used to generate text which have a common structure. You just have to write your text with tags at the place you want to insert values and assign values in the objet, when you will display them, the tags will be replaced by the corresponding value.

This class is a default implementation of the Template interface using a TemplateLoader, a TemplateData and a TemplateParser.

This class allows you to handle a template file.

This class enables you to handle a template whose input is not a file but directly a string.

This interfaces represents a class that is able to parse a template source and transform it to a syntax that the PHP engine is able to run.

This is an abstract implementation of the {@link TemplateParser} interface.

template = (variableExpression | expression | condition | loop | include | text)* variableExpression = "{", variable, "}" expression = "${", expressionContent, "}" condition = "# IF ", "NOT "?, expression, "#", template, ("# ELSE #, template)?, "# ENDIF #" loop = "# START ", expression, " #", template, "# END (?:name)? #" include = "# INCLUDE ", name, " #" text = .+ expressionContent = array | function | variable | constant function = "\(\w+::\)?\w+\(", parameters, "\)" parameters = expressionContent | (expressionContent, (",", expressionContent)+) variable = simpleVar | loopVar constant = "'.+'" | [0-9]+ | array array = "array(", arrayContent, ")" arrayContent = arrayElement | (arrayElement, (",", arrayElement)+) arrayElement = expressionContent | ("'\w+'\s*=>\s*", expressionContent) simpleVar = "\w+" loopVar = "(\w+\.)+\w+"

Represents a template renderer as its names shows. Its able to get the result of the template interpration from a TemplateLoader which gives it the template source and a TemplateData which contains the data to assign in the template.

This template renderer is able to deal with both loader which cache and don't cache.

This class is responsible to load a template and transform it in the PHPBoost parsed template syntax.

This loader is to use when you load a template whose source is directly a PHP string and not a file. It supports caching and saves cache files in the /cache/tpl directory, using a md5 hash to distinguish eache string input.

This loader is the most used. It takes a file identifier as input. This identifier corresponds to a file that can be different from the user's theme. In fact, when it loads a template, its looks for it at several places. For a module template, it can be the default one which is in the /module/templates directory, but if the file is specialized by the theme, it loads it from the theme directory. All that is explained in the {@link FileTemplate} class description.

This exception is thrown when the template cannot been loaded.

This loader is a very simple one. Its input is a string containing the template source.

This exception is thrown when the template cannot been loaded.

This interface describes data which are assigned to a template. There are two types of data: <ul> <li>Variables: there are string that are directly displayed</li> <li>Templates: you can embed a template in another one. When a subtemplate is displayed, it's parsed using its own data and the result is inserted where the subtemplate is embedded.</li> </ul> A template contains global variables which are available in the whole template and local variable which are only defined into a loop. To define a loop, you just have to use assign_block_vars with the same loop identifier for each loop iteration. Loops can be nested and embed both variables and subtemplates.

This class is a default implementation of the {@link TemplateData} interface.