3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for deleting things
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Zach Copley <zach@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 // XXX: Maybe make getters and setters for r,g,b values and tuples,
36 // e.g.: to support this kinda CSS representation: rgb(255,0,0)
37 // http://www.w3.org/TR/CSS21/syndata.html#color-units
48 function __construct($color = null)
51 $this->parseColor($color);
56 * Parses input to and tries to determine whether the color
57 * is being specified via an integer or hex tuple and sets
58 * the RGB instance variables accordingly.
60 * XXX: Maybe support (r,g,b) style, and array?
66 function parseColor($color) {
68 if (is_numeric($color)) {
69 $this->setIntColor($color);
74 // XXX: probably should do even more validation
76 if (preg_match('/(#([0-9A-Fa-f]{3,6})\b)/u', $color) > 0) {
77 $this->setHexColor($color);
79 // TRANS: Web color exception thrown when a hexadecimal color code does not validate.
80 // TRANS: %s is the provided (invalid) color code.
81 $errmsg = _('%s is not a valid color! Use 3 or 6 hex characters.');
82 throw new WebColorException(sprintf($errmsg, $color));
92 function setNamedColor($name)
98 * Sets the RGB color values from a a hex tuple
100 * @param string $hexcolor
104 function setHexColor($hexcolor) {
106 if ($hexcolor[0] == '#') {
107 $hexcolor = substr($hexcolor, 1);
110 if (strlen($hexcolor) == 6) {
111 list($r, $g, $b) = array($hexcolor[0].$hexcolor[1],
112 $hexcolor[2].$hexcolor[3],
113 $hexcolor[4].$hexcolor[5]);
114 } elseif (strlen($hexcolor) == 3) {
115 list($r, $g, $b) = array($hexcolor[0].$hexcolor[0],
116 $hexcolor[1].$hexcolor[1],
117 $hexcolor[2].$hexcolor[2]);
119 // TRANS: Web color exception thrown when a hexadecimal color code does not validate.
120 // TRANS: %s is the provided (invalid) color code.
121 $errmsg = _('%s is not a valid color! Use 3 or 6 hex characters.');
122 throw new WebColorException(sprintf($errmsg, $hexcolor));
125 $this->red = hexdec($r);
126 $this->green = hexdec($g);
127 $this->blue = hexdec($b);
132 * Sets the RGB color values from a 24-bit integer
134 * @param int $intcolor
138 function setIntColor($intcolor)
140 // We could do 32 bit and have an alpha channel because
141 // Sarven wants one real bad, but nah.
143 $this->red = $intcolor >> 16;
144 $this->green = $intcolor >> 8 & 0xFF;
145 $this->blue = $intcolor & 0xFF;
150 * Returns a hex tuple of the RGB color useful for output in HTML
154 function hexValue() {
156 $hexcolor = (strlen(dechex($this->red)) < 2 ? '0' : '' ) .
158 $hexcolor .= (strlen(dechex($this->green)) < 2 ? '0' : '') .
159 dechex($this->green);
160 $hexcolor .= (strlen(dechex($this->blue)) < 2 ? '0' : '') .
163 return strtoupper($hexcolor);
167 * Returns a 24-bit packed integer representation of the RGB color
168 * for convenient storage in the DB
170 * XXX: probably could just use hexdec() instead
176 $intcolor = 256 * 256 * $this->red + 256 * $this->green + $this->blue;
182 class WebColorException extends Exception