Inheritance diagram for PHPExcel_Style_Conditional:

Collaboration diagram for PHPExcel_Style_Conditional:

Public Member Functions
	__construct ()
	Create a new PHPExcel_Style_Conditional.
	getConditionType ()
	Get Condition type.
	setConditionType ($pValue=PHPExcel_Style_Conditional::CONDITION_NONE)
	Set Condition type.
	getOperatorType ()
	Get Operator type.
	setOperatorType ($pValue=PHPExcel_Style_Conditional::OPERATOR_NONE)
	Set Operator type.
	getText ()
	Get text.
	setText ($value=null)
	Set text.
	getCondition ()
	Get Condition.
	setCondition ($pValue= '')
	Set Condition.
	getConditions ()
	Get Conditions.
	setConditions ($pValue)
	Set Conditions.
	addCondition ($pValue= '')
	Add Condition.
	getStyle ()
	Get Style.
	setStyle (PHPExcel_Style $pValue=null)
	Set Style.
	getHashCode ()
	Get hash code.
	getHashIndex ()
	Get hash index.
	setHashIndex ($value)
	Set hash index.
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy.

Data Fields
const	CONDITION_NONE = 'none'
const	CONDITION_CELLIS = 'cellIs'
const	CONDITION_CONTAINSTEXT = 'containsText'
const	CONDITION_EXPRESSION = 'expression'
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'

Private Attributes
	$_conditionType
	$_operatorType
	$_text
	$_condition = array()
	$_style
	$_hashIndex

Detailed Description

Definition at line 51 of file Conditional.php.

Constructor & Destructor Documentation

PHPExcel_Style_Conditional::__construct ( )

Create a new PHPExcel_Style_Conditional.

Definition at line 111 of file Conditional.php.

References CONDITION_NONE, and OPERATOR_NONE.

    {
        // Initialise values
        $this->_conditionType           = PHPExcel_Style_Conditional::CONDITION_NONE;
        $this->_operatorType            = PHPExcel_Style_Conditional::OPERATOR_NONE;
        $this->_text                            = null;
        $this->_condition                       = array();
        $this->_style                           = new PHPExcel_Style();
    }

Member Function Documentation

PHPExcel_Style_Conditional::__clone ( )

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

Definition at line 313 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;
                        }
                }
        }

PHPExcel_Style_Conditional::addCondition ( $pValue = '' )

Add Condition.

Parameters

string $pValue Condition

Returns: PHPExcel_Style_Conditional

Definition at line 238 of file Conditional.php.

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

PHPExcel_Style_Conditional::getCondition ( )

Get Condition.

Deprecated:: Deprecated, use getConditions instead

Returns: string

Definition at line 187 of file Conditional.php.

                                   {
        if (isset($this->_condition[0])) {
                return $this->_condition[0];
        }
        
        return '';
    }

PHPExcel_Style_Conditional::getConditions ( )

Get Conditions.

Returns: string[]

Definition at line 214 of file Conditional.php.

References $_condition.

                                    {
        return $this->_condition;
    }

PHPExcel_Style_Conditional::getConditionType ( )

Get Condition type.

Returns: string

Definition at line 126 of file Conditional.php.

References $_conditionType.

                                       {
        return $this->_conditionType;
    }

PHPExcel_Style_Conditional::getHashCode ( )

Get hash code.

Returns: string Hash code

Implements PHPExcel_IComparable.

Definition at line 269 of file Conditional.php.

                                      {
        return md5(
                  $this->_conditionType
                . $this->_operatorType
                . implode(';', $this->_condition)
                . $this->_style->getHashCode()
                . __CLASS__
        );
    }

PHPExcel_Style_Conditional::getHashIndex ( )

Get hash index.

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Returns: string Hash index

Implements PHPExcel_IComparable.

Definition at line 294 of file Conditional.php.

References $_hashIndex.

                                       {
                return $this->_hashIndex;
        }

PHPExcel_Style_Conditional::getOperatorType ( )

Get Operator type.

Returns: string

Definition at line 146 of file Conditional.php.

References $_operatorType.

                                      {
        return $this->_operatorType;
    }

PHPExcel_Style_Conditional::getStyle ( )

Get Style.

Returns: PHPExcel_Style

Definition at line 248 of file Conditional.php.

References $_style.

                               {
        return $this->_style;
    }

PHPExcel_Style_Conditional::getText ( )

Get text.

Returns: string

Definition at line 166 of file Conditional.php.

References $_text.

                              {
        return $this->_text;
    }

PHPExcel_Style_Conditional::setCondition ( $pValue = '' )

Set Condition.

Deprecated:: Deprecated, use setConditions instead

Parameters

string $pValue Condition

Returns: PHPExcel_Style_Conditional

Definition at line 202 of file Conditional.php.

References setConditions().

                                               {
        if (!is_array($pValue))
                $pValue = array($pValue);
                
        return $this->setConditions($pValue);
    }

