|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Copyright (c) 2013-2016 |
|
4
|
|
|
* |
|
5
|
|
|
* @category Library |
|
6
|
|
|
* @package Dwoo |
|
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; |
|
18
|
|
|
|
|
19
|
|
|
/** |
|
20
|
|
|
* Base plugin class. |
|
21
|
|
|
* you have to implement the <em>process()</em> method, it will receive the parameters that |
|
22
|
|
|
* are in the template code |
|
23
|
|
|
* This software is provided 'as-is', without any express or implied warranty. |
|
24
|
|
|
* In no event will the authors be held liable for any damages arising from the use of this software. |
|
25
|
|
|
*/ |
|
26
|
|
|
abstract class Plugin |
|
27
|
|
|
{ |
|
28
|
|
|
/** |
|
29
|
|
|
* The dwoo instance that runs this plugin. |
|
30
|
|
|
* |
|
31
|
|
|
* @var Core |
|
32
|
|
|
*/ |
|
33
|
|
|
protected $core; |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* Constructor, if you override it, call parent::__construct($core); or assign |
|
37
|
|
|
* the dwoo instance yourself if you need it. |
|
38
|
|
|
* |
|
39
|
|
|
* @param Core $core the dwoo instance that runs this plugin |
|
40
|
|
|
*/ |
|
41
|
|
|
public function __construct(Core $core) |
|
42
|
|
|
{ |
|
43
|
|
|
$this->core = $core; |
|
44
|
|
|
} |
|
45
|
|
|
|
|
46
|
|
|
// plugins should always implement : |
|
47
|
|
|
// public function process($arg, $arg, ...) |
|
|
|
|
|
|
48
|
|
|
// or for block plugins : |
|
49
|
|
|
// public function init($arg, $arg, ...) |
|
|
|
|
|
|
50
|
|
|
|
|
51
|
|
|
// this could be enforced with : |
|
52
|
|
|
// abstract public function process(...); |
|
|
|
|
|
|
53
|
|
|
// if my feature request gets enough interest one day |
|
54
|
|
|
// see => http://bugs.php.net/bug.php?id=44043 |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* Utility function that converts an array of compiled parameters (or rest array) to a string of xml/html tag |
|
58
|
|
|
* attributes. this is to be used in preProcessing or postProcessing functions, example : |
|
59
|
|
|
* $p = $compiler->getCompiledParams($params); |
|
60
|
|
|
* // get only the rest array as attributes |
|
61
|
|
|
* $attributes = Plugin::paramsToAttributes($p['*']); |
|
62
|
|
|
* // get all the parameters as attributes (if there is a rest array, it will be included) |
|
63
|
|
|
* $attributes = Plugin::paramsToAttributes($p); |
|
64
|
|
|
* |
|
65
|
|
|
* @param array $params an array of attributeName=>value items that will be compiled to be ready for inclusion in a php string |
|
66
|
|
|
* inclusion in a php string |
|
67
|
|
|
* @param string $delim the string delimiter you want to use (defaults to ') |
|
68
|
|
|
* @param Compiler $compiler the compiler instance (optional for BC, but recommended to pass it for proper escaping behavior) |
|
69
|
|
|
* escaping behavior) |
|
70
|
|
|
* |
|
71
|
|
|
* @return string |
|
72
|
|
|
*/ |
|
73
|
|
|
public static function paramsToAttributes(array $params, $delim = '\'', Compiler $compiler = null) |
|
74
|
|
|
{ |
|
75
|
|
|
if (isset($params['*'])) { |
|
76
|
|
|
$params = array_merge($params, $params['*']); |
|
77
|
|
|
unset($params['*']); |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
$out = ''; |
|
81
|
|
|
foreach ($params as $attr => $val) { |
|
82
|
|
|
$out .= ' ' . $attr . '='; |
|
83
|
|
|
if (trim($val, '"\'') == '' || $val == 'null') { |
|
84
|
|
|
$out .= str_replace($delim, '\\' . $delim, '""'); |
|
85
|
|
|
} elseif (substr($val, 0, 1) === $delim && substr($val, - 1) === $delim) { |
|
86
|
|
|
$out .= str_replace($delim, '\\' . $delim, '"' . substr($val, 1, - 1) . '"'); |
|
87
|
|
|
} else { |
|
88
|
|
|
if (!$compiler) { |
|
89
|
|
|
// disable double encoding since it can not be determined if it was encoded |
|
90
|
|
|
$escapedVal = '.(is_string($tmp2=' . $val . ') ? htmlspecialchars($tmp2, ENT_QUOTES, $this->charset, false) : $tmp2).'; |
|
91
|
|
|
} elseif (!$compiler->getAutoEscape() || false === strpos($val, 'isset($this->scope')) { |
|
92
|
|
|
// escape if auto escaping is disabled, or there was no variable in the string |
|
93
|
|
|
$escapedVal = '.(is_string($tmp2=' . $val . ') ? htmlspecialchars($tmp2, ENT_QUOTES, $this->charset) : $tmp2).'; |
|
94
|
|
|
} else { |
|
95
|
|
|
// print as is |
|
96
|
|
|
$escapedVal = '.' . $val . '.'; |
|
97
|
|
|
} |
|
98
|
|
|
|
|
99
|
|
|
$out .= str_replace($delim, '\\' . $delim, '"') . $delim . $escapedVal . $delim . str_replace($delim, '\\' . $delim, '"'); |
|
100
|
|
|
} |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
return ltrim($out); |
|
104
|
|
|
} |
|
105
|
|
|
} |
|
106
|
|
|
|
dwoo-project /
dwoo
Loading history...
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.