324 lines
		
	
	
		
			6.2 KiB
		
	
	
	
		
			PHP
		
	
	
			
		
		
	
	
			324 lines
		
	
	
		
			6.2 KiB
		
	
	
	
		
			PHP
		
	
	
<?php
 | 
						|
 | 
						|
namespace PhpOffice\PhpSpreadsheet\Style;
 | 
						|
 | 
						|
use PhpOffice\PhpSpreadsheet\IComparable;
 | 
						|
use PhpOffice\PhpSpreadsheet\Style\ConditionalFormatting\ConditionalDataBar;
 | 
						|
 | 
						|
class Conditional implements IComparable
 | 
						|
{
 | 
						|
    // Condition types
 | 
						|
    const CONDITION_NONE = 'none';
 | 
						|
    const CONDITION_CELLIS = 'cellIs';
 | 
						|
    const CONDITION_CONTAINSTEXT = 'containsText';
 | 
						|
    const CONDITION_EXPRESSION = 'expression';
 | 
						|
    const CONDITION_CONTAINSBLANKS = 'containsBlanks';
 | 
						|
    const CONDITION_NOTCONTAINSBLANKS = 'notContainsBlanks';
 | 
						|
    const CONDITION_DATABAR = 'dataBar';
 | 
						|
    const CONDITION_NOTCONTAINSTEXT = 'notContainsText';
 | 
						|
 | 
						|
    private const CONDITION_TYPES = [
 | 
						|
        self::CONDITION_CELLIS,
 | 
						|
        self::CONDITION_CONTAINSBLANKS,
 | 
						|
        self::CONDITION_CONTAINSTEXT,
 | 
						|
        self::CONDITION_DATABAR,
 | 
						|
        self::CONDITION_EXPRESSION,
 | 
						|
        self::CONDITION_NONE,
 | 
						|
        self::CONDITION_NOTCONTAINSBLANKS,
 | 
						|
        self::CONDITION_NOTCONTAINSTEXT,
 | 
						|
    ];
 | 
						|
 | 
						|
    // Operator types
 | 
						|
    const OPERATOR_NONE = '';
 | 
						|
    const OPERATOR_BEGINSWITH = 'beginsWith';
 | 
						|
    const OPERATOR_ENDSWITH = 'endsWith';
 | 
						|
    const OPERATOR_EQUAL = 'equal';
 | 
						|
    const OPERATOR_GREATERTHAN = 'greaterThan';
 | 
						|
    const OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual';
 | 
						|
    const OPERATOR_LESSTHAN = 'lessThan';
 | 
						|
    const OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual';
 | 
						|
    const OPERATOR_NOTEQUAL = 'notEqual';
 | 
						|
    const OPERATOR_CONTAINSTEXT = 'containsText';
 | 
						|
    const OPERATOR_NOTCONTAINS = 'notContains';
 | 
						|
    const OPERATOR_BETWEEN = 'between';
 | 
						|
    const OPERATOR_NOTBETWEEN = 'notBetween';
 | 
						|
 | 
						|
    /**
 | 
						|
     * Condition type.
 | 
						|
     *
 | 
						|
     * @var string
 | 
						|
     */
 | 
						|
    private $conditionType = self::CONDITION_NONE;
 | 
						|
 | 
						|
    /**
 | 
						|
     * Operator type.
 | 
						|
     *
 | 
						|
     * @var string
 | 
						|
     */
 | 
						|
    private $operatorType = self::OPERATOR_NONE;
 | 
						|
 | 
						|
    /**
 | 
						|
     * Text.
 | 
						|
     *
 | 
						|
     * @var string
 | 
						|
     */
 | 
						|
    private $text;
 | 
						|
 | 
						|
    /**
 | 
						|
     * Stop on this condition, if it matches.
 | 
						|
     *
 | 
						|
     * @var bool
 | 
						|
     */
 | 
						|
    private $stopIfTrue = false;
 | 
						|
 | 
						|
    /**
 | 
						|
     * Condition.
 | 
						|
     *
 | 
						|
     * @var string[]
 | 
						|
     */
 | 
						|
    private $condition = [];
 | 
						|
 | 
						|
    /**
 | 
						|
     * @var ConditionalDataBar
 | 
						|
     */
 | 
						|
    private $dataBar;
 | 
						|
 | 
						|
    /**
 | 
						|
     * Style.
 | 
						|
     *
 | 
						|
     * @var Style
 | 
						|
     */
 | 
						|
    private $style;
 | 
						|
 | 
						|
    /**
 | 
						|
     * Create a new Conditional.
 | 
						|
     */
 | 
						|
    public function __construct()
 | 
						|
    {
 | 
						|
        // Initialise values
 | 
						|
        $this->style = new Style(false, true);
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Get Condition type.
 | 
						|
     *
 | 
						|
     * @return string
 | 
						|
     */
 | 
						|
    public function getConditionType()
 | 
						|
    {
 | 
						|
        return $this->conditionType;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Set Condition type.
 | 
						|
     *
 | 
						|
     * @param string $type Condition type, see self::CONDITION_*
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function setConditionType($type)
 | 
						|
    {
 | 
						|
        $this->conditionType = $type;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Get Operator type.
 | 
						|
     *
 | 
						|
     * @return string
 | 
						|
     */
 | 
						|
    public function getOperatorType()
 | 
						|
    {
 | 
						|
        return $this->operatorType;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Set Operator type.
 | 
						|
     *
 | 
						|
     * @param string $type Conditional operator type, see self::OPERATOR_*
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function setOperatorType($type)
 | 
						|
    {
 | 
						|
        $this->operatorType = $type;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Get text.
 | 
						|
     *
 | 
						|
     * @return string
 | 
						|
     */
 | 
						|
    public function getText()
 | 
						|
    {
 | 
						|
        return $this->text;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Set text.
 | 
						|
     *
 | 
						|
     * @param string $text
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function setText($text)
 | 
						|
    {
 | 
						|
        $this->text = $text;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Get StopIfTrue.
 | 
						|
     *
 | 
						|
     * @return bool
 | 
						|
     */
 | 
						|
    public function getStopIfTrue()
 | 
						|
    {
 | 
						|
        return $this->stopIfTrue;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Set StopIfTrue.
 | 
						|
     *
 | 
						|
     * @param bool $stopIfTrue
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function setStopIfTrue($stopIfTrue)
 | 
						|
    {
 | 
						|
        $this->stopIfTrue = $stopIfTrue;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Get Conditions.
 | 
						|
     *
 | 
						|
     * @return string[]
 | 
						|
     */
 | 
						|
    public function getConditions()
 | 
						|
    {
 | 
						|
        return $this->condition;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Set Conditions.
 | 
						|
     *
 | 
						|
     * @param bool|float|int|string|string[] $conditions Condition
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function setConditions($conditions)
 | 
						|
    {
 | 
						|
        if (!is_array($conditions)) {
 | 
						|
            $conditions = [$conditions];
 | 
						|
        }
 | 
						|
        $this->condition = $conditions;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Add Condition.
 | 
						|
     *
 | 
						|
     * @param string $condition Condition
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function addCondition($condition)
 | 
						|
    {
 | 
						|
        $this->condition[] = $condition;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Get Style.
 | 
						|
     *
 | 
						|
     * @return Style
 | 
						|
     */
 | 
						|
    public function getStyle()
 | 
						|
    {
 | 
						|
        return $this->style;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Set Style.
 | 
						|
     *
 | 
						|
     * @param Style $style
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function setStyle(?Style $style = null)
 | 
						|
    {
 | 
						|
        $this->style = $style;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * get DataBar.
 | 
						|
     *
 | 
						|
     * @return null|ConditionalDataBar
 | 
						|
     */
 | 
						|
    public function getDataBar()
 | 
						|
    {
 | 
						|
        return $this->dataBar;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * set DataBar.
 | 
						|
     *
 | 
						|
     * @return $this
 | 
						|
     */
 | 
						|
    public function setDataBar(ConditionalDataBar $dataBar)
 | 
						|
    {
 | 
						|
        $this->dataBar = $dataBar;
 | 
						|
 | 
						|
        return $this;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Get hash code.
 | 
						|
     *
 | 
						|
     * @return string Hash code
 | 
						|
     */
 | 
						|
    public function getHashCode()
 | 
						|
    {
 | 
						|
        return md5(
 | 
						|
            $this->conditionType .
 | 
						|
            $this->operatorType .
 | 
						|
            implode(';', $this->condition) .
 | 
						|
            $this->style->getHashCode() .
 | 
						|
            __CLASS__
 | 
						|
        );
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Implement PHP __clone to create a deep clone, not just a shallow copy.
 | 
						|
     */
 | 
						|
    public function __clone()
 | 
						|
    {
 | 
						|
        $vars = get_object_vars($this);
 | 
						|
        foreach ($vars as $key => $value) {
 | 
						|
            if (is_object($value)) {
 | 
						|
                $this->$key = clone $value;
 | 
						|
            } else {
 | 
						|
                $this->$key = $value;
 | 
						|
            }
 | 
						|
        }
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Verify if param is valid condition type.
 | 
						|
     */
 | 
						|
    public static function isValidConditionType(string $type): bool
 | 
						|
    {
 | 
						|
        return in_array($type, self::CONDITION_TYPES);
 | 
						|
    }
 | 
						|
}
 |