Inheritance diagram for PhpOffice\PhpSpreadsheet\Style\Conditional:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Style\Conditional:

Public Member Functions
	__construct ()
	Create a new Conditional. More...

	getConditionType ()
	Get Condition type. More...

	setConditionType ($pValue)
	Set Condition type. More...

	getOperatorType ()
	Get Operator type. More...

	setOperatorType ($pValue)
	Set Operator type. More...

	getText ()
	Get text. More...

	setText ($value)
	Set text. More...

	getStopIfTrue ()
	Get StopIfTrue. More...

	setStopIfTrue ($value)
	Set StopIfTrue. More...

	getConditions ()
	Get Conditions. More...

	setConditions ($pValue)
	Set Conditions. More...

	addCondition ($pValue)
	Add Condition. More...

	getStyle ()
	Get Style. More...

	setStyle (?Style $pValue=null)
	Set Style. More...

	getDataBar ()
	get DataBar. More...

	setDataBar (ConditionalDataBar $dataBar)
	set DataBar. More...

	getHashCode ()
	Get hash code. More...

	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

Static Public Member Functions
static	isValidConditionType (string $type)
	Verify if param is valid condition type. More...

Data Fields
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'

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'

Private Attributes
const	CONDITION_TYPES

	$conditionType = self::CONDITION_NONE

	$operatorType = self::OPERATOR_NONE

	$text

	$stopIfTrue = false

	$condition = []

	$dataBar

	$style

Detailed Description

Definition at line 8 of file Conditional.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Style\Conditional::__construct ( )

Create a new Conditional.

Definition at line 96 of file Conditional.php.

     {
         // Initialise values
         $this->style = new Style(false, true);
     }

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Style\Conditional::__clone ( )

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 304 of file Conditional.php.

References $key.

     {
         $vars = get_object_vars($this);
         foreach ($vars as $key => $value) {
             if (is_object($value)) {
                 $this->$key = clone $value;
             } else {
                 $this->$key = $value;
             }
         }
     }

◆ addCondition()

PhpOffice\PhpSpreadsheet\Style\Conditional::addCondition ( $pValue )

Add Condition.

Parameters

string $pValue Condition

Returns: $this

Definition at line 232 of file Conditional.php.

     {
         $this->condition[] = $pValue;
 
         return $this;
     }

◆ getConditions()

PhpOffice\PhpSpreadsheet\Style\Conditional::getConditions ( )

Get Conditions.

Returns: string[]

Definition at line 203 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$condition.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

     {
         return $this->condition;
     }

Here is the caller graph for this function:

◆ getConditionType()

PhpOffice\PhpSpreadsheet\Style\Conditional::getConditionType ( )

Get Condition type.

Returns: string

Definition at line 107 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$conditionType.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

     {
         return $this->conditionType;
     }

Here is the caller graph for this function:

◆ getDataBar()

PhpOffice\PhpSpreadsheet\Style\Conditional::getDataBar ( )

get DataBar.

Returns: ConditionalDataBar | null

Definition at line 268 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$dataBar.

     {
         return $this->dataBar;
     }

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Style\Conditional::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PhpOffice\PhpSpreadsheet\IComparable.

Definition at line 290 of file Conditional.php.

     {
         return md5(
             $this->conditionType .
             $this->operatorType .
             implode(';', $this->condition) .
             $this->style->getHashCode() .
             __CLASS__
         );
     }

◆ getOperatorType()

PhpOffice\PhpSpreadsheet\Style\Conditional::getOperatorType ( )

Get Operator type.

Returns: string

Definition at line 131 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$operatorType.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

     {
         return $this->operatorType;
     }

Here is the caller graph for this function:

◆ getStopIfTrue()

PhpOffice\PhpSpreadsheet\Style\Conditional::getStopIfTrue ( )

Get StopIfTrue.

Returns: bool

Definition at line 179 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$stopIfTrue.

     {
         return $this->stopIfTrue;
     }

◆ getStyle()

PhpOffice\PhpSpreadsheet\Style\Conditional::getStyle ( )

Get Style.

Returns: Style

Definition at line 244 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$style.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\getDataBlockProtection(), and PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

     {
         return $this->style;
     }

Here is the caller graph for this function:

◆ getText()

PhpOffice\PhpSpreadsheet\Style\Conditional::getText ( )

Get text.

Returns: string

Definition at line 155 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$text.

     {
         return $this->text;
     }

◆ isValidConditionType()

static PhpOffice\PhpSpreadsheet\Style\Conditional::isValidConditionType ( string $type )

static

