\CodeIgniter\ViewParser

__construct()

__construct(\Config\View  $config, string  $viewPath = null, mixed  $loader = null, boolean  $debug = null, \CodeIgniter\Log\Logger  $logger = null) 

Constructor

Parameters

render()

render(string  $view, array  $options = null, boolean  $saveData = null) : string

Parse a template

Parses pseudo-variables contained in the specified template view, replacing them with any data that has already been set.

Parameters

Returns

renderString()

renderString(string  $template, array  $options = null, boolean  $saveData = null) : string

Parse a String

Parses pseudo-variables contained in the specified string, replacing them with any data that has already been set.

Parameters

Returns

setData()

setData(array  $data = array(), string  $context = null) : \CodeIgniter\View\RendererInterface

Sets several pieces of view data at once.

In the Parser, we need to store the context here so that the variable is correctly handled within the parsing itself, and contexts (including raw) are respected.

Parameters

Returns

insertNoparse()

insertNoparse(string  $template) : string

Re-inserts the noparsed contents back into the template.

Parameters

Returns

setDelimiters()

setDelimiters(string  $leftDelimiter = '{', string  $rightDelimiter = '}') : \CodeIgniter\View\RendererInterface

Over-ride the substitution field delimiters.

Parameters

Returns

shouldAddEscaping()

shouldAddEscaping(string  $key) : false|string

Checks the placeholder the view provided to see if we need to provide any autoescaping.

Parameters

Returns

addPlugin()

addPlugin(string  $alias, callable  $callback, boolean  $isPair = false) : $this

Makes a new plugin available during the parsing of the template.

Parameters

Returns

removePlugin()

removePlugin(string  $alias) : $this

Removes a plugin from the available plugins.

Parameters

Returns

parse()

parse(string  $template, array  $data = array(), array  $options = null) : string

Parse a template

Parses pseudo-variables contained in the specified template, replacing them with the data in the second param

Parameters

Returns

parseSingle()

parseSingle(string  $key, string  $val) : array

Parse a single key/value, extracting it

Parameters

Returns

parsePair()

parsePair(string  $variable, array  $data, string  $template) : array

Parse a tag pair

Parses tag pairs: {some_tag} string... {/some_tag}

Parameters

Returns

parseComments()

parseComments(string  $template) : string

Removes any comments from the file. Comments are wrapped in {# #} symbols:

{# This is a comment #}

Parameters

Returns

extractNoparse()

extractNoparse(string  $template) : string

Extracts noparse blocks, inserting a hash in its place so that those blocks of the page are not touched by parsing.

Parameters

Returns

parseConditionals()

parseConditionals(string  $template) : string

Parses any conditionals in the code, removing blocks that don't pass so we don't try to parse it later.

Valid conditionals:

• if
• elseif
• else

Parameters

Returns

replaceSingle()

replaceSingle(  $pattern,   $content,   $template, boolean  $escape = false) : string

Handles replacing a pseudo-variable with the actual content. Will double-check for escaping brackets.

Parameters

Returns

prepareReplacement()

prepareReplacement(array  $matches, string  $replace, boolean  $escape = true) : string

Callback used during parse() to apply any filters to the value.

Parameters

Returns

applyFilters()

applyFilters(string  $replace, array  $filters) : string

Given a set of filters, will apply each of the filters in turn to $replace, and return the modified string.

Parameters

Returns

parsePlugins()

parsePlugins(string  $template) : string

Scans the template for any parser plugins, and attempts to execute them.

Plugins are notated based on {+ +} opening and closing braces.

When encountered,

Parameters

Returns

objectToArray()

objectToArray(  $value) : mixed

Converts an object to an array, respecting any toArray() methods on an object.

Parameters

Returns