Here is the call graph for this function:

PHPExcel_Style_Conditional::setConditions ( $pValue )

Set Conditions.

Parameters

string[] $pValue Condition

Returns: PHPExcel_Style_Conditional

Definition at line 224 of file Conditional.php.

Referenced by setCondition().

                                           {
        if (!is_array($pValue))
                $pValue = array($pValue);
                
        $this->_condition = $pValue;
        return $this;
    }

Here is the caller graph for this function:

PHPExcel_Style_Conditional::setConditionType ( $pValue = PHPExcel_Style_Conditional::CONDITION_NONE )

Set Condition type.

Parameters

string $pValue PHPExcel_Style_Conditional condition type

Returns: PHPExcel_Style_Conditional

Definition at line 136 of file Conditional.php.

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

PHPExcel_Style_Conditional::setHashIndex ( $value )

Set hash index.

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Parameters

string $value Hash index

Implements PHPExcel_IComparable.

Definition at line 306 of file Conditional.php.

                                             {
                $this->_hashIndex = $value;
        }

PHPExcel_Style_Conditional::setOperatorType ( $pValue = PHPExcel_Style_Conditional::OPERATOR_NONE )

Set Operator type.

Parameters

string $pValue PHPExcel_Style_Conditional operator type

Returns: PHPExcel_Style_Conditional

Definition at line 156 of file Conditional.php.

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

PHPExcel_Style_Conditional::setStyle ( PHPExcel_Style $pValue = null )

Set Style.

Parameters

PHPExcel_Style $pValue

Exceptions

Exception

Returns: PHPExcel_Style_Conditional

Definition at line 259 of file Conditional.php.

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

PHPExcel_Style_Conditional::setText ( $value = null )

Set text.

Parameters

string $value

Returns: PHPExcel_Style_Conditional

Definition at line 176 of file Conditional.php.

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

Field Documentation

PHPExcel_Style_Conditional::$_condition = array()

private

Definition at line 99 of file Conditional.php.

Referenced by getConditions().

PHPExcel_Style_Conditional::$_conditionType

private

Definition at line 78 of file Conditional.php.

Referenced by getConditionType().

PHPExcel_Style_Conditional::$_hashIndex

private

Definition at line 284 of file Conditional.php.

Referenced by getHashIndex().

PHPExcel_Style_Conditional::$_operatorType

private

Definition at line 85 of file Conditional.php.

Referenced by getOperatorType().

PHPExcel_Style_Conditional::$_style

private

Definition at line 106 of file Conditional.php.

Referenced by getStyle().

PHPExcel_Style_Conditional::$_text

private

Definition at line 92 of file Conditional.php.

Referenced by getText().

const PHPExcel_Style_Conditional::CONDITION_CELLIS = 'cellIs'

Definition at line 55 of file Conditional.php.

Referenced by PHPExcel_Writer_Excel2007_Worksheet\_writeConditionalFormatting(), and PHPExcel_Reader_Excel2007\load().

const PHPExcel_Style_Conditional::CONDITION_CONTAINSTEXT = 'containsText'

Definition at line 56 of file Conditional.php.

Referenced by PHPExcel_Writer_Excel2007_Worksheet\_writeConditionalFormatting(), and PHPExcel_Reader_Excel2007\load().

const PHPExcel_Style_Conditional::CONDITION_EXPRESSION = 'expression'

Definition at line 57 of file Conditional.php.

Referenced by PHPExcel_Writer_Excel2007_Worksheet\_writeConditionalFormatting().

const PHPExcel_Style_Conditional::CONDITION_NONE = 'none'

Definition at line 54 of file Conditional.php.

Referenced by __construct(), PHPExcel_Writer_Excel2007_Worksheet\_writeConditionalFormatting(), and PHPExcel_Reader_Excel2007\load().

const PHPExcel_Style_Conditional::OPERATOR_BEGINSWITH = 'beginsWith'

Definition at line 61 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_BETWEEN = 'between'

Definition at line 71 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_CONTAINSTEXT = 'containsText'

Definition at line 69 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_ENDSWITH = 'endsWith'

Definition at line 62 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_EQUAL = 'equal'

Definition at line 63 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_GREATERTHAN = 'greaterThan'

Definition at line 64 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual'

Definition at line 65 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_LESSTHAN = 'lessThan'

Definition at line 66 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual'

Definition at line 67 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_NONE = ''

Definition at line 60 of file Conditional.php.

Referenced by __construct(), and PHPExcel_Writer_Excel2007_Worksheet\_writeConditionalFormatting().

const PHPExcel_Style_Conditional::OPERATOR_NOTCONTAINS = 'notContains'

Definition at line 70 of file Conditional.php.

const PHPExcel_Style_Conditional::OPERATOR_NOTEQUAL = 'notEqual'

Definition at line 68 of file Conditional.php.

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

Services/Excel/classes/PHPExcel/Style/Conditional.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation