I'd like to break up a collection of Twig macros into individual files, then import them using a library file to collect all the import statements.
Currently all our macros are in one file, but I'd rather see something like this:
macro/hello.twig:
{% macro hello() %}
Hello
{% endmacro %}
macro/goodbye.twig:
{% macro goodbye() %}
Goodbye
{% endmacro %}
macro_lib.twig:
{% import "macro/hello.twig" as hello %}
{% import "macro/goodbye.twig" as goodbye %}
The base template should just import macro_lib.twig, but this doesn't work:
{% import "macro_lib.twig" as lib %}
{{ lib.hello.hello() }}
But trying to call the nested macro returns Fatal error: Call to undefined method __TwigTemplate_d7...30::gethello()
I also tried namespaced imports like {% from "macro/hello.twig" import hello as hello %} but those also failed.
Is it possible to nest imported macros like this?
I think you need define macro in macro_lib.twig as
{% macro lib() %}
{% import "macro/hello.twig" as hello %}
{% import "macro/goodbye.twig" as goodbye %}
{% endmacro %}
Then you will be able to call sub macros
{% import "macro_lib.twig" as lib %}
{{ lib.hello.hello() }}
Because the macro_lib.twig you have is just a container of sub macros and you need to define a macro inside to be able to use it
Related
I'm not able to access template variable in TWIG macro.
Here is a simplified example:
{% set myname = "Ligio" %}
{{ _self.pagedurl(1) }}
{% macro pagedurl(page) %}
Hi {{ _self.myname }}! This is Page Num {{ page }}
{% endmacro %}
How can I access the variable myname without passing it to the macro?
You can not.
As stated in the documentation:
As PHP functions, macros don't have access to the current template
variables.
Your only solution is to pass the parameter to the macro:
{% import _self as flow %}
{{ flow.pagedurl(1, "Ligio") }}
{% macro pagedurl(page, myname) %}
Hi {{ myname }}! This is Page Num {{ page }}
{% endmacro %}
IMPORTANT NOTE:
You may have noticed in my example, I call {% import _self as flow %}.
This is something you MUST do:
When you define a macro in the template where you are going to use it,
you might be tempted to call the macro directly via _self.input()
instead of importing it; even if seems to work, this is just a
side-effect of the current implementation and it won't work anymore in
Twig 2.x.
http://twig.sensiolabs.org/doc/tags/macro.html
If you need to pass more than one global variable into the macro, you might find the _context variable useful:
{% macro mymacro(globalvars) %}
Value of the global variable pi is {{ globalvars.pi }}
{% endmacro %}
{% set pi = 3.14159 %}
{{ _self.mymacro(_context) }}
Ref: this or this answer.
You can set a global variable and access it anywhere in the template
$loader = new \Twig_Loader_Filesystem('path/to/templates');
$twig = new \Twig_Environment($loader);
$twig->addGlobal('V_Name', 'V_Value');
Here is my current code:
{% for module in page.collection() %}
{% set index = loop.index %}
{{ module.content|raw }}
{% endfor %}
I'd like to access index inside the module.html.twig, or even better, the entire loop variable.
How do I do that?
I found it myself:
{% for module in page.collection() if not module.header.visible is same as(false) %}
{% include module.template ~ '.html.twig' with {'page':module, 'loop':loop} %}
{% endfor %}
This loop willautomatically grab the template which is linked to the modular page and pass the required variables down. Also, the loop will only include modular subpages which are not hidden. Great, isn't it?
I am passing something to a macro and performing some operations on it. I am storing the result in a variable. Now I want to access this variable outside the macro.
Is there a way we can do this?
Example:
{% macro setexpression() %}
{% set expression = "Hello World!" %}
{% endmacro %}
I call the macro and expression should be available outside.
{{ setexpression() }}
{{ expression }} // This should return Hello World!
I found a hacky way to do this.
{% macro returnSomething() %}
{% set returnVar = "Hello there" %}
{{returnVar}}
{% endmacro %}
And then, the calling code will be:
{% set returned = returnSomething() %}
{{returned}} // this will have 'Hello there' in it
Is there a better way in which I can achieve the same?
I want to reuse pretty heavy logic only code a few times, in php I would use a function, but in twig I went with a solution from this old question.
In short, I use a macro like that:
{% import _self as test %}
{% macro check() %}
{{ test }}
{% endmacro %}
{% set v = test.check() %}
{% if v == 'test' %}
this should display
{% endif %}
Here is a fiddle: https://twigfiddle.com/kyv3zr/2
The problem is that v is a Twig_markup object. It doesn't seem to have any public properties. Running dump on it gives me this:
object(Twig_Markup)#1244 (2) { ["content":protected]=> string(13) " 1 " ["charset":protected]=> string(5) "UTF-8" }
How do I use it in an if statement?
Or is there a better way of storing a logic only code for reuse across templates?
If the object is called v then the dump seems to show it has a content value, so try:
{% if v.content == '1' %}
{# do something here #}
{% endif %}
not certain though, but try it.
EDIT #2 - based on comments question.
So I guess if you want to use v in an if statement, you would use it like so:
{% if v == '1' %}
{# do something here #}
{% endif %}
This presumes it does equal to "1".
I want to replace part of string characters with asterisks in Twig.
For example:
SomePartlyVisibleStringHere
I want to change every letter after 4th in this string with asterisks, to have result like that:
Some*********************
Is it possible to do without defining new Twig helper?
You could make a macro (a function in Twig) and call it whenever you want to do this.
{% macro redact(topSecret) %}
{% set length = topSecret|length - 4 %}
{{ topSecret|slice(0, 3) }}{% for i in 0..length %}*{% endfor %}
{% endmacro %}
{# You have to import from _self if the macro is declared in the same file. #}
{% import _self as sharpie %}
{{ sharpie.redact('Top secret information') }}
{# => Top******************* #}
Example: https://twigfiddle.com/aobt8s
This worked for me:
{% set string = 'SomePartlyVisibleStringHere' %}
{% set starCount = string|length - 4 %}
{{ string[:4] }}{% for i in 1..starCount %}*{% endfor %}
If you have to do it more than once I would suggest making a custom filter, then you can just do:
{% set string = 'SomePartlyVisibleStringHere' %}
{{ string|customFilterName }}