Add test to check if a block exists #1831

hason · 2015-09-15T21:58:44Z

stof · 2015-09-16T08:10:55Z

lib/Twig/Template.php

+     */
+    public function existsBlock($name, array $context, array $blocks = array(), $useBlocks = true)
+    {
+        $name = (string) $name;


should we really cast here ? IMO, we should expect a string here all the time. The casting could be done in the compiled code of the Twig_Node_Expression_Test_Block. It would avoid casting again when calling the method on the parent

fabpot · 2015-09-17T09:20:21Z

doc/tests/block.rst

@@ -0,0 +1,13 @@
+``block``
+========


missing =

stof · 2015-09-17T09:53:17Z

lib/Twig/Template.php

+    /**
+     * Returns whether a block exists or not in the current context of the template.
+     *
+     * This method does return blocks defined in the current template


it does not return blocks

fabpot · 2015-10-04T08:40:57Z

lib/Twig/Node/Expression/Test/Block.php

+    public function compile(Twig_Compiler $compiler)
+    {
+        $compiler
+            ->raw('$this->existsBlock((string) ')


string cast should be removed

xabbuh · 2015-10-04T16:51:07Z

Imho blockExists() reads more natural than existsBlock().

fabpot · 2015-10-12T07:22:59Z

doc/tests/block.rst

+
+.. code-block:: jinja
+
+    {% if 'title' is block %}


Now that I'm reading it in a template, using a test looks wrong to me: 'title' is a string, not a block.

I was thinking about using a function instead like has_block('title'):

{% if has_block('title') %} <title>{{ block('title') }}<title> {% endif %}

What do you think?

I prefer a test instead of a function. In #1821 I suggested {% if 'title' is block name %}, for example.

Additionally the has_block should check the existence of a block in the current template as same as Twig_Template::hasBlock and not the existence of a block in the context.

The trouble with is block is similar to is constant. More correct would be:

{% if post.status is same as(constant('Post::PUBLISHED')) %}

@hason Twig_Template::hasBlock does not take inheritance into account, which precisely defeats the use case for this test: if it does not take inheritance into account, there is no reason to do this check at runtime; the developer can know it when writing the template and one of the branches of your if will always be dead.

@stof Sure. I just don't like the confusing name of the function has_block, that gives the impression: "if the template has a block". That's why I prefer rather the test is block.

I prefer is block name rather than is block

hason · 2016-11-10T15:42:02Z

@fabpot What do you think?

fabpot · 2016-11-10T21:35:07Z

doc/tests/block_name.rst

+
+.. code-block:: jinja
+
+    {% if 'title' is block name %}


I still find this very weird to read and not easy to understand. I don't have any better proposal for now.

fabpot · 2016-11-11T17:12:08Z

Closes in favor of #2239

@hason

This PR was merged into the 1.x branch. Discussion ---------- Add "is defined" support for block() replaces #1831, fixes #1821 I think reusing the semantic of the `defined` test is more idiomatic and easily discoverable. /cc @hason Commits ------- 3ce06af added 'is defined' support for block() 4f013e0 Add test to check if a block exists

…ortable way (fabpot) This PR was merged into the 1.x branch. Discussion ---------- Expose a way to access template data and methods in a portable way `Twig_Template` is an internal class, and most of its methods are marked as being `@internal` as they are not "safe" to use by end users. But some of its features are interesting like `renderBlock()` which is very useful when rendering emails for instance (see #1873). This PR tries to address both issues by marking the whole `Twig_Template` class as being internal and by exposing a new way to safely interact with a template besides the obvious `render()`/`display()` methods via `$twig->load("...")`. If also add some convenient methods like `hasBlock()` or `getBlocks()` (see ~#1831~ and #1882): ```php $template = $twig->load('index'); echo $template->render($context); $template->display($context); if ($template->hasBlock('name') { $template->displayBlock('name', $context); } foreach ($template->getBlocks() as $block) { echo $template->render($block, $context); } ``` Commits ------- d7062f3 exposed a way to access template data and methods in a portable way

hason force-pushed the isblock branch 2 times, most recently from eec4ad2 to 780df1c Compare September 15, 2015 23:09

stof reviewed Sep 16, 2015
View reviewed changes

hason force-pushed the isblock branch 3 times, most recently from 3c0d17d to b811fd8 Compare September 16, 2015 11:11

hason changed the title ~~[WIP] Add test to check if a block exists~~ Add test to check if a block exists Sep 16, 2015

fabpot reviewed Sep 17, 2015
View reviewed changes

doc/tests/block.rst

@@ -0,0 +1,13 @@

``block``

========

Copy link

Contributor

fabpot Sep 17, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing =

hason force-pushed the isblock branch from b811fd8 to a95d89d Compare September 17, 2015 09:40

stof reviewed Sep 17, 2015
View reviewed changes

hason force-pushed the isblock branch from a95d89d to 54075af Compare September 17, 2015 10:41

fabpot reviewed Oct 4, 2015
View reviewed changes

hason force-pushed the isblock branch from 54075af to 94098d8 Compare October 4, 2015 15:05

hason force-pushed the isblock branch from 94098d8 to 0e784ff Compare October 4, 2015 18:35

fabpot force-pushed the 1.x branch from efaf503 to aa15967 Compare October 8, 2015 15:08

fabpot reviewed Oct 12, 2015
View reviewed changes

hason force-pushed the isblock branch 2 times, most recently from 036b91f to dae8d81 Compare October 23, 2015 21:45

hason force-pushed the isblock branch 2 times, most recently from 529c9a3 to 8afe7ed Compare December 30, 2015 10:20

hason force-pushed the isblock branch from 8afe7ed to 9768ac2 Compare November 10, 2016 15:16

Add test to check if a block exists

b630675

hason force-pushed the isblock branch from 9768ac2 to b630675 Compare November 10, 2016 15:19

fabpot reviewed Nov 10, 2016

View reviewed changes

This was referenced Nov 10, 2016

Expose a way to access template data and methods in a portable way #2236

Merged

Add "is defined" support for block() #2239

Merged

fabpot closed this Nov 11, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add test to check if a block exists #1831

Add test to check if a block exists #1831

hason commented Sep 15, 2015

stof Sep 16, 2015

fabpot Sep 17, 2015

stof Sep 17, 2015

fabpot Oct 4, 2015

xabbuh commented Oct 4, 2015

fabpot Oct 12, 2015

hason Oct 13, 2015

hason Oct 20, 2015

stof Oct 20, 2015

hason Oct 20, 2015

stof Oct 20, 2015

hason commented Nov 10, 2016

fabpot Nov 10, 2016

fabpot commented Nov 11, 2016

Add test to check if a block exists #1831

Add test to check if a block exists #1831

Conversation

hason commented Sep 15, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented Oct 4, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hason commented Nov 10, 2016

Choose a reason for hiding this comment

fabpot commented Nov 11, 2016