W3cubDocs

/CakePHP 3.4

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

Direct Users

Namespace: Cake\View
Location: View/StringTemplateTrait.php

Properties summary

Method Summary

Method Detail

formatTemplate()source 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()source public 

getTemplates( string|null $template null )

Gets templates to use or a specific template.

Parameters

string|null $template optional null
String for reading a specific template, null for all.

Returns

string|array

setTemplates()source public 

setTemplates( array $templates )

Sets templates to use.

Parameters

array $templates
Templates to be added.

Returns


$this

templater()source public 

templater( )

Returns the templater instance.

Returns

Cake\View\StringTemplate

templates()source public 

templates( string|null|array $templates null )

Gets/sets templates to use.

Deprecated

3.4.0 Use setTemplates()/getTemplates() instead.

Parameters

string|null|array $templates optional null

null or string allow reading templates. An array allows templates to be added.

Returns


$this|string|array

Properties detail

$_templatersource

protected Cake\View\StringTemplate

StringTemplate instance.

© 2005–2017 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/3.4/class-Cake.View.StringTemplateTrait.html