This repository has been archived on 2024-06-20. You can view files and clone it, but cannot push or open issues or pull requests.
peryoudow/vendor/league/plates/docs/templates/data.md
2020-01-06 14:23:12 +01:00

2.2 KiB

layout permalink title
default templates/data/ Data

Data

It's very common to share application data (variables) with a template. Data can be whatever you want: strings, arrays, objects, etc. Plates allows you set both template specific data as well as shared template data.

Assign data

Assigning data is done from within your application code, such as a controller. There are a number of ways to assign the data, depending on how you structure your objects.

// Create new Plates instance
$templates = new League\Plates\Engine('/path/to/templates');

// Assign via the engine's render method
echo $templates->render('profile', ['name' => 'Jonathan']);

// Assign via the engine's make method
$template = $templates->make('profile', ['name' => 'Jonathan']);

// Assign directly to a template object
$template = $templates->make('profile');
$template->data(['name' => 'Jonathan']);

Accessing data

Template data is available as locally scoped variables at the time of rendering. Continuing with the example above, here is how you would escape and output the "name" value in a template:

<p>Hello <?=$this->e($name)?></p>

Prior to Plates 3.0, variables were accessed using the $this pseudo-variable. This is no longer possible. Use the locally scoped variables instead.

Preassigned and shared data

If you have data that you want assigned to a specific template each time that template is rendered throughout your application, the addData() function can help organize that code in one place.

$templates->addData(['name' => 'Jonathan'], 'emails::welcome');

You can pressaign data to more than one template by passing an array of templates:

$templates->addData(['name' => 'Jonathan'], ['login', 'template']);

To assign data to ALL templates, simply omit the second parameter:

$templates->addData(['name' => 'Jonathan']);

Keep in mind that shared data is assigned to a template when it's first created, meaning any conflicting data assigned that's afterwards to a specific template will overwrite the shared data. This is generally desired behavior.