GravityMedia\Ghostscript\Devices\DistillerParameters\ColorConversionTrait

Complexity

Total Complexity

44

Size/Duplication

Total Lines	439
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

26 Methods

Rating	Name	Duplication	Size	Complexity
	getArgumentValue()	0	1	?
	setArgument()	0	1	?
A	getCalCmykProfile()	0	9	2
A	setCalCmykProfile()	0	6	1
A	getCalGrayProfile()	0	9	2
A	setCalGrayProfile()	0	6	1
A	getCalRgbProfile()	0	9	2
A	setCalRgbProfile()	0	6	1
A	getColorConversionStrategy()	0	9	2
A	setColorConversionStrategy()	0	10	2
A	isConvertCmykImagesToRgb()	0	9	2
A	setConvertCmykImagesToRgb()	0	6	2
A	isConvertImagesToIndexed()	0	9	2
A	setConvertImagesToIndexed()	0	6	2
A	getDefaultRenderingIntent()	0	9	2
A	setDefaultRenderingIntent()	0	10	2
A	getsRgbProfile()	0	9	2
A	setsRgbProfile()	0	6	1
A	isPreserveHalftoneInfo()	0	9	2
A	setPreserveHalftoneInfo()	0	6	2
A	isPreserveOverprintSettings()	0	9	2
A	setPreserveOverprintSettings()	0	6	2
A	getTransferFunctionInfo()	0	9	2
A	setTransferFunctionInfo()	0	10	2
A	getUcrAndBgInfo()	0	9	2
A	setUcrAndBgInfo()	0	10	2

<?php
/**
 * This file is part of the Ghostscript package
 *
 * @author Daniel Schröder <daniel.schroeder@gravitymedia.de>
 */

namespace GravityMedia\Ghostscript\Devices\DistillerParameters;

use GravityMedia\Ghostscript\Devices\DistillerParametersInterface;

/**
 * The color conversion distiller parameters trait
 *
 * @package GravityMedia\Ghostscript\Devices\DistillerParameters
 */
trait ColorConversionTrait
{
    /**
     * Available color conversion strategy values
     *
     * @var string[]
     */
    protected static $colorConversionStrategyValues = [
        DistillerParametersInterface::COLOR_CONVERSION_STRATEGY_LEAVE_COLOR_UNCHANGED,
        DistillerParametersInterface::COLOR_CONVERSION_STRATEGY_USE_DEVICE_INDEPENDENT_COLOR,
        DistillerParametersInterface::COLOR_CONVERSION_STRATEGY_GRAY,
        DistillerParametersInterface::COLOR_CONVERSION_STRATEGY_RGB,
        DistillerParametersInterface::COLOR_CONVERSION_STRATEGY_CMYK
    ];

    /**
     * Available default rendering intent values
     *
     * @var string[]
     */
    protected static $defaultRenderingIntentValues = [
        DistillerParametersInterface::DEFAULT_RENDERING_INTENT_DEFAULT,
        DistillerParametersInterface::DEFAULT_RENDERING_INTENT_PERCEPTUAL,
        DistillerParametersInterface::DEFAULT_RENDERING_INTENT_SATURATION,
        DistillerParametersInterface::DEFAULT_RENDERING_INTENT_RELATIVE_COLORIMETRIC,
        DistillerParametersInterface::DEFAULT_RENDERING_INTENT_ABSOLUTE_COLORIMETRIC
    ];

    /**
     * Available transfer function info values
     *
     * @var string[]
     */
    protected static $transferFunctionInfoValues = [
        DistillerParametersInterface::TRANSFER_FUNCTION_INFO_PRESERVE,
        DistillerParametersInterface::TRANSFER_FUNCTION_INFO_REMOVE,
        DistillerParametersInterface::TRANSFER_FUNCTION_INFO_APPLY
    ];

    /**
     * Available UCR and BG info values
     *
     * @var string[]
     */
    protected static $ucrAndBgInfoValues = [
        DistillerParametersInterface::UCR_AND_BG_INFO_PRESERVE,
        DistillerParametersInterface::UCR_AND_BG_INFO_REMOVE
    ];

    /**
     * Get argument value
     *
     * @param string $name
     *
     * @return string
     */
    abstract protected function getArgumentValue($name);

    /**
     * Set argument
     *
     * @param string $argument
     *
     * @return $this
     */
    abstract protected function setArgument($argument);

