Skip to content

Commit 70bc3bc

Browse files
dgdg
committed
wip
1 parent 9774149 commit 70bc3bc

5 files changed

+206
-379
lines changed

‎latte/en/creating-extension.texy

-193
Original file line numberDiff line numberDiff line change
@@ -8,199 +8,6 @@ We create extensions when we want to reuse our Latte customizations in different
88
It is also useful to create an extension for each web project that will contain all the specific tags and filters you want to use in the project templates.
99

1010

11-
Extension Class
12-
===============
13-
14-
Extension is a class inheriting from [api:Latte\Extension]. It is registered with Latte using `addExtension()` (or via [configuration file |application:configuration#Latte]):
15-
16-
```php
17-
$latte = new Latte\Engine;
18-
$latte->addExtension(new MyLatteExtension);
19-
```
20-
21-
If you register multiple extensions and they define identically named tags, filters, or functions, the last added extension wins. This also implies that your extensions can override native tags/filters/functions.
22-
23-
Whenever you make a change to a class and auto-refresh is not turned off, Latte will automatically recompile your templates.
24-
25-
A class can implement any of the following methods:
26-
27-
```php
28-
abstract class Extension
29-
{
30-
/**
31-
* Initializes before template is compiler.
32-
*/
33-
public function beforeCompile(Engine $engine): void;
34-
35-
/**
36-
* Returns a list of parsers for Latte tags.
37-
* @return array<string, callable>
38-
*/
39-
public function getTags(): array;
40-
41-
/**
42-
* Returns a list of compiler passes.
43-
* @return array<string, callable>
44-
*/
45-
public function getPasses(): array;
46-
47-
/**
48-
* Returns a list of |filters.
49-
* @return array<string, callable>
50-
*/
51-
public function getFilters(): array;
52-
53-
/**
54-
* Returns a list of functions used in templates.
55-
* @return array<string, callable>
56-
*/
57-
public function getFunctions(): array;
58-
59-
/**
60-
* Returns a list of providers.
61-
* @return array<mixed>
62-
*/
63-
public function getProviders(): array;
64-
65-
/**
66-
* Returns a value to distinguish multiple versions of the template.
67-
*/
68-
public function getCacheKey(Engine $engine): mixed;
69-
70-
/**
71-
* Initializes before template is rendered.
72-
*/
73-
public function beforeRender(Template $template): void;
74-
}
75-
```
76-
77-
For an idea of what the extension looks like, take a look at the built-in "CoreExtension":https://github.com/nette/latte/blob/master/src/Latte/Essential/CoreExtension.php.
78-
79-
80-
beforeCompile(Latte\Engine $engine): void .[method]
81-
---------------------------------------------------
82-
83-
Called before the template is compiled. The method can be used for compilation-related initializations, for example.
84-
85-
86-
getTags(): array .[method]
87-
--------------------------
88-
89-
Called when the template is compiled. Returns an associative array *tag name => callable*, which are [tag parsing functions|#Tag Parsing Function].
90-
91-
```php
92-
public function getTags(): array
93-
{
94-
return [
95-
'foo' => [FooNode::class, 'create'],
96-
'bar' => [BarNode::class, 'create'],
97-
'n:baz' => [NBazNode::class, 'create'],
98-
// ...
99-
];
100-
}
101-
```
102-
103-
The `n:baz` tag represents a pure n:attribute, i.e. it is a tag that can only be written as an attribute.
104-
105-
In the case of the `foo` and `bar` tags, Latte will automatically recognize whether they are pairs, and if so, they can be written automatically using n:attributes, including variants with the `n:inner-foo` and `n:tag-foo` prefixes.
106-
107-
The order of execution of such n:attributes is determined by their order in the array returned by `getTags()`. Thus, `n:foo` is always executed before `n:bar`, even if the attributes are listed in reverse order in the HTML tag as `<div n:bar="..." n:foo="...">`.
108-
109-
If you need to determine the order of n:attributes across multiple extensions, use the `order()` helper method, where the `before` xor `after` parameter determines which tags are ordered before or after the tag.
110-
111-
```php
112-
public function getTags(): array
113-
{
114-
return [
115-
'foo' => self::order([FooNode::class, 'create'], before: 'bar')]
116-
'bar' => self::order([BarNode::class, 'create'], after: ['block', 'snippet'])]
117-
];
118-
}
119-
```
120-
121-
122-
getPasses(): array .[method]
123-
----------------------------
124-
125-
It is called when the template is compiled. Returns an associative array *name pass => callable*, which are functions representing so-called [#compiler passes] that traverse and modify the AST.
126-
127-
Again, the `order()` helper method can be used. The value of the `before` or `after` parameters can be `*` with the meaning before/after all.
128-
129-
```php
130-
public function getPasses(): array
131-
{
132-
return [
133-
'optimize' => [Passes::class, 'optimizePass'],
134-
'sandbox' => self::order([$this, 'sandboxPass'], before: '*'),
135-
// ...
136-
];
137-
}
138-
```
139-
140-
141-
beforeRender(Latte\Engine $engine): void .[method]
142-
--------------------------------------------------
143-
144-
It is called before each template rendering. The method can be used, for example, to initialize variables used during rendering.
145-
146-
147-
getFilters(): array .[method]
148-
-----------------------------
149-
150-
It is called before the template is rendered. Returns [filters|extending-latte#filters] as an associative array *filter name => callable*.
151-
152-
```php
153-
public function getFilters(): array
154-
{
155-
return [
156-
'batch' => [$this, 'batchFilter'],
157-
'trim' => [$this, 'trimFilter'],
158-
// ...
159-
];
160-
}
161-
```
162-
163-
164-
getFunctions(): array .[method]
165-
-------------------------------
166-
167-
It is called before the template is rendered. Returns [functions|extending-latte#functions] as an associative array *function name => callable*.
168-
169-
```php
170-
public function getFunctions(): array
171-
{
172-
return [
173-
'clamp' => [$this, 'clampFunction'],
174-
'divisibleBy' => [$this, 'divisibleByFunction'],
175-
// ...
176-
];
177-
}
178-
```
179-
180-
181-
getProviders(): array .[method]
182-
-------------------------------
183-
184-
It is called before the template is rendered. Returns an array of providers, which are usually objects that use tags at runtime. They are accessed via `$this->global->...`.
185-
186-
```php
187-
public function getProviders(): array
188-
{
189-
return [
190-
'myFoo' => $this->foo,
191-
'myBar' => $this->bar,
192-
// ...
193-
];
194-
}
195-
```
196-
197-
198-
getCacheKey(Latte\Engine $engine): mixed .[method]
199-
--------------------------------------------------
200-
201-
It is called before the template is rendered. The return value becomes part of the key whose hash is contained in the name of the compiled template file. Thus, for different return values, Latte will generate different cache files.
202-
203-
20411
How Does Latte Work?
20512
====================
20613

‎latte/en/develop.texy

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Latte is smart, and when there are multiple concurrent requests, only the first
6262
Parameters as a Class
6363
=====================
6464

65-
Better than passing variables to the template as arrays is to create a class. You get [type-safe notation|type-system], [nice suggestion in IDE|recipes#Editors and IDE] and a way to [register filters|extending-latte#Filters Using the Class] and [functions|extending-latte#Functions Using the Class].
65+
Better than passing variables to the template as arrays is to create a class. You get [type-safe notation|type-system], [nice suggestion in IDE|recipes#Editors and IDE] and a way to [register filters|custom-filters#Filters Using the Class] and [functions|custom-functions#Functions Using the Class].
6666

6767
```php
6868
class MailTemplateParameters

0 commit comments

Comments
 (0)