IncludeBlock::createPlaceholder() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - spiral/components - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3b9aa0...812432 )

by Anton

created 2017-01-28 00:04 UTC

IncludeBlock::createPlaceholder() A

↳ Parent: IncludeBlock

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	2
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\Stempler\Behaviours;

use Spiral\Stempler\BehaviourInterface;
use Spiral\Stempler\HtmlTokenizer;
use Spiral\Stempler\Node;
use Spiral\Stempler\Supervisor;

/**
 * Replaces specified block (including tag) with external node, automatically uses inner tag
 * content as "context" block and all other tag attributes as additional node child.
 */
class IncludeBlock implements BehaviourInterface
{
    /**
     * Name of block used to represent import context.
     */
    const CONTEXT_BLOCK = 'context';

    /**
     * Path to be included (see Supervisor createNode).
     *
     * @var string
     */
    protected $path = '';

    /**
     * Import context includes everything between opening and closing tag.
     *
     * @var array
     */
    protected $context = [];

    /**
     * Context token.
     *
     * @var array
     */
    protected $token = [];

    /**
     * @var Supervisor
     */
    protected $supervisor = null;

    /**
     * @param Supervisor $supervisor
     * @param string     $path
     * @param array      $context
     * @param array      $token
     */
    public function __construct(
        Supervisor $supervisor,
        string $path,
        array $context,
        array $token = []
    ) {
        $this->supervisor = $supervisor;
        $this->path = $path;

        $this->context = $context;
        $this->token = $token;
    }