Verify if param is valid condition type.

Definition at line 319 of file Conditional.php.

                                                              : bool
     {
         return in_array($type, self::CONDITION_TYPES);
     }

◆ setConditions()

PhpOffice\PhpSpreadsheet\Style\Conditional::setConditions ( $pValue )

Set Conditions.

Parameters

bool|float|int|string|string[] $pValue Condition

Returns: $this

Definition at line 215 of file Conditional.php.

     {
         if (!is_array($pValue)) {
             $pValue = [$pValue];
         }
         $this->condition = $pValue;
 
         return $this;
     }

◆ setConditionType()

PhpOffice\PhpSpreadsheet\Style\Conditional::setConditionType ( $pValue )

Set Condition type.

Parameters

string $pValue Condition type, see self::CONDITION_*

Returns: $this

Definition at line 119 of file Conditional.php.

     {
         $this->conditionType = $pValue;
 
         return $this;
     }

◆ setDataBar()

PhpOffice\PhpSpreadsheet\Style\Conditional::setDataBar ( ConditionalDataBar $dataBar )

set DataBar.

Returns: $this

Definition at line 278 of file Conditional.php.

References PhpOffice\PhpSpreadsheet\Style\Conditional\$dataBar.

     {
         $this->dataBar = $dataBar;
 
         return $this;
     }

◆ setOperatorType()

PhpOffice\PhpSpreadsheet\Style\Conditional::setOperatorType ( $pValue )

Set Operator type.

Parameters

string $pValue Conditional operator type, see self::OPERATOR_*

Returns: $this

Definition at line 143 of file Conditional.php.

     {
         $this->operatorType = $pValue;
 
         return $this;
     }

◆ setStopIfTrue()

PhpOffice\PhpSpreadsheet\Style\Conditional::setStopIfTrue ( $value )

Set StopIfTrue.

Parameters

bool $value

Returns: $this

Definition at line 191 of file Conditional.php.

     {
         $this->stopIfTrue = $value;
 
         return $this;
     }

◆ setStyle()

PhpOffice\PhpSpreadsheet\Style\Conditional::setStyle ( ?Style $pValue = null )

Set Style.

Parameters

Style $pValue

Returns: $this

Definition at line 256 of file Conditional.php.

     {
         $this->style = $pValue;
 
         return $this;
     }

◆ setText()

PhpOffice\PhpSpreadsheet\Style\Conditional::setText ( $value )

Set text.

Parameters

string $value

Returns: $this

Definition at line 167 of file Conditional.php.

     {
         $this->text = $value;
 
         return $this;
     }

Field Documentation

◆ $condition

PhpOffice\PhpSpreadsheet\Style\Conditional::$condition = []

private

Definition at line 79 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Conditional\getConditions().

◆ $conditionType

PhpOffice\PhpSpreadsheet\Style\Conditional::$conditionType = self::CONDITION_NONE

private

Definition at line 51 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Conditional\getConditionType().

◆ $dataBar

PhpOffice\PhpSpreadsheet\Style\Conditional::$dataBar

private

Definition at line 84 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Conditional\getDataBar(), and PhpOffice\PhpSpreadsheet\Style\Conditional\setDataBar().

◆ $operatorType

PhpOffice\PhpSpreadsheet\Style\Conditional::$operatorType = self::OPERATOR_NONE

private

Definition at line 58 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Conditional\getOperatorType().

◆ $stopIfTrue

PhpOffice\PhpSpreadsheet\Style\Conditional::$stopIfTrue = false

private

Definition at line 72 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Conditional\getStopIfTrue().

◆ $style

PhpOffice\PhpSpreadsheet\Style\Conditional::$style

private

Definition at line 91 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Conditional\getStyle().

◆ $text

PhpOffice\PhpSpreadsheet\Style\Conditional::$text

private

Definition at line 65 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\Conditional\getText().

◆ CONDITION_CELLIS

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_CELLIS = 'cellIs'

