<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 5 |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019 |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM. |
- | |
- | CiviCRM is free software; you can copy, modify, and distribute it |
- | under the terms of the GNU Affero General Public License |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
- | |
- | CiviCRM is distributed in the hope that it will be useful, but |
- | WITHOUT ANY WARRANTY; without even the implied warranty of |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
- | See the GNU Affero General Public License for more details. |
+ | Copyright CiviCRM LLC. All rights reserved. |
| |
- | You should have received a copy of the GNU Affero General Public |
- | License and the CiviCRM Licensing Exception along |
- | with this program; if not, contact CiviCRM LLC |
- | at info[AT]civicrm[DOT]org. If you have questions about the |
- | GNU Affero General Public License or the licensing of CiviCRM, |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2019
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
*/
/**
*/
class CRM_Utils_Color {
+ const COLOR_FILE = '[civicrm.root]/bower_components/css-color-names/css-color-names.json';
+
/**
* Determine the appropriate text color for a given background.
*
* Based on YIQ value.
*
- * @param string $hexcolor
+ * @param string $color
* @param string $black
* @param string $white
* @return string
*/
- public static function getContrast($hexcolor, $black = 'black', $white = 'white') {
- list($r, $g, $b) = self::getRgb($hexcolor);
+ public static function getContrast($color, $black = 'black', $white = 'white') {
+ list($r, $g, $b) = self::getRgb($color);
$yiq = (($r * 299) + ($g * 587) + ($b * 114)) / 1000;
return ($yiq >= 128) ? $black : $white;
}
/**
- * Convert hex color to decimal
+ * Parse any color string into rgb decimal values
+ *
+ * Accepted formats:
+ * Full hex: "#ffffff"
+ * Short hex: "#fff"
+ * Color name "white"
+ * RGB notation: "rgb(255, 255, 255)"
*
- * @param string $hexcolor
- * @return array
+ * @param string $color
+ * @return int[]|null
* [red, green, blue]
*/
- public static function getRgb($hexcolor) {
- $hexcolor = trim($hexcolor, ' #');
- if (strlen($hexcolor) === 3) {
- $hexcolor = $hexcolor[0] . $hexcolor[0] . $hexcolor[1] . $hexcolor[1] . $hexcolor[2] . $hexcolor[2];
+ public static function getRgb($color) {
+ $color = str_replace(' ', '', $color);
+ $color = self::nameToHex($color) ?? $color;
+ if (strpos($color, 'rgb(') === 0) {
+ return explode(',', substr($color, 4, strpos($color, ')') - 4));
+ }
+ $color = ltrim($color, '#');
+ if (strlen($color) === 3) {
+ $color = $color[0] . $color[0] . $color[1] . $color[1] . $color[2] . $color[2];
+ }
+ if (!CRM_Utils_Rule::color('#' . $color)) {
+ return NULL;
}
return [
- hexdec(substr($hexcolor, 0, 2)),
- hexdec(substr($hexcolor, 2, 2)),
- hexdec(substr($hexcolor, 4, 2)),
+ hexdec(substr($color, 0, 2)),
+ hexdec(substr($color, 2, 2)),
+ hexdec(substr($color, 4, 2)),
];
}
/**
* Calculate a highlight color from a base color
*
- * @param $hexcolor
+ * @param $color
* @return string
*/
- public static function getHighlight($hexcolor) {
- $rgb = CRM_Utils_Color::getRgb($hexcolor);
+ public static function getHighlight($color) {
+ $rgb = self::getRgb($color);
$avg = array_sum($rgb) / 3;
foreach ($rgb as &$v) {
if ($avg > 242) {
$v = min(255, intval((-.0035 * ($v - 242) ** 2) + 260));
}
}
- return '#' . implode(array_map('dechex', $rgb));
+ return self::rgbToHex($rgb);
+ }
+
+ /**
+ * Convert named color (e.g. springgreen) to hex
+ *
+ * @param $colorName
+ * @return string|null
+ */
+ public static function nameToHex($colorName) {
+ if (strpos($colorName, '#') !== FALSE || strpos($colorName, '(') !== FALSE) {
+ return NULL;
+ }
+ if (empty(Civi::$statics[__CLASS__]['names'])) {
+ Civi::$statics[__CLASS__]['names'] = json_decode(file_get_contents(Civi::paths()->getPath(self::COLOR_FILE)), TRUE);
+ }
+ return Civi::$statics[__CLASS__]['names'][strtolower($colorName)] ?? NULL;
+ }
+
+ /**
+ * Converts rgb array to hex string
+ *
+ * @param int[] $rgb
+ * @return string
+ */
+ public static function rgbToHex($rgb) {
+ $ret = '#';
+ foreach ($rgb as $dec) {
+ $ret .= str_pad(dechex($dec), 2, '0', STR_PAD_LEFT);
+ }
+ return $ret;
+ }
+
+ /**
+ * Validate color input and convert it to standard hex notation
+ *
+ * @param string $color
+ * @return bool
+ */
+ public static function normalize(&$color) {
+ $rgb = self::getRgb($color);
+ if ($rgb) {
+ $color = self::rgbToHex($rgb);
+ return TRUE;
+ }
+ return FALSE;
}
}
projects / civicrm-core.git / blobdiff