class ColorRGB in Color Field 8.2

RGB represents the RGB color format.

Hierarchy

• class \Drupal\color_field\ColorBase implements ColorInterface
  • class \Drupal\color_field\ColorRGB

File

src/ColorRGB.php, line 8

Namespace

Drupal\color_field

class ColorRGB extends ColorBase {

  /**
   * The red value (0-255).
   *
   * @var float
   */
  private $red;

  /**
   * The green value (0-255).
   *
   * @var float
   */
  private $green;

  /**
   * The blue value (0-255).
   *
   * @var float
   */
  private $blue;

  /**
   * Create a new RGB color.
   *
   * @param int $red
   *   The red (0-255)
   * @param int $green
   *   The green (0-255)
   * @param int $blue
   *   The blue (0-255)
   * @param float $opacity
   *   The opacity.
   *
   * @throws Exception
   */
  public function __construct($red, $green, $blue, $opacity) {
    if ($red < 0 || $red > 255) {

      // @throws exception.
    }
    if ($green < 0 || $green > 255) {

      // @throws exception.
    }
    if ($blue < 0 || $blue > 255) {

      // @throws exception.
    }
    $this->red = $red;
    $this->green = $green;
    $this->blue = $blue;
    $this->opacity = floatval($opacity);
  }

  /**
   * Get the red value (rounded).
   *
   * @return int
   *   The red value
   */
  public function getRed() {
    return 0.5 + $this->red | 0;
  }

  /**
   * Get the green value (rounded).
   *
   * @return int
   *   The green value
   */
  public function getGreen() {
    return 0.5 + $this->green | 0;
  }

  /**
   * Get the blue value (rounded).
   *
   * @return int
   *   The blue value
   */
  public function getBlue() {
    return 0.5 + $this->blue | 0;
  }

  /**
   * A string representation of this color in the current format.
   *
   * @param bool $opacity
   *   Whether or not to display the opacity.
   *
   * @return string
   *   The color in format: #RRGGBB
   */
  public function toString($opacity = TRUE) {
    if ($opacity) {
      $output = 'rgba(' . $this
        ->getRed() . ',' . $this
        ->getGreen() . ',' . $this
        ->getBlue() . ',' . $this
        ->getOpacity() . ')';
    }
    else {
      $output = 'rgb(' . $this
        ->getRed() . ',' . $this
        ->getGreen() . ',' . $this
        ->getBlue() . ')';
    }
    return strtolower($output);
  }

  /**
   * {@inheritdoc}
   */
  public function toHex() {
    return new ColorHex($this
      ->getRed() << 16 | $this
      ->getGreen() << 8 | $this
      ->getBlue(), $this
      ->getOpacity());
  }

  /**
   * {@inheritdoc}
   */
  public function toRgb() {
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function toHsl() {
    $r = $this
      ->getRed() / 255;
    $g = $this
      ->getGreen() / 255;
    $b = $this
      ->getBlue() / 255;
    $max = max($r, $g, $b);
    $min = min($r, $g, $b);
    $l = ($max + $min) / 2;
    if ($max == $min) {

      // Achromatic.
      $h = $s = 0;
    }
    else {
      $d = $max - $min;
      $s = $l > 0.5 ? $d / (2 - $max - $min) : $d / ($max + $min);
      switch ($max) {
        case $r:
          $h = ($g - $b) / $d + ($g < $b ? 6 : 0);
          break;
        case $g:
          $h = ($b - $r) / $d + 2;
          break;
        case $b:
          $h = ($r - $g) / $d + 4;
          break;
      }
      $h /= 6;
    }
    $h = floor($h * 360);
    $s = floor($s * 100);
    $l = floor($l * 100);
    return new ColorHSL(intval($h), intval($s), intval($l), $this
      ->getOpacity());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ColorBase::$namedColors	public static	property	Named HTML colors.
ColorBase::$opacity	protected	property	The opacity of the color.
ColorBase::$patterns	public static	property	Regexes to match various color formats.
ColorBase::getOpacity	public	function	Get the opacity.
ColorBase::setOpacity	public	function	Set the opacity.
ColorRGB::$blue	private	property	The blue value (0-255).
ColorRGB::$green	private	property	The green value (0-255).
ColorRGB::$red	private	property	The red value (0-255).
ColorRGB::getBlue	public	function	Get the blue value (rounded).
ColorRGB::getGreen	public	function	Get the green value (rounded).
ColorRGB::getRed	public	function	Get the red value (rounded).
ColorRGB::toHex	public	function	Get the color as a hex instance. Overrides ColorInterface::toHex
ColorRGB::toHsl	public	function	Get the color as a HSL instance. Overrides ColorInterface::toHsl
ColorRGB::toRgb	public	function	Get the color as a RGB instance. Overrides ColorInterface::toRgb
ColorRGB::toString	public	function	A string representation of this color in the current format. Overrides ColorInterface::toString
ColorRGB::__construct	public	function	Create a new RGB color.