Same name and namespace in other branches
  1. 8.x-2.x src/ColorCMY.php \Drupal\color_field\ColorCMY 1 comment

ColorCMY represents the CMY color format.

Hierarchy

Expanded class hierarchy of ColorCMY

File

src/ColorCMY.php, line 10

Namespace

Drupal\color_field
View source 
class ColorCMY extends ColorBase {
    
    /**
     * The cyan.
     *
     * @var int
     */
    protected int $cyan;
    
    /**
     * The magenta.
     *
     * @var int
     */
    protected int $magenta;
    
    /**
     * The yellow.
     *
     * @var int
     */
    protected int $yellow;
    
    /**
     * Create a new CMYK color.
     *
     * @param int $cyan
     *   The cyan.
     * @param int $magenta
     *   The magenta.
     * @param int $yellow
     *   The yellow.
     * @param float $opacity
     *   The opacity.
     */
    public function __construct(int $cyan, int $magenta, int $yellow, float $opacity) {
        $this->cyan = $cyan;
        $this->magenta = $magenta;
        $this->yellow = $yellow;
        $this->opacity = $opacity;
    }
    
    /**
     * Get the amount of Cyan.
     *
     * @return int
     *   The amount of cyan.
     */
    public function getCyan() : int {
        return $this->cyan;
    }
    
    /**
     * Get the amount of Magenta.
     *
     * @return int
     *   The amount of magenta.
     */
    public function getMagenta() : int {
        return $this->magenta;
    }
    
    /**
     * Get the amount of Yellow.
     *
     * @return int
     *   The amount of yellow.
     */
    public function getYellow() : int {
        return $this->yellow;
    }
    
    /**
     * A string representation of this color in the current format.
     *
     * @param bool $opacity
     *   Whether to display the opacity.
     *
     * @return string
     *   The color in format: #RRGGBB.
     */
    public function toString(bool $opacity = TRUE) : string {
        return $this->toHex()
            ->toString($opacity);
    }
    
    /**
     * {@inheritdoc}
     */
    public function toHex() : ColorHex {
        return $this->toRgb()
            ->toHex();
    }
    
    /**
     * {@inheritdoc}
     */
    public function toRgb() : ColorRGB {
        $red = (1 - $this->cyan) * 255;
        $green = (1 - $this->magenta) * 255;
        $blue = (1 - $this->yellow) * 255;
        return new ColorRGB($red, $green, $blue, $this->getOpacity());
    }
    
    /**
     * {@inheritdoc}
     */
    public function toCmyk() : ColorCMYK {
        $key = min($this->getCyan(), $this->getMagenta(), $this->getYellow());
        $cyan = $this->cyan * (1 - $key) + $key;
        $magenta = $this->magenta * (1 - $key) + $key;
        $yellow = $this->yellow * (1 - $key) + $key;
        return new ColorCMYK($cyan, $magenta, $yellow, $key, $this->getOpacity());
    }
    
    /**
     * {@inheritdoc}
     */
    public function toHsl() : ColorHSL {
        return $this->toRgb()
            ->toHsl();
    }

}

Members

Title Modifiers Object type Summary Overriden Title 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.
ColorCMY::$cyan protected property The cyan.
ColorCMY::$magenta protected property The magenta.
ColorCMY::$yellow protected property The yellow.
ColorCMY::getCyan public function Get the amount of Cyan.
ColorCMY::getMagenta public function Get the amount of Magenta.
ColorCMY::getYellow public function Get the amount of Yellow.
ColorCMY::toCmyk public function
ColorCMY::toHex public function Get the color as a hex instance. Overrides ColorInterface::toHex
ColorCMY::toHsl public function Get the color as an HSL instance. Overrides ColorInterface::toHsl 1
ColorCMY::toRgb public function Get the color as an RGB instance. Overrides ColorInterface::toRgb 1
ColorCMY::toString public function A string representation of this color in the current format. Overrides ColorInterface::toString
ColorCMY::__construct public function Create a new CMYK color. 1