These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | /** |
||
3 | * Copyright (c) 2013-2016 |
||
4 | * |
||
5 | * @category Library |
||
6 | * @package Dwoo\Block |
||
7 | * @author Jordi Boggiano <[email protected]> |
||
8 | * @author David Sanchez <[email protected]> |
||
9 | * @copyright 2008-2013 Jordi Boggiano |
||
10 | * @copyright 2013-2016 David Sanchez |
||
11 | * @license http://dwoo.org/LICENSE Modified BSD License |
||
12 | * @version 1.3.0 |
||
13 | * @date 2016-09-23 |
||
14 | * @link http://dwoo.org/ |
||
15 | */ |
||
16 | |||
17 | namespace Dwoo\Block; |
||
18 | |||
19 | use Dwoo\Plugin as DwooPlugin; |
||
20 | use Dwoo\Compiler as DwooCompiler; |
||
21 | |||
22 | /** |
||
23 | * Base class for block plugins. |
||
24 | * you have to implement the <em>init()</em> method, it will receive the parameters that |
||
25 | * are in the template code and is called when the block starts |
||
26 | * This software is provided 'as-is', without any express or implied warranty. |
||
27 | * In no event will the authors be held liable for any damages arising from the use of this software. |
||
28 | */ |
||
29 | abstract class Plugin extends DwooPlugin |
||
30 | { |
||
31 | /** |
||
32 | * Stores the contents of the block while it runs. |
||
33 | * |
||
34 | * @var string |
||
35 | */ |
||
36 | protected $buffer = ''; |
||
37 | |||
38 | /** |
||
39 | * Buffers input, override only if necessary. |
||
40 | * |
||
41 | * @var string the content that must be buffered |
||
42 | */ |
||
43 | public function buffer($input) |
||
44 | { |
||
45 | $this->buffer .= $input; |
||
46 | } |
||
47 | |||
48 | // initialization code, receives the parameters from {block param1 param2} |
||
49 | // public function init($arg, $arg, ...); |
||
0 ignored issues
–
show
|
|||
50 | |||
51 | /** |
||
52 | * Called when the block ends, this is most of the time followed right away by a call |
||
53 | * of <em>process()</em> but not always, so this should be used to do any shutdown operations on the |
||
54 | * block object, if required. |
||
55 | */ |
||
56 | public function end() |
||
57 | { |
||
58 | } |
||
59 | |||
60 | /** |
||
61 | * Called when the block output is required by a parent block. |
||
62 | * this must read $this->buffer and return it processed |
||
63 | * |
||
64 | * @return string |
||
65 | */ |
||
66 | public function process() |
||
67 | { |
||
68 | return $this->buffer; |
||
69 | } |
||
70 | |||
71 | /** |
||
72 | * Called at compile time to define what the block should output in the compiled template code, happens when the |
||
73 | * block is declared basically this will replace the {block arg arg arg} tag in the template. |
||
74 | * |
||
75 | * @param DwooCompiler $compiler the compiler instance that calls this function |
||
76 | * @param array $params an array containing original and compiled parameters |
||
77 | * @param string $prepend that is just meant to allow a child class to call |
||
78 | * parent::postProcessing($compiler, $params, "foo();") to add a command before the |
||
79 | * default commands are executed parent::postProcessing($compiler, $params, "foo();") |
||
80 | * to add a command before the default commands are executed |
||
81 | * @param string $append that is just meant to allow a child class to call |
||
82 | * parent::postProcessing($compiler, $params, null, "foo();") to add a command after |
||
83 | * the default commands are executed parent::postProcessing($compiler, $params, null, |
||
84 | * "foo();") to add a command after the default commands are executed |
||
85 | * @param string $type the type is the plugin class name used |
||
86 | * |
||
87 | * @return string |
||
88 | */ |
||
89 | public static function preProcessing(DwooCompiler $compiler, array $params, $prepend, $append, $type) |
||
90 | { |
||
91 | return DwooCompiler::PHP_OPEN . $prepend . '$this->addStack("' . $type . '", array(' . DwooCompiler::implode_r($compiler->getCompiledParams($params)) . '));' . $append . DwooCompiler::PHP_CLOSE; |
||
92 | } |
||
93 | |||
94 | /** |
||
95 | * Called at compile time to define what the block should output in the compiled template code, happens when the |
||
96 | * block is ended basically this will replace the {/block} tag in the template. |
||
97 | * |
||
98 | * @see preProcessing |
||
99 | * |
||
100 | * @param DwooCompiler $compiler the compiler instance that calls this function |
||
101 | * @param array $params an array containing original and compiled parameters, see preProcessing() for more |
||
102 | * details more details |
||
103 | * @param string $prepend that is just meant to allow a child class to call |
||
104 | * parent::postProcessing($compiler, $params, "foo();") to add a command before the |
||
105 | * default commands are executed parent::postProcessing($compiler, $params, "foo();") |
||
106 | * to add a command before the default commands are executed |
||
107 | * @param string $append that is just meant to allow a child class to call |
||
108 | * parent::postProcessing($compiler, $params, null, "foo();") to add a command after |
||
109 | * the default commands are executed parent::postProcessing($compiler, $params, null, |
||
110 | * "foo();") to add a command after the default commands are executed |
||
111 | * @param string $content the entire content of the block being closed |
||
112 | * |
||
113 | * @return string |
||
114 | */ |
||
115 | public static function postProcessing(DwooCompiler $compiler, array $params, $prepend, $append, $content) |
||
116 | { |
||
117 | return $content . DwooCompiler::PHP_OPEN . $prepend . '$this->delStack();' . $append . DwooCompiler::PHP_CLOSE; |
||
118 | } |
||
119 | } |
||
120 |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.