    /**
     * Get cal CMYK profile
     *
     * @return null|string
     */
    public function getCalCmykProfile()
    {
        $value = $this->getArgumentValue('-dCalCMYKProfile');
        if (null === $value) {
            return null;
        }

        return substr($value, 1, -1);
    }

    /**
     * Set cal CMYK profile
     *
     * @param string $valCmykProfile
     *
     * @return $this
     */
    public function setCalCmykProfile($valCmykProfile)
    {
        $this->setArgument(sprintf('-dCalCMYKProfile=(%s)', $valCmykProfile));

        return $this;
    }

    /**
     * Get cal gray profile
     *
     * @return null|string
     */
    public function getCalGrayProfile()
    {
        $value = $this->getArgumentValue('-dCalGrayProfile');
        if (null === $value) {
            return null;
        }

        return substr($value, 1, -1);
    }

    /**
     * Set cal gray profile
     *
     * @param string $valGrayProfile
     *
     * @return $this
     */
    public function setCalGrayProfile($valGrayProfile)
    {
        $this->setArgument(sprintf('-dCalGrayProfile=(%s)', $valGrayProfile));

        return $this;
    }

    /**
     * Get cal RGB profile
     *
     * @return null|string
     */
    public function getCalRgbProfile()
    {
        $value = $this->getArgumentValue('-dCalRGBProfile');
        if (null === $value) {
            return null;
        }

        return substr($value, 1, -1);
    }

    /**
     * Set cal RGB profile
     *
     * @param string $valRgbProfile
     *
     * @return $this
     */
    public function setCalRgbProfile($valRgbProfile)
    {
        $this->setArgument(sprintf('-dCalRGBProfile=(%s)', $valRgbProfile));

        return $this;
    }

    /**
     * Get color conversion strategy
     *
     * @return string
     */
    public function getColorConversionStrategy()
    {
        $value = $this->getArgumentValue('-dColorConversionStrategy');
        if (null === $value) {
            return DistillerParametersInterface::COLOR_CONVERSION_STRATEGY_LEAVE_COLOR_UNCHANGED;
        }

        return substr($value, 1);
    }

    /**
     * Set color conversion strategy
     *
     * @param string $colorConversionStrategy
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setColorConversionStrategy($colorConversionStrategy)
    {
        if (!in_array($colorConversionStrategy, static::$colorConversionStrategyValues)) {
            throw new \InvalidArgumentException('Invalid color conversion strategy argument');
        }

        $this->setArgument(sprintf('-dColorConversionStrategy=/%s', $colorConversionStrategy));

        return $this;
    }

    /**
     * Whether to convert CMYK images to RGB
     *
     * @return bool
     */
    public function isConvertCmykImagesToRgb()
    {
        $value = $this->getArgumentValue('-dConvertCMYKImagesToRGB');
        if (null === $value) {
            return false;
        }

        return filter_var($value, FILTER_VALIDATE_BOOLEAN);
    }

    /**
     * Set convert convert CMYK images to RGB flag
     *
     * @param bool $convertCmykImagesToRgb
     *
     * @return $this
     */
    public function setConvertCmykImagesToRgb($convertCmykImagesToRgb)
    {
        $this->setArgument(sprintf('-dConvertCMYKImagesToRGB=%s', $convertCmykImagesToRgb ? 'true' : 'false'));

        return $this;
    }

    /**
     * Whether to convert images to indexed
     *
     * @return bool
     */
    public function isConvertImagesToIndexed()
    {
        $value = $this->getArgumentValue('-dConvertImagesToIndexed');
        if (null === $value) {
            return false;
        }

        return filter_var($value, FILTER_VALIDATE_BOOLEAN);
    }

    /**
     * Set convert images to indexed flag
     *
     * @param bool $convertImagesToIndexed
     *
     * @return $this
     */
    public function setConvertImagesToIndexed($convertImagesToIndexed)
    {
        $this->setArgument(sprintf('-dConvertImagesToIndexed=%s', $convertImagesToIndexed ? 'true' : 'false'));

        return $this;
    }

    /**
     * Get default rendering intent
     *
     * @return string
     */
    public function getDefaultRenderingIntent()
    {
        $value = $this->getArgumentValue('-dDefaultRenderingIntent');
        if (null === $value) {
            return DistillerParametersInterface::DEFAULT_RENDERING_INTENT_DEFAULT;
        }

        return substr($value, 1);
    }

