Start providing a fluent interface for the printer stuff. All printer elemnets now...
[isso.git] / PrinterElement.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 (PrinterElement.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 BSPrinterElement
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 * Fluent object instantiation
55 */
56 public abstract static function make();
57
58 /**
59 * Tells the element to paint itself (and any children)
60 */
61 public abstract function paint();
62
63 // ###################################################################
64 /**
65 * Sets the CSS class to use. Use ":swap:" to alternate
66 *
67 * @param string CSS class
68 */
69 public function setCssClass($class)
70 {
71 $this->cssClass = $class;
72 }
73
74 // ###################################################################
75 /**
76 * Sets the style information
77 */
78 public function setStyle(Array $attributes)
79 {
80 $this->style = $attributes;
81 }
82
83 // ###################################################################
84 /**
85 * Returns a string of CSS style attributes
86 *
87 * @return string CSS attributes
88 */
89 protected function _prepareStyle()
90 {
91 if (empty($this->style) AND empty($this->cssClass))
92 {
93 return;
94 }
95
96 if ($this->cssClass == ':swap:')
97 {
98 BSFunctions::SwapCssClasses();
99 $class = BSFunctions::$cssClass;
100 }
101 else
102 {
103 $class = $this->cssClass;
104 }
105
106 $attrs = array();
107
108 foreach ($this->style AS $prop => $value)
109 {
110 $attrs[] = $prop . ': ' . $value;
111 }
112
113 $style = implode('; ', $attrs);
114
115 $string = '';
116 if ($class)
117 {
118 $string .= ' class="' . $class . '"';
119 }
120 if ($style)
121 {
122 $string .= ' style="' . $style . '"';
123 }
124
125 return $string;
126 }
127 }
128
129 ?>