    /**
     * Create node to be injected into template at place of tag caused import.
     *
     * @return Node
     */
    public function createNode(): Node
    {
        //Content of node to be imported
        $node = $this->supervisor->createNode($this->path, $this->token);

        //Let's register user defined blocks (context and attributes) as placeholders
        $node->mountBlock(
            self::CONTEXT_BLOCK,
            [],
            [$this->createPlaceholder(self::CONTEXT_BLOCK, $contextID)],
            true
        );

        foreach ($this->token[HtmlTokenizer::TOKEN_ATTRIBUTES] as $attribute => $value) {
            //Attributes counted as blocks to replace elements in included node
            $node->mountBlock($attribute, [], [$value], true);
        }

        //We now have to compile node content to pass it's body to parent node
        $content = $node->compile($dynamic);

        //Outer blocks (usually user attributes) can be exported to template using non default
        //rendering technique, for example every "extra" attribute can be passed to specific
        //template location. Stempler to decide.
        foreach ($this->supervisor->getSyntax()->blockExporters() as $exporter) {
            $content = $exporter->mountBlocks($content, $dynamic);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        //Let's parse complied content without any imports (to prevent collision)
        $supervisor = clone $this->supervisor;
        $supervisor->flushImporters();

        //Outer content must be protected using unique names
        $rebuilt = new Node($supervisor, $supervisor->uniquePlaceholder(), $content);

        if (!empty($contextBlock = $rebuilt->findNode($contextID))) {
            //Now we can mount our content block
            $contextBlock->mountNode($this->contextNode());
        }

        return $rebuilt;
    }

    /**
     * Pack node context (everything between open and close tag).
     *
     * @return Node
     */
    protected function contextNode(): Node
    {
        $context = '';
        foreach ($this->context as $token) {
            $context .= $token[HtmlTokenizer::TOKEN_CONTENT];
        }

        return new Node($this->supervisor, $this->supervisor->uniquePlaceholder(), $context);
    }

    /**
     * Create placeholder block (to be injected with inner blocks defined in context).
     *
     * @param string      $name
     * @param string|null $blockID
     *
     * @return string
     */
    protected function createPlaceholder(string $name, string &$blockID = null): string
    {
        $blockID = $name . '-' . $this->supervisor->uniquePlaceholder();

        //Short block declaration syntax
        return '${' . $blockID . '}';
    }
}

1			<?php
2			/**
3			* Spiral Framework.
4			*
5			* @license MIT
6			* @author Anton Titov (Wolfy-J)
7			*/
8
9			namespace Spiral\Stempler\Behaviours;
10
11			use Spiral\Stempler\BehaviourInterface;
12			use Spiral\Stempler\HtmlTokenizer;
13			use Spiral\Stempler\Node;
14			use Spiral\Stempler\Supervisor;
15
16			/**
17			* Replaces specified block (including tag) with external node, automatically uses inner tag
18			* content as "context" block and all other tag attributes as additional node child.
19			*/
20			class IncludeBlock implements BehaviourInterface
21			{
22			/**
23			* Name of block used to represent import context.
24			*/
25			const CONTEXT_BLOCK = 'context';
26
27			/**
28			* Path to be included (see Supervisor createNode).
29			*
30			* @var string
31			*/
32			protected $path = '';
33
34			/**
35			* Import context includes everything between opening and closing tag.
36			*
37			* @var array
38			*/
39			protected $context = [];
40
41			/**
42			* Context token.
43			*
44			* @var array
45			*/
46			protected $token = [];
47
48			/**
49			* @var Supervisor
50			*/
51			protected $supervisor = null;
52
53			/**
54			* @param Supervisor $supervisor
55			* @param string $path
56			* @param array $context
57			* @param array $token
58			*/
59			public function __construct(
60			Supervisor $supervisor,
61			string $path,
62			array $context,
63			array $token = []
64			) {
65			$this->supervisor = $supervisor;
66			$this->path = $path;
67
68			$this->context = $context;
69			$this->token = $token;
70			}
71
72			/**
73			* Create node to be injected into template at place of tag caused import.
74			*
75			* @return Node
76			*/
77			public function createNode(): Node
78			{
79			//Content of node to be imported
80			$node = $this->supervisor->createNode($this->path, $this->token);
81
82			//Let's register user defined blocks (context and attributes) as placeholders
83			$node->mountBlock(
84			self::CONTEXT_BLOCK,
85			[],
86			[$this->createPlaceholder(self::CONTEXT_BLOCK, $contextID)],
87			true
88			);
89
90			foreach ($this->token[HtmlTokenizer::TOKEN_ATTRIBUTES] as $attribute => $value) {
91			//Attributes counted as blocks to replace elements in included node
92			$node->mountBlock($attribute, [], [$value], true);
93			}
94
95			//We now have to compile node content to pass it's body to parent node
96			$content = $node->compile($dynamic);
97
98			//Outer blocks (usually user attributes) can be exported to template using non default
99			//rendering technique, for example every "extra" attribute can be passed to specific
100			//template location. Stempler to decide.
101			foreach ($this->supervisor->getSyntax()->blockExporters() as $exporter) {
102			$content = $exporter->mountBlocks($content, $dynamic);
			1 ignored issue – show Bug introduced 2017-01-28 00:07 UTC by Report Bug Copy Issue Report It seems like `$dynamic` can also be of type `null`; however, `Spiral\Stempler\ExporterInterface::mountBlocks()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
103			}
104
105			//Let's parse complied content without any imports (to prevent collision)
106			$supervisor = clone $this->supervisor;
107			$supervisor->flushImporters();
108
109			//Outer content must be protected using unique names
110			$rebuilt = new Node($supervisor, $supervisor->uniquePlaceholder(), $content);
111
112			if (!empty($contextBlock = $rebuilt->findNode($contextID))) {
113			//Now we can mount our content block
114			$contextBlock->mountNode($this->contextNode());
115			}
116
117			return $rebuilt;
118			}
119
120			/**
121			* Pack node context (everything between open and close tag).
122			*
123			* @return Node
124			*/
125			protected function contextNode(): Node
126			{
127			$context = '';
128			foreach ($this->context as $token) {
129			$context .= $token[HtmlTokenizer::TOKEN_CONTENT];
130			}
131
132			return new Node($this->supervisor, $this->supervisor->uniquePlaceholder(), $context);
133			}
134
135			/**
136			* Create placeholder block (to be injected with inner blocks defined in context).
137			*
138			* @param string $name
139			* @param string\|null $blockID
140			*
141			* @return string
142			*/
143			protected function createPlaceholder(string $name, string &$blockID = null): string
144			{
145			$blockID = $name . '-' . $this->supervisor->uniquePlaceholder();
146
147			//Short block declaration syntax
148			return '${' . $blockID . '}';
149			}
150			}

spiral / components

Push — master ( 3b9aa0...812432 )

IncludeBlock::createPlaceholder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like