3 * Smarty Internal Plugin CompileBase
11 * This class does extend all internal compile plugins
14 * @subpackage Compiler
16 abstract class Smarty_Internal_CompileBase {
19 * Array of names of required attribute required by tag
23 public $required_attributes = array();
25 * Array of names of optional attribute required by tag
26 * use array('_any') if there is no restriction of attributes names
30 public $optional_attributes = array();
32 * Shorttag attribute order defined by its names
36 public $shorttag_order = array();
38 * Array of names of valid option flags
42 public $option_flags = array('nocache');
45 * This function checks if the attributes passed are valid
47 * The attributes passed for the tag to compile are checked against the list of required and
48 * optional attributes. Required attributes must be present. Optional attributes are check against
49 * the corresponding list. The keyword '_any' specifies that any attribute will be accepted
52 * @param object $compiler compiler object
53 * @param array $attributes attributes applied to the tag
54 * @return array of mapped attributes for further processing
56 public function getAttributes($compiler, $attributes)
58 $_indexed_attr = array();
59 // loop over attributes
60 foreach ($attributes as $key => $mixed) {
62 if (!is_array($mixed)) {
64 if (in_array(trim($mixed, '\'"'), $this->option_flags)) {
65 $_indexed_attr[trim($mixed, '\'"')] = true;
66 // shorthand attribute ?
67 } else if (isset($this->shorttag_order[$key])) {
68 $_indexed_attr[$this->shorttag_order[$key]] = $mixed;
70 // too many shorthands
71 $compiler->trigger_template_error('too many shorthand attributes', $compiler->lex->taglineno);
77 if (in_array($kv['key'], $this->option_flags)) {
78 if (is_bool($kv['value'])) {
79 $_indexed_attr[$kv['key']] = $kv['value'];
80 } else if (is_string($kv['value']) && in_array(trim($kv['value'], '\'"'), array('true', 'false'))) {
81 if (trim($kv['value']) == 'true') {
82 $_indexed_attr[$kv['key']] = true;
84 $_indexed_attr[$kv['key']] = false;
86 } else if (is_numeric($kv['value']) && in_array($kv['value'], array(0, 1))) {
87 if ($kv['value'] == 1) {
88 $_indexed_attr[$kv['key']] = true;
90 $_indexed_attr[$kv['key']] = false;
93 $compiler->trigger_template_error("illegal value of option flag \"{$kv['key']}\"", $compiler->lex->taglineno);
95 // must be named attribute
98 $_indexed_attr[key($mixed)] = $mixed[key($mixed)];
102 // check if all required attributes present
103 foreach ($this->required_attributes as $attr) {
104 if (!array_key_exists($attr, $_indexed_attr)) {
105 $compiler->trigger_template_error("missing \"" . $attr . "\" attribute", $compiler->lex->taglineno);
108 // check for unallowed attributes
109 if ($this->optional_attributes != array('_any')) {
110 $tmp_array = array_merge($this->required_attributes, $this->optional_attributes, $this->option_flags);
111 foreach ($_indexed_attr as $key => $dummy) {
112 if (!in_array($key, $tmp_array) && $key !== 0) {
113 $compiler->trigger_template_error("unexpected \"" . $key . "\" attribute", $compiler->lex->taglineno);
117 // default 'false' for all option flags not set
118 foreach ($this->option_flags as $flag) {
119 if (!isset($_indexed_attr[$flag])) {
120 $_indexed_attr[$flag] = false;
124 return $_indexed_attr;
128 * Push opening tag name on stack
130 * Optionally additional data can be saved on stack
132 * @param object $compiler compiler object
133 * @param string $openTag the opening tag's name
134 * @param mixed $data optional data saved
136 public function openTag($compiler, $openTag, $data = null)
138 array_push($compiler->_tag_stack, array($openTag, $data));
144 * Raise an error if this stack-top doesn't match with expected opening tags
146 * @param object $compiler compiler object
147 * @param array|string $expectedTag the expected opening tag names
148 * @return mixed any type the opening tag's name or saved data
150 public function closeTag($compiler, $expectedTag)
152 if (count($compiler->_tag_stack) > 0) {
154 list($_openTag, $_data) = array_pop($compiler->_tag_stack);
155 // open tag must match with the expected ones
156 if (in_array($_openTag, (array) $expectedTag)) {
157 if (is_null($_data)) {
158 // return opening tag
161 // return restored data
165 // wrong nesting of tags
166 $compiler->trigger_template_error("unclosed {" . $_openTag . "} tag");
169 // wrong nesting of tags
170 $compiler->trigger_template_error("unexpected closing tag", $compiler->lex->taglineno);