Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Core often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Core, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
45 | class Core |
||
46 | { |
||
47 | /** |
||
48 | * Current version number. |
||
49 | * |
||
50 | * @var string |
||
51 | */ |
||
52 | const VERSION = '1.3.6'; |
||
53 | |||
54 | /** |
||
55 | * Unique number of this dwoo release, based on version number. |
||
56 | * this can be used by templates classes to check whether the compiled template |
||
57 | * has been compiled before this release or not, so that old templates are |
||
58 | * recompiled automatically when Dwoo is updated |
||
59 | */ |
||
60 | const RELEASE_TAG = 136; |
||
61 | |||
62 | /** |
||
63 | * Constants that represents all plugin types |
||
64 | * these are bitwise-operation-safe values to allow multiple types |
||
65 | * on a single plugin |
||
66 | * |
||
67 | * @var int |
||
68 | */ |
||
69 | const CLASS_PLUGIN = 1; |
||
70 | const FUNC_PLUGIN = 2; |
||
71 | const NATIVE_PLUGIN = 4; |
||
72 | const BLOCK_PLUGIN = 8; |
||
73 | const COMPILABLE_PLUGIN = 16; |
||
74 | const CUSTOM_PLUGIN = 32; |
||
75 | const SMARTY_MODIFIER = 64; |
||
76 | const SMARTY_BLOCK = 128; |
||
77 | const SMARTY_FUNCTION = 256; |
||
78 | const PROXY_PLUGIN = 512; |
||
79 | const TEMPLATE_PLUGIN = 1024; |
||
80 | |||
81 | /** |
||
82 | * Constant to default namespaces of builtin plugins |
||
83 | * |
||
84 | * @var string |
||
85 | */ |
||
86 | const NAMESPACE_PLUGINS_BLOCKS = 'Dwoo\Plugins\Blocks\\'; |
||
87 | const NAMESPACE_PLUGINS_FILTERS = 'Dwoo\Plugins\Filters\\'; |
||
88 | const NAMESPACE_PLUGINS_FUNCTIONS = 'Dwoo\Plugins\Functions\\'; |
||
89 | const NAMESPACE_PLUGINS_HELPERS = 'Dwoo\Plugins\Helpers\\'; |
||
90 | const NAMESPACE_PLUGINS_PROCESSORS = 'Dwoo\Plugins\Processors\\'; |
||
91 | |||
92 | /** |
||
93 | * Character set of the template, used by string manipulation plugins. |
||
94 | * it must be lowercase, but setCharset() will take care of that |
||
95 | * |
||
96 | * @see setCharset |
||
97 | * @see getCharset |
||
98 | * @var string |
||
99 | */ |
||
100 | protected $charset = 'UTF-8'; |
||
101 | |||
102 | /** |
||
103 | * Global variables that are accessible through $dwoo.* in the templates. |
||
104 | * default values include: |
||
105 | * $dwoo.version - current version number |
||
106 | * $dwoo.ad - a Powered by Dwoo link pointing to dwoo.org |
||
107 | * $dwoo.now - the current time |
||
108 | * $dwoo.template - the current template filename |
||
109 | * $dwoo.charset - the character set used by the template |
||
110 | * on top of that, foreach and other plugins can store special values in there, |
||
111 | * see their documentation for more details. |
||
112 | * |
||
113 | * @var array |
||
114 | */ |
||
115 | protected $globals = array(); |
||
116 | |||
117 | /** |
||
118 | * Directory where the compiled templates are stored. |
||
119 | * defaults to DWOO_COMPILEDIR (= dwoo_dir/compiled by default) |
||
120 | * |
||
121 | * @var string |
||
122 | */ |
||
123 | protected $compileDir; |
||
124 | |||
125 | /** |
||
126 | * Directory where the cached templates are stored. |
||
127 | * defaults to DWOO_CACHEDIR (= dwoo_dir/cache by default) |
||
128 | * |
||
129 | * @var string |
||
130 | */ |
||
131 | protected $cacheDir; |
||
132 | |||
133 | /** |
||
134 | * Directory where the template files are stored |
||
135 | * |
||
136 | * @var array |
||
137 | */ |
||
138 | protected $templateDir = array(); |
||
139 | |||
140 | /** |
||
141 | * Defines how long (in seconds) the cached files must remain valid. |
||
142 | * can be overridden on a per-template basis |
||
143 | * -1 = never delete |
||
144 | * 0 = disabled |
||
145 | * >0 = duration in seconds |
||
146 | * |
||
147 | * @var int |
||
148 | */ |
||
149 | protected $cacheTime = 0; |
||
150 | |||
151 | /** |
||
152 | * Security policy object. |
||
153 | * |
||
154 | * @var SecurityPolicy |
||
155 | */ |
||
156 | protected $securityPolicy = null; |
||
157 | |||
158 | /** |
||
159 | * Stores the custom plugins callbacks. |
||
160 | * |
||
161 | * @see addPlugin |
||
162 | * @see removePlugin |
||
163 | * @var array |
||
164 | */ |
||
165 | protected $plugins = array(); |
||
166 | |||
167 | /** |
||
168 | * Stores the filter callbacks. |
||
169 | * |
||
170 | * @see addFilter |
||
171 | * @see removeFilter |
||
172 | * @var array |
||
173 | */ |
||
174 | protected $filters = array(); |
||
175 | |||
176 | /** |
||
177 | * Stores the resource types and associated |
||
178 | * classes / compiler classes. |
||
179 | * |
||
180 | * @var array |
||
181 | */ |
||
182 | protected $resources = array( |
||
183 | 'file' => array( |
||
184 | 'class' => 'Dwoo\Template\File', |
||
185 | 'compiler' => null, |
||
186 | ), |
||
187 | 'string' => array( |
||
188 | 'class' => 'Dwoo\Template\Str', |
||
189 | 'compiler' => null, |
||
190 | ), |
||
191 | ); |
||
192 | |||
193 | /** |
||
194 | * The dwoo loader object used to load plugins by this dwoo instance. |
||
195 | * |
||
196 | * @var ILoader |
||
197 | */ |
||
198 | protected $loader = null; |
||
199 | |||
200 | /** |
||
201 | * Currently rendered template, set to null when not-rendering. |
||
202 | * |
||
203 | * @var ITemplate |
||
204 | */ |
||
205 | protected $template = null; |
||
206 | |||
207 | /** |
||
208 | * Stores the instances of the class plugins during template runtime. |
||
209 | * |
||
210 | * @var array |
||
211 | */ |
||
212 | protected $runtimePlugins = array(); |
||
213 | |||
214 | /** |
||
215 | * Stores the returned values during template runtime. |
||
216 | * |
||
217 | * @var array |
||
218 | */ |
||
219 | protected $returnData = array(); |
||
220 | |||
221 | /** |
||
222 | * Stores the data during template runtime. |
||
223 | * |
||
224 | * @var array |
||
225 | */ |
||
226 | protected $data = array(); |
||
227 | |||
228 | /** |
||
229 | * Stores the current scope during template runtime. |
||
230 | * this should ideally not be accessed directly from outside template code |
||
231 | * |
||
232 | * @var mixed |
||
233 | */ |
||
234 | public $scope; |
||
235 | |||
236 | /** |
||
237 | * Stores the scope tree during template runtime. |
||
238 | * |
||
239 | * @var array |
||
240 | */ |
||
241 | protected $scopeTree = array(); |
||
242 | |||
243 | /** |
||
244 | * Stores the block plugins stack during template runtime. |
||
245 | * |
||
246 | * @var array |
||
247 | */ |
||
248 | protected $stack = array(); |
||
249 | |||
250 | /** |
||
251 | * Stores the current block plugin at the top of the stack during template runtime. |
||
252 | * |
||
253 | * @var BlockPlugin |
||
254 | */ |
||
255 | protected $curBlock; |
||
256 | |||
257 | /** |
||
258 | * Stores the output buffer during template runtime. |
||
259 | * |
||
260 | * @var string |
||
261 | */ |
||
262 | protected $buffer; |
||
263 | |||
264 | /** |
||
265 | * Stores plugin proxy. |
||
266 | * |
||
267 | * @var IPluginProxy |
||
268 | */ |
||
269 | protected $pluginProxy; |
||
270 | |||
271 | /** |
||
272 | * Constructor, sets the cache and compile dir to the default values if not provided. |
||
273 | * |
||
274 | * @param string $compileDir path to the compiled directory, defaults to lib/compiled |
||
275 | * @param string $cacheDir path to the cache directory, defaults to lib/cache |
||
276 | */ |
||
277 | public function __construct($compileDir = null, $cacheDir = null) |
||
287 | |||
288 | /** |
||
289 | * Resets some runtime variables to allow a cloned object to be used to render sub-templates. |
||
290 | * |
||
291 | * @return void |
||
292 | */ |
||
293 | public function __clone() |
||
299 | |||
300 | /** |
||
301 | * Returns the given template rendered using the provided data and optional compiler. |
||
302 | * |
||
303 | * @param mixed $_tpl template, can either be a ITemplate object (i.e. TemplateFile), a |
||
304 | * valid path to a template, or a template as a string it is recommended to |
||
305 | * provide a ITemplate as it will probably make things faster, especially if |
||
306 | * you render a template multiple times |
||
307 | * @param mixed $data the data to use, can either be a IDataProvider object (i.e. Data) or |
||
308 | * an associative array. if you're rendering the template from cache, it can be |
||
309 | * left null |
||
310 | * @param ICompiler $_compiler the compiler that must be used to compile the template, if left empty a default |
||
311 | * Compiler will be used |
||
312 | * |
||
313 | * @return string|void or the template output if $output is false |
||
314 | * @throws Exception |
||
315 | */ |
||
316 | public function get($_tpl, $data = array(), $_compiler = null) |
||
416 | |||
417 | /** |
||
418 | * Registers a Global. |
||
419 | * New globals can be added before compiling or rendering a template |
||
420 | * but after, you can only update existing globals. |
||
421 | * |
||
422 | * @param string $name |
||
423 | * @param mixed $value |
||
424 | * |
||
425 | * @return $this |
||
426 | * @throws Exception |
||
427 | */ |
||
428 | public function addGlobal($name, $value) |
||
438 | |||
439 | /** |
||
440 | * Gets the registered Globals. |
||
441 | * |
||
442 | * @return array |
||
443 | */ |
||
444 | public function getGlobals() |
||
448 | |||
449 | /** |
||
450 | * Re-initializes the globals array before each template run. |
||
451 | * this method is only callede once when the Dwoo object is created |
||
452 | * |
||
453 | * @return void |
||
454 | */ |
||
455 | protected function initGlobals() |
||
464 | |||
465 | /** |
||
466 | * Re-initializes the runtime variables before each template run. |
||
467 | * override this method to inject data in the globals array if needed, this |
||
468 | * method is called before each template execution |
||
469 | * |
||
470 | * @param ITemplate $tpl the template that is going to be rendered |
||
471 | * |
||
472 | * @return void |
||
473 | */ |
||
474 | protected function initRuntimeVars(ITemplate $tpl) |
||
484 | |||
485 | /** |
||
486 | * Adds a custom plugin that is not in one of the plugin directories. |
||
487 | * |
||
488 | * @param string $name the plugin name to be used in the templates |
||
489 | * @param callback $callback the plugin callback, either a function name, |
||
490 | * a class name or an array containing an object |
||
491 | * or class name and a method name |
||
492 | * @param bool $compilable if set to true, the plugin is assumed to be compilable |
||
493 | * |
||
494 | * @return void |
||
495 | * @throws Exception |
||
496 | */ |
||
497 | public function addPlugin($name, $callback, $compilable = false) |
||
563 | |||
564 | /** |
||
565 | * Removes a custom plugin. |
||
566 | * |
||
567 | * @param string $name the plugin name |
||
568 | * |
||
569 | * @return void |
||
570 | */ |
||
571 | public function removePlugin($name) |
||
577 | |||
578 | /** |
||
579 | * Adds a filter to this Dwoo instance, it will be used to filter the output of all the templates rendered by this |
||
580 | * instance. |
||
581 | * |
||
582 | * @param mixed $callback a callback or a filter name if it is autoloaded from a plugin directory |
||
583 | * @param bool $autoload if true, the first parameter must be a filter name from one of the plugin directories |
||
584 | * |
||
585 | * @return void |
||
586 | * @throws Exception |
||
587 | */ |
||
588 | public function addFilter($callback, $autoload = false) |
||
618 | |||
619 | /** |
||
620 | * Removes a filter. |
||
621 | * |
||
622 | * @param mixed $callback callback or filter name if it was autoloaded |
||
623 | * |
||
624 | * @return void |
||
625 | */ |
||
626 | public function removeFilter($callback) |
||
644 | |||
645 | /** |
||
646 | * Adds a resource or overrides a default one. |
||
647 | * |
||
648 | * @param string $name the resource name |
||
649 | * @param string $class the resource class (which must implement ITemplate) |
||
650 | * @param callback $compilerFactory the compiler factory callback, a function that must return a compiler instance |
||
651 | * used to compile this resource, if none is provided. by default it will produce |
||
652 | * a Compiler object |
||
653 | * |
||
654 | * @return void |
||
655 | * @throws Exception |
||
656 | */ |
||
657 | public function addResource($name, $class, $compilerFactory = null) |
||
677 | |||
678 | /** |
||
679 | * Removes a custom resource. |
||
680 | * |
||
681 | * @param string $name the resource name |
||
682 | * |
||
683 | * @return void |
||
684 | */ |
||
685 | public function removeResource($name) |
||
695 | |||
696 | /** |
||
697 | * Sets the loader object to use to load plugins. |
||
698 | * |
||
699 | * @param ILoader $loader loader |
||
700 | * |
||
701 | * @return void |
||
702 | */ |
||
703 | public function setLoader(ILoader $loader) |
||
707 | |||
708 | /** |
||
709 | * Returns the current loader object or a default one if none is currently found. |
||
710 | * |
||
711 | * @return ILoader|Loader |
||
712 | */ |
||
713 | public function getLoader() |
||
721 | |||
722 | /** |
||
723 | * Returns the custom plugins loaded. |
||
724 | * Used by the ITemplate classes to pass the custom plugins to their ICompiler instance. |
||
725 | * |
||
726 | * @return array |
||
727 | */ |
||
728 | public function getCustomPlugins() |
||
732 | |||
733 | /** |
||
734 | * Return a specified custom plugin loaded by his name. |
||
735 | * Used by the compiler, for executing a Closure. |
||
736 | * |
||
737 | * @param string $name |
||
738 | * |
||
739 | * @return mixed|null |
||
740 | */ |
||
741 | public function getCustomPlugin($name) |
||
749 | |||
750 | /** |
||
751 | * Returns the cache directory with a trailing DIRECTORY_SEPARATOR. |
||
752 | * |
||
753 | * @return string |
||
754 | */ |
||
755 | public function getCacheDir() |
||
763 | |||
764 | /** |
||
765 | * Sets the cache directory and automatically appends a DIRECTORY_SEPARATOR. |
||
766 | * |
||
767 | * @param string $dir the cache directory |
||
768 | * |
||
769 | * @return void |
||
770 | * @throws Exception |
||
771 | */ |
||
772 | View Code Duplication | public function setCacheDir($dir) |
|
782 | |||
783 | /** |
||
784 | * Returns the compile directory with a trailing DIRECTORY_SEPARATOR. |
||
785 | * |
||
786 | * @return string |
||
787 | */ |
||
788 | public function getCompileDir() |
||
796 | |||
797 | /** |
||
798 | * Sets the compile directory and automatically appends a DIRECTORY_SEPARATOR. |
||
799 | * |
||
800 | * @param string $dir the compile directory |
||
801 | * |
||
802 | * @return void |
||
803 | * @throws Exception |
||
804 | */ |
||
805 | View Code Duplication | public function setCompileDir($dir) |
|
815 | |||
816 | /** |
||
817 | * Returns an array of the template directory with a trailing DIRECTORY_SEPARATOR |
||
818 | * |
||
819 | * @return array |
||
820 | */ |
||
821 | public function getTemplateDir() |
||
825 | |||
826 | /** |
||
827 | * sets the template directory and automatically appends a DIRECTORY_SEPARATOR |
||
828 | * template directory is stored in an array |
||
829 | * |
||
830 | * @param string $dir |
||
831 | * |
||
832 | * @throws Exception |
||
833 | */ |
||
834 | public function setTemplateDir($dir) |
||
842 | |||
843 | /** |
||
844 | * Returns the default cache time that is used with templates that do not have a cache time set. |
||
845 | * |
||
846 | * @return int the duration in seconds |
||
847 | */ |
||
848 | public function getCacheTime() |
||
852 | |||
853 | /** |
||
854 | * Sets the default cache time to use with templates that do not have a cache time set. |
||
855 | * |
||
856 | * @param int $seconds the duration in seconds |
||
857 | * |
||
858 | * @return void |
||
859 | */ |
||
860 | public function setCacheTime($seconds) |
||
864 | |||
865 | /** |
||
866 | * Returns the character set used by the string manipulation plugins. |
||
867 | * the charset is automatically lowercased |
||
868 | * |
||
869 | * @return string |
||
870 | */ |
||
871 | public function getCharset() |
||
875 | |||
876 | /** |
||
877 | * Sets the character set used by the string manipulation plugins. |
||
878 | * the charset will be automatically lowercased |
||
879 | * |
||
880 | * @param string $charset the character set |
||
881 | * |
||
882 | * @return void |
||
883 | */ |
||
884 | public function setCharset($charset) |
||
888 | |||
889 | /** |
||
890 | * Returns the current template being rendered, when applicable, or null. |
||
891 | * |
||
892 | * @return ITemplate|null |
||
893 | */ |
||
894 | public function getTemplate() |
||
898 | |||
899 | /** |
||
900 | * Sets the current template being rendered. |
||
901 | * |
||
902 | * @param ITemplate $tpl template object |
||
903 | * |
||
904 | * @return void |
||
905 | */ |
||
906 | public function setTemplate(ITemplate $tpl) |
||
910 | |||
911 | /** |
||
912 | * Sets the default compiler factory function for the given resource name. |
||
913 | * a compiler factory must return a ICompiler object pre-configured to fit your needs |
||
914 | * |
||
915 | * @param string $resourceName the resource name (i.e. file, string) |
||
916 | * @param callback $compilerFactory the compiler factory callback |
||
917 | * |
||
918 | * @return void |
||
919 | */ |
||
920 | public function setDefaultCompilerFactory($resourceName, $compilerFactory) |
||
924 | |||
925 | /** |
||
926 | * Returns the default compiler factory function for the given resource name. |
||
927 | * |
||
928 | * @param string $resourceName the resource name |
||
929 | * |
||
930 | * @return callback the compiler factory callback |
||
931 | */ |
||
932 | public function getDefaultCompilerFactory($resourceName) |
||
936 | |||
937 | /** |
||
938 | * Sets the security policy object to enforce some php security settings. |
||
939 | * use this if untrusted persons can modify templates |
||
940 | * |
||
941 | * @param SecurityPolicy $policy the security policy object |
||
942 | * |
||
943 | * @return void |
||
944 | */ |
||
945 | public function setSecurityPolicy(SecurityPolicy $policy = null) |
||
949 | |||
950 | /** |
||
951 | * Returns the current security policy object or null by default. |
||
952 | * |
||
953 | * @return SecurityPolicy|null the security policy object if any |
||
954 | */ |
||
955 | public function getSecurityPolicy() |
||
959 | |||
960 | /** |
||
961 | * Sets the object that must be used as a plugin proxy when plugin can't be found |
||
962 | * by dwoo's loader. |
||
963 | * |
||
964 | * @param IPluginProxy $pluginProxy the proxy object |
||
965 | * |
||
966 | * @return void |
||
967 | */ |
||
968 | public function setPluginProxy(IPluginProxy $pluginProxy) |
||
972 | |||
973 | /** |
||
974 | * Returns the current plugin proxy object or null by default. |
||
975 | * |
||
976 | * @return IPluginProxy |
||
977 | */ |
||
978 | public function getPluginProxy() |
||
982 | |||
983 | /** |
||
984 | * Checks whether the given template is cached or not. |
||
985 | * |
||
986 | * @param ITemplate $tpl the template object |
||
987 | * |
||
988 | * @return bool |
||
989 | */ |
||
990 | public function isCached(ITemplate $tpl) |
||
994 | |||
995 | /** |
||
996 | * Clear templates inside the compiled directory. |
||
997 | * |
||
998 | * @return int |
||
999 | */ |
||
1000 | public function clearCompiled() |
||
1012 | |||
1013 | /** |
||
1014 | * Clears the cached templates if they are older than the given time. |
||
1015 | * |
||
1016 | * @param int $olderThan minimum time (in seconds) required for a cached template to be cleared |
||
1017 | * |
||
1018 | * @return int the amount of templates cleared |
||
1019 | */ |
||
1020 | public function clearCache($olderThan = - 1) |
||
1033 | |||
1034 | /** |
||
1035 | * Fetches a template object of the given resource. |
||
1036 | * |
||
1037 | * @param string $resourceName the resource name (i.e. file, string) |
||
1038 | * @param string $resourceId the resource identifier (i.e. file path) |
||
1039 | * @param int $cacheTime the cache time setting for this resource |
||
1040 | * @param string $cacheId the unique cache identifier |
||
1041 | * @param string $compileId the unique compiler identifier |
||
1042 | * @param ITemplate $parentTemplate the parent template |
||
1043 | * |
||
1044 | * @return ITemplate |
||
1045 | * @throws Exception |
||
1046 | */ |
||
1047 | public function templateFactory($resourceName, $resourceId, $cacheTime = null, $cacheId = null, $compileId = null, ITemplate $parentTemplate = null) |
||
1062 | |||
1063 | /** |
||
1064 | * Checks if the input is an array or arrayaccess object, optionally it can also check if it's |
||
1065 | * empty. |
||
1066 | * |
||
1067 | * @param mixed $value the variable to check |
||
1068 | * @param bool $checkIsEmpty if true, the function will also check if the array|arrayaccess is empty, |
||
1069 | * and return true only if it's not empty |
||
1070 | * |
||
1071 | * @return int|bool true if it's an array|arrayaccess (or the item count if $checkIsEmpty is true) or false if it's |
||
1072 | * not an array|arrayaccess (or 0 if $checkIsEmpty is true) |
||
1073 | */ |
||
1074 | public function isArray($value, $checkIsEmpty = false) |
||
1086 | |||
1087 | /** |
||
1088 | * Checks if the input is an array or a traversable object, optionally it can also check if it's |
||
1089 | * empty. |
||
1090 | * |
||
1091 | * @param mixed $value the variable to check |
||
1092 | * @param bool $checkIsEmpty if true, the function will also check if the array|traversable is empty, |
||
1093 | * and return true only if it's not empty |
||
1094 | * |
||
1095 | * @return int|bool true if it's an array|traversable (or the item count if $checkIsEmpty is true) or false if it's |
||
1096 | * not an array|traversable (or 0 if $checkIsEmpty is true) |
||
1097 | */ |
||
1098 | public function isTraversable($value, $checkIsEmpty = false) |
||
1116 | |||
1117 | /** |
||
1118 | * Counts an array or arrayaccess/traversable object. |
||
1119 | * |
||
1120 | * @param mixed $value the value to count |
||
1121 | * |
||
1122 | * @return int|bool the count for arrays and objects that implement countable, true for other objects that don't, |
||
1123 | * and 0 for empty elements |
||
1124 | */ |
||
1125 | public function count($value) |
||
1146 | |||
1147 | /** |
||
1148 | * Triggers a dwoo error. |
||
1149 | * |
||
1150 | * @param string $message the error message |
||
1151 | * @param int $level the error level, one of the PHP's E_* constants |
||
1152 | * |
||
1153 | * @return void |
||
1154 | */ |
||
1155 | public function triggerError($message, $level = E_USER_NOTICE) |
||
1162 | |||
1163 | /** |
||
1164 | * Adds a block to the block stack. |
||
1165 | * |
||
1166 | * @param string $blockName the block name (without `Plugin` prefix) |
||
1167 | * @param array $args the arguments to be passed to the block's init() function |
||
1168 | * |
||
1169 | * @return BlockPlugin the newly created block |
||
1170 | */ |
||
1171 | public function addStack($blockName, array $args = array()) |
||
1195 | |||
1196 | /** |
||
1197 | * Removes the plugin at the top of the block stack. |
||
1198 | * Calls the block buffer() function, followed by a call to end() and finally a call to process() |
||
1199 | * |
||
1200 | * @return void |
||
1201 | */ |
||
1202 | public function delStack() |
||
1227 | |||
1228 | /** |
||
1229 | * Returns the parent block of the given block. |
||
1230 | * |
||
1231 | * @param BlockPlugin $block the block class plugin |
||
1232 | * |
||
1233 | * @return BlockPlugin|false if the given block isn't in the stack |
||
1234 | */ |
||
1235 | public function getParentBlock(BlockPlugin $block) |
||
1244 | |||
1245 | /** |
||
1246 | * Finds the closest block of the given type, starting at the top of the stack. |
||
1247 | * |
||
1248 | * @param string $type the type of plugin you want to find |
||
1249 | * |
||
1250 | * @return BlockPlugin|false if no plugin of such type is in the stack |
||
1251 | */ |
||
1252 | public function findBlock($type) |
||
1270 | |||
1271 | /** |
||
1272 | * Returns a Plugin of the given class. |
||
1273 | * this is so a single instance of every class plugin is created at each template run, |
||
1274 | * allowing class plugins to have "per-template-run" static variables |
||
1275 | * |
||
1276 | * @param string $class the class name |
||
1277 | * |
||
1278 | * @return mixed an object of the given class |
||
1279 | */ |
||
1280 | public function getObjectPlugin($class) |
||
1288 | |||
1289 | /** |
||
1290 | * Calls the process() method of the given class-plugin name. |
||
1291 | * |
||
1292 | * @param string $plugName the class plugin name (without `Plugin` prefix) |
||
1293 | * @param array $params an array of parameters to send to the process() method |
||
1294 | * |
||
1295 | * @return string the process() return value |
||
1296 | */ |
||
1297 | public function classCall($plugName, array $params = array()) |
||
1304 | |||
1305 | /** |
||
1306 | * Calls a php function. |
||
1307 | * |
||
1308 | * @param string $callback the function to call |
||
1309 | * @param array $params an array of parameters to send to the function |
||
1310 | * |
||
1311 | * @return mixed the return value of the called function |
||
1312 | */ |
||
1313 | public function arrayMap($callback, array $params) |
||
1390 | |||
1391 | /** |
||
1392 | * Reads a variable into the given data array. |
||
1393 | * |
||
1394 | * @param string $varstr the variable string, using dwoo variable syntax (i.e. "var.subvar[subsubvar]->property") |
||
1395 | * @param mixed $data the data array or object to read from |
||
1396 | * @param bool $safeRead if true, the function will check whether the index exists to prevent any notices from |
||
1397 | * being output |
||
1398 | * |
||
1399 | * @return mixed |
||
1400 | */ |
||
1401 | public function readVarInto($varstr, $data, $safeRead = false) |
||
1435 | |||
1436 | /** |
||
1437 | * Reads a variable into the parent scope. |
||
1438 | * |
||
1439 | * @param int $parentLevels the amount of parent levels to go from the current scope |
||
1440 | * @param string $varstr the variable string, using dwoo variable syntax (i.e. |
||
1441 | * "var.subvar[subsubvar]->property") |
||
1442 | * |
||
1443 | * @return mixed |
||
1444 | */ |
||
1445 | public function readParentVar($parentLevels, $varstr = null) |
||
1468 | |||
1469 | /** |
||
1470 | * Reads a variable into the current scope. |
||
1471 | * |
||
1472 | * @param string $varstr the variable string, using dwoo variable syntax (i.e. "var.subvar[subsubvar]->property") |
||
1473 | * |
||
1474 | * @return mixed |
||
1475 | */ |
||
1476 | public function readVar($varstr) |
||
1609 | |||
1610 | /** |
||
1611 | * Assign the value to the given variable. |
||
1612 | * |
||
1613 | * @param mixed $value the value to assign |
||
1614 | * @param string $scope the variable string, using dwoo variable syntax (i.e. "var.subvar[subsubvar]->property") |
||
1615 | * |
||
1616 | * @return bool true if assigned correctly or false if a problem occured while parsing the var string |
||
1617 | */ |
||
1618 | public function assignInScope($value, $scope) |
||
1666 | |||
1667 | /** |
||
1668 | * Sets the scope to the given scope string or array. |
||
1669 | * |
||
1670 | * @param mixed $scope a string i.e. "level1.level2" or an array i.e. array("level1", "level2") |
||
1671 | * @param bool $absolute if true, the scope is set from the top level scope and not from the current scope |
||
1672 | * |
||
1673 | * @return array the current scope tree |
||
1674 | */ |
||
1675 | public function setScope($scope, $absolute = false) |
||
1715 | |||
1716 | /** |
||
1717 | * Returns the entire data array. |
||
1718 | * |
||
1719 | * @return array |
||
1720 | */ |
||
1721 | public function getData() |
||
1725 | |||
1726 | /** |
||
1727 | * Sets a return value for the currently running template. |
||
1728 | * |
||
1729 | * @param string $name var name |
||
1730 | * @param mixed $value var value |
||
1731 | * |
||
1732 | * @return void |
||
1733 | */ |
||
1734 | public function setReturnValue($name, $value) |
||
1738 | |||
1739 | /** |
||
1740 | * Retrieves the return values set by the template. |
||
1741 | * |
||
1742 | * @return array |
||
1743 | */ |
||
1744 | public function getReturnValues() |
||
1748 | |||
1749 | /** |
||
1750 | * Returns a reference to the current scope. |
||
1751 | * |
||
1752 | * @return mixed |
||
1753 | */ |
||
1754 | public function &getScope() |
||
1758 | |||
1759 | /** |
||
1760 | * Redirects all calls to unexisting to plugin proxy. |
||
1761 | * |
||
1762 | * @param string $method the method name |
||
1763 | * @param array $args array of arguments |
||
1764 | * |
||
1765 | * @return mixed |
||
1766 | * @throws Exception |
||
1767 | */ |
||
1768 | public function __call($method, $args) |
||
1777 | |||
1778 | /** |
||
1779 | * Convert plugin name from `auto_escape` to `AutoEscape`. |
||
1780 | * @param string $input |
||
1781 | * @param string $separator |
||
1782 | * |
||
1783 | * @return mixed |
||
1784 | */ |
||
1785 | public static function toCamelCase($input, $separator = '_') |
||
1792 | } |
||
1793 |
This check looks for the bodies of
if
statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.These
if
bodies can be removed. If you have an empty if but statements in theelse
branch, consider inverting the condition.could be turned into
This is much more concise to read.