    /**
     * Set default rendering intent
     *
     * @param string $defaultRenderingIntent
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setDefaultRenderingIntent($defaultRenderingIntent)
    {
        if (!in_array($defaultRenderingIntent, static::$defaultRenderingIntentValues)) {
            throw new \InvalidArgumentException('Invalid default rendering intent argument');
        }

        $this->setArgument(sprintf('-dDefaultRenderingIntent=/%s', $defaultRenderingIntent));

        return $this;
    }

    /**
     * Get sRGB profile
     *
     * @return null|string
     */
    public function getsRgbProfile()
    {
        $value = $this->getArgumentValue('-dsRGBProfile');
        if (null === $value) {
            return null;
        }

        return substr($value, 1, -1);
    }

    /**
     * Set sRGB profile
     *
     * @param string $sRgbProfile
     *
     * @return $this
     */
    public function setsRgbProfile($sRgbProfile)
    {
        $this->setArgument(sprintf('-dsRGBProfile=(%s)', $sRgbProfile));

        return $this;
    }

    /**
     * Whether to preserve halftone info
     *
     * @return bool
     */
    public function isPreserveHalftoneInfo()
    {
        $value = $this->getArgumentValue('-dPreserveHalftoneInfo');
        if (null === $value) {
            return false;
        }

        return filter_var($value, FILTER_VALIDATE_BOOLEAN);
    }

    /**
     * Set preserve halftone info flag
     *
     * @param bool $preserveHalftoneInfo
     *
     * @return $this
     */
    public function setPreserveHalftoneInfo($preserveHalftoneInfo)
    {
        $this->setArgument(sprintf('-dPreserveHalftoneInfo=%s', $preserveHalftoneInfo ? 'true' : 'false'));

        return $this;
    }

    /**
     * Whether to preserve overprint settings
     *
     * @return bool
     */
    public function isPreserveOverprintSettings()
    {
        $value = $this->getArgumentValue('-dPreserveOverprintSettings');
        if (null === $value) {
            return false;
        }

        return filter_var($value, FILTER_VALIDATE_BOOLEAN);
    }

    /**
     * Set preserve overprint settings flag
     *
     * @param bool $preserveOverprintSettings
     *
     * @return $this
     */
    public function setPreserveOverprintSettings($preserveOverprintSettings)
    {
        $this->setArgument(sprintf('-dPreserveOverprintSettings=%s', $preserveOverprintSettings ? 'true' : 'false'));

        return $this;
    }

    /**
     * Get transfer function info
     *
     * @return string
     */
    public function getTransferFunctionInfo()
    {
        $value = $this->getArgumentValue('-dTransferFunctionInfo');
        if (null === $value) {
            return DistillerParametersInterface::DEFAULT_RENDERING_INTENT_DEFAULT;
        }

        return substr($value, 1);
    }

    /**
     * Set transfer function info
     *
     * @param string $transferFunctionInfo
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setTransferFunctionInfo($transferFunctionInfo)
    {
        if (!in_array($transferFunctionInfo, static::$transferFunctionInfoValues)) {
            throw new \InvalidArgumentException('Invalid transfer function info argument');
        }

        $this->setArgument(sprintf('-dTransferFunctionInfo=/%s', $transferFunctionInfo));

        return $this;
    }

    /**
     * Get UCR and BG info
     *
     * @return string
     */
    public function getUcrAndBgInfo()
    {
        $value = $this->getArgumentValue('-dUCRandBGInfo');
        if (null === $value) {
            return DistillerParametersInterface::UCR_AND_BG_INFO_REMOVE;
        }

        return substr($value, 1);
    }

    /**
     * Set UCR and BG info
     *
     * @param string $ucrAndBgInfo
     *
     * @throws \InvalidArgumentException
     *
     * @return $this
     */
    public function setUcrAndBgInfo($ucrAndBgInfo)
    {
        if (!in_array($ucrAndBgInfo, static::$ucrAndBgInfoValues)) {
            throw new \InvalidArgumentException('Invalid UCR and BG info argument');
        }

        $this->setArgument(sprintf('-dUCRandBGInfo=/%s', $ucrAndBgInfo));

        return $this;
    }
}