Trait StringTemplateTrait

Adds string template functionality to any class by providing methods to load and parse string templates.

This trait requires the implementing class to provide a config() method for reading/updating templates. An implementation of this method is provided by Cake\Core\InstanceConfigTrait

Namespace: Cake\View

Properties summary

  • $_templater protected
    \Cake\View\StringTemplate

    StringTemplate instance.

Method Summary

Method Detail

formatTemplate() public 

formatTemplate(string $name, array $data)

Formats a template string with $data

Parameters

string $name

The template name.

array $data

The data to insert.

Returns

string

getTemplates() public 

getTemplates(?string $template)

Gets templates to use or a specific template.

Parameters

string|null $template optional

String for reading a specific template, null for all.

Returns

string|array

setTemplates() public 

setTemplates(array $templates)

Sets templates to use.

Parameters

string[] $templates

Templates to be added.

Returns

$this

templater() public 

templater()

Returns the templater instance.

Returns

\Cake\View\StringTemplate

Property Detail

$_templater protected

StringTemplate instance.

Type

\Cake\View\StringTemplate

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.0/trait-Cake.View.StringTemplateTrait.html