Definition at line 12 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\__construct(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFHeader(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule(), PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeConditionalFormatting(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeOtherCondElements().

◆ CONDITION_CONTAINSBLANKS

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_CONTAINSBLANKS = 'containsBlanks'

Definition at line 15 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeOtherCondElements().

◆ CONDITION_CONTAINSTEXT

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_CONTAINSTEXT = 'containsText'

Definition at line 13 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeConditionalFormatting(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeOtherCondElements().

◆ CONDITION_DATABAR

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_DATABAR = 'dataBar'

Definition at line 17 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Style\ConditionalFormatting\ConditionalFormattingRuleExtension\parseExtLstXml(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeConditionalFormatting().

◆ CONDITION_EXPRESSION

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_EXPRESSION = 'expression'

Definition at line 14 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\__construct(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFHeader(), PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeOtherCondElements().

◆ CONDITION_NONE

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_NONE = 'none'

Definition at line 11 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeConditionalFormatting().

◆ CONDITION_NOTCONTAINSBLANKS

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_NOTCONTAINSBLANKS = 'notContainsBlanks'

Definition at line 16 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeOtherCondElements().

◆ CONDITION_NOTCONTAINSTEXT

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_NOTCONTAINSTEXT = 'notContainsText'

Definition at line 18 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeConditionalFormatting().

◆ CONDITION_TYPES

const PhpOffice\PhpSpreadsheet\Style\Conditional::CONDITION_TYPES

private

Initial value:

= [
        self::CONDITION_CELLIS,
        self::CONDITION_CONTAINSBLANKS,
        self::CONDITION_CONTAINSTEXT,
        self::CONDITION_DATABAR,
        self::CONDITION_EXPRESSION,
        self::CONDITION_NONE,
        self::CONDITION_NOTCONTAINSBLANKS,
        self::CONDITION_NOTCONTAINSTEXT,
    ]

Definition at line 20 of file Conditional.php.

◆ OPERATOR_BEGINSWITH

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_BEGINSWITH = 'beginsWith'

Definition at line 33 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeTextCondElements().

◆ OPERATOR_BETWEEN

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_BETWEEN = 'between'

Definition at line 43 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

◆ OPERATOR_CONTAINSTEXT

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_CONTAINSTEXT = 'containsText'

Definition at line 41 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeTextCondElements().

◆ OPERATOR_ENDSWITH

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_ENDSWITH = 'endsWith'

Definition at line 34 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeTextCondElements().

◆ OPERATOR_EQUAL

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_EQUAL = 'equal'

Definition at line 35 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

◆ OPERATOR_GREATERTHAN

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_GREATERTHAN = 'greaterThan'

Definition at line 36 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

◆ OPERATOR_GREATERTHANOREQUAL

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual'

Definition at line 37 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

◆ OPERATOR_LESSTHAN

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHAN = 'lessThan'

Definition at line 38 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

◆ OPERATOR_LESSTHANOREQUAL

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual'

Definition at line 39 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

◆ OPERATOR_NONE

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NONE = ''

Definition at line 32 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule(), and PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeConditionalFormatting().

◆ OPERATOR_NOTBETWEEN

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NOTBETWEEN = 'notBetween'

Definition at line 44 of file Conditional.php.

◆ OPERATOR_NOTCONTAINS

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NOTCONTAINS = 'notContains'

Definition at line 42 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet\writeTextCondElements().

◆ OPERATOR_NOTEQUAL

const PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NOTEQUAL = 'notEqual'

Definition at line 40 of file Conditional.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Worksheet\writeCFRule().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Style/Conditional.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ addCondition()

◆ getConditions()

◆ getConditionType()

◆ getDataBar()

◆ getHashCode()

◆ getOperatorType()

◆ getStopIfTrue()

◆ getStyle()

◆ getText()

◆ isValidConditionType()

◆ setConditions()

◆ setConditionType()

◆ setDataBar()

◆ setOperatorType()

◆ setStopIfTrue()

◆ setStyle()

◆ setText()

Field Documentation

◆ $condition

◆ $conditionType

◆ $dataBar

◆ $operatorType

◆ $stopIfTrue

◆ $style

◆ $text

◆ CONDITION_CELLIS

◆ CONDITION_CONTAINSBLANKS

◆ CONDITION_CONTAINSTEXT

◆ CONDITION_DATABAR

◆ CONDITION_EXPRESSION

◆ CONDITION_NONE

◆ CONDITION_NOTCONTAINSBLANKS

◆ CONDITION_NOTCONTAINSTEXT

◆ CONDITION_TYPES

◆ OPERATOR_BEGINSWITH

◆ OPERATOR_BETWEEN

◆ OPERATOR_CONTAINSTEXT

◆ OPERATOR_ENDSWITH

◆ OPERATOR_EQUAL

◆ OPERATOR_GREATERTHAN

◆ OPERATOR_GREATERTHANOREQUAL

◆ OPERATOR_LESSTHAN

◆ OPERATOR_LESSTHANOREQUAL

◆ OPERATOR_NONE

◆ OPERATOR_NOTBETWEEN

◆ OPERATOR_NOTCONTAINS

◆ OPERATOR_NOTEQUAL