]> src.bluestatic.org Git - isso.git/blob - PrinterAbstract.php
Add a way to quick-set API fields via an array
[isso.git] / PrinterAbstract.php
1 <?php
2 /*=====================================================================*
3 || ###################################################################
4 || # Blue Static ISSO Framework
5 || # Copyright (c)2005-2008 Blue Static
6 || #
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version 2 of the License.
10 || #
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 || # more details.
15 || #
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
21
22 /**
23 * Printer Element Abstract Class (PrinterAbstract.php)
24 *
25 * @package ISSO
26 */
27
28 /**
29 * Printer Element
30 *
31 * This abstract class is used for all printer elements and describes
32 * the basic functionality of an element.
33 *
34 * @author Blue Static
35 * @copyright Copyright (c)2005 - 2008, Blue Static
36 * @package ISSO
37 *
38 */
39 abstract class BSPrinterAbstract
40 {
41 /**
42 * Style information
43 * @var array
44 */
45 protected $style = array();
46
47 /**
48 * The CSS class to use
49 * @var string
50 */
51 protected $cssClass = ':swap:';
52
53 /**
54 * DOM ID of the element
55 * @var string
56 */
57 protected $id;
58
59 /**
60 * Fluent object instantiation
61 */
62 public abstract static function make();
63
64 /**
65 * Tells the element to paint itself (and any children)
66 */
67 public abstract function paint();
68
69 /**
70 * Sets the CSS class to use. Use ":swap:" to alternate
71 *
72 * @param string CSS class
73 *
74 * @return fluent interface
75 */
76 public function setCssClass($class)
77 {
78 $this->cssClass = $class;
79 return $this;
80 }
81
82 /**
83 * Sets the style information
84 *
85 * @param array Style attributes
86 *
87 * @return fluent interface
88 */
89 public function setStyle(Array $attributes)
90 {
91 $this->style = $attributes;
92 return $this;
93 }
94
95 /**
96 * Sets the DOM/CSS ID of the element
97 *
98 * @param string The ID
99 */
100 public function setId($id)
101 {
102 $this->id = $id;
103 return $this;
104 }
105
106 /**
107 * Returns a string of CSS style attributes
108 *
109 * @return string CSS attributes
110 */
111 protected function _prepareStyle()
112 {
113 if (empty($this->style) && empty($this->cssClass) && empty($this->id))
114 {
115 return;
116 }
117
118 if ($this->cssClass == ':swap:')
119 {
120 BSFunctions::swap_css_classes();
121 $class = BSFunctions::$cssClass;
122 }
123 else
124 {
125 $class = $this->cssClass;
126 }
127
128 $attrs = array();
129
130 foreach ($this->style as $prop => $value)
131 {
132 $attrs[] = $prop . ': ' . $value;
133 }
134
135 $style = implode('; ', $attrs);
136
137 $string = '';
138 if ($class)
139 {
140 $string .= ' class="' . $class . '"';
141 }
142 if ($style)
143 {
144 $string .= ' style="' . $style . '"';
145 }
146 if ($this->id)
147 {
148 $string .= ' id="' . $this->id . '"';
149 }
150
151 return $string;
152 }
153 }
154
155 ?>