Collaboration diagram for PHPExcel_Cell_DataValidation:

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

	getFormula1 ()
	Get Formula 1. More...

	setFormula1 ($value='')
	Set Formula 1. More...

	getFormula2 ()
	Get Formula 2. More...

	setFormula2 ($value='')
	Set Formula 2. More...

	getType ()
	Get Type. More...

	setType ($value=PHPExcel_Cell_DataValidation::TYPE_NONE)
	Set Type. More...

	getErrorStyle ()
	Get Error style. More...

	setErrorStyle ($value=PHPExcel_Cell_DataValidation::STYLE_STOP)
	Set Error style. More...

	getOperator ()
	Get Operator. More...

	setOperator ($value='')
	Set Operator. More...

	getAllowBlank ()
	Get Allow Blank. More...

	setAllowBlank ($value=false)
	Set Allow Blank. More...

	getShowDropDown ()
	Get Show DropDown. More...

	setShowDropDown ($value=false)
	Set Show DropDown. More...

	getShowInputMessage ()
	Get Show InputMessage. More...

	setShowInputMessage ($value=false)
	Set Show InputMessage. More...

	getShowErrorMessage ()
	Get Show ErrorMessage. More...

	setShowErrorMessage ($value=false)
	Set Show ErrorMessage. More...

	getErrorTitle ()
	Get Error title. More...

	setErrorTitle ($value='')
	Set Error title. More...

	getError ()
	Get Error. More...

	setError ($value='')
	Set Error. More...

	getPromptTitle ()
	Get Prompt title. More...

	setPromptTitle ($value='')
	Set Prompt title. More...

	getPrompt ()
	Get Prompt. More...

	setPrompt ($value='')
	Set Prompt. More...

	getHashCode ()
	Get hash code. More...

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

Data Fields
const	TYPE_NONE = 'none'

const	TYPE_CUSTOM = 'custom'

const	TYPE_DATE = 'date'

const	TYPE_DECIMAL = 'decimal'

const	TYPE_LIST = 'list'

const	TYPE_TEXTLENGTH = 'textLength'

const	TYPE_TIME = 'time'

const	TYPE_WHOLE = 'whole'

const	STYLE_STOP = 'stop'

const	STYLE_WARNING = 'warning'

const	STYLE_INFORMATION = 'information'

const	OPERATOR_BETWEEN = 'between'

const	OPERATOR_EQUAL = 'equal'

const	OPERATOR_GREATERTHAN = 'greaterThan'

const	OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual'

const	OPERATOR_LESSTHAN = 'lessThan'

const	OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual'

const	OPERATOR_NOTBETWEEN = 'notBetween'

const	OPERATOR_NOTEQUAL = 'notEqual'

Private Attributes
	$_formula1

	$_formula2

	$_type = PHPExcel_Cell_DataValidation::TYPE_NONE

	$_errorStyle = PHPExcel_Cell_DataValidation::STYLE_STOP

	$_operator

	$_allowBlank

	$_showDropDown

	$_showInputMessage

	$_showErrorMessage

	$_errorTitle

	$_error

	$_promptTitle

	$_prompt

Detailed Description

Definition at line 36 of file DataValidation.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Cell_DataValidation::__construct ( )

Create a new PHPExcel_Cell_DataValidation.

Definition at line 157 of file DataValidation.php.

    {
        // Initialise member variables
        $this->_formula1          = '';
        $this->_formula2          = '';
        $this->_type              = PHPExcel_Cell_DataValidation::TYPE_NONE;
        $this->_errorStyle        = PHPExcel_Cell_DataValidation::STYLE_STOP;
        $this->_operator          = '';
        $this->_allowBlank        = FALSE;
        $this->_showDropDown      = FALSE;
        $this->_showInputMessage  = FALSE;
        $this->_showErrorMessage  = FALSE;
        $this->_errorTitle        = '';
        $this->_error             = '';
        $this->_promptTitle       = '';
        $this->_prompt            = '';
    }

References STYLE_STOP, and TYPE_NONE.

Member Function Documentation

◆ __clone()

PHPExcel_Cell_DataValidation::__clone ( )

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

Definition at line 462 of file DataValidation.php.

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

References $key.

◆ getAllowBlank()

PHPExcel_Cell_DataValidation::getAllowBlank ( )

Get Allow Blank.

Returns: boolean

Definition at line 280 of file DataValidation.php.

                                    {
        return $this->_allowBlank;
    }

References $_allowBlank.

◆ getError()

PHPExcel_Cell_DataValidation::getError ( )

Get Error.

Returns: string

Definition at line 380 of file DataValidation.php.

                               {
        return $this->_error;
    }

References $_error.

◆ getErrorStyle()

PHPExcel_Cell_DataValidation::getErrorStyle ( )

Get Error style.

Returns: string

Definition at line 240 of file DataValidation.php.

                                    {
        return $this->_errorStyle;
    }

References $_errorStyle.

◆ getErrorTitle()

PHPExcel_Cell_DataValidation::getErrorTitle ( )

Get Error title.

Returns: string

Definition at line 360 of file DataValidation.php.

                                    {
        return $this->_errorTitle;
    }

References $_errorTitle.

◆ getFormula1()

PHPExcel_Cell_DataValidation::getFormula1 ( )

Get Formula 1.

Returns: string

Definition at line 180 of file DataValidation.php.

                                  {
        return $this->_formula1;
    }

References $_formula1.

◆ getFormula2()

PHPExcel_Cell_DataValidation::getFormula2 ( )

Get Formula 2.

Returns: string

Definition at line 200 of file DataValidation.php.

                                  {
        return $this->_formula2;
    }

References $_formula2.

◆ getHashCode()

PHPExcel_Cell_DataValidation::getHashCode ( )

Get hash code.

Returns: string Hash code

Definition at line 440 of file DataValidation.php.

                                  {
        return md5(
              $this->_formula1
            . $this->_formula2
            . $this->_type = PHPExcel_Cell_DataValidation::TYPE_NONE
            . $this->_errorStyle = PHPExcel_Cell_DataValidation::STYLE_STOP
            . $this->_operator
            . ($this->_allowBlank ? 't' : 'f')
            . ($this->_showDropDown ? 't' : 'f')
            . ($this->_showInputMessage ? 't' : 'f')
            . ($this->_showErrorMessage ? 't' : 'f')
            . $this->_errorTitle
            . $this->_error
            . $this->_promptTitle
            . $this->_prompt
            . __CLASS__
        );
    }

References STYLE_STOP, and TYPE_NONE.

◆ getOperator()

PHPExcel_Cell_DataValidation::getOperator ( )

Get Operator.

Returns: string

Definition at line 260 of file DataValidation.php.

                                  {
        return $this->_operator;
    }

References $_operator.

◆ getPrompt()

PHPExcel_Cell_DataValidation::getPrompt ( )

Get Prompt.

Returns: string

Definition at line 420 of file DataValidation.php.

                                {
        return $this->_prompt;
    }

References $_prompt.

◆ getPromptTitle()

PHPExcel_Cell_DataValidation::getPromptTitle ( )

Get Prompt title.

Returns: string

Definition at line 400 of file DataValidation.php.

                                     {
        return $this->_promptTitle;
    }

References $_promptTitle.

◆ getShowDropDown()

PHPExcel_Cell_DataValidation::getShowDropDown ( )

Get Show DropDown.

Returns: boolean

Definition at line 300 of file DataValidation.php.

                                      {
        return $this->_showDropDown;
    }

References $_showDropDown.

◆ getShowErrorMessage()

PHPExcel_Cell_DataValidation::getShowErrorMessage ( )

Get Show ErrorMessage.

Returns: boolean

Definition at line 340 of file DataValidation.php.

                                          {
        return $this->_showErrorMessage;
    }

References $_showErrorMessage.

◆ getShowInputMessage()

PHPExcel_Cell_DataValidation::getShowInputMessage ( )

Get Show InputMessage.

Returns: boolean

Definition at line 320 of file DataValidation.php.

                                          {
        return $this->_showInputMessage;
    }

References $_showInputMessage.

◆ getType()

PHPExcel_Cell_DataValidation::getType ( )

Get Type.

Returns: string

Definition at line 220 of file DataValidation.php.

                              {
        return $this->_type;
    }

References $_type.

◆ setAllowBlank()

PHPExcel_Cell_DataValidation::setAllowBlank ( $value = false )

Set Allow Blank.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 290 of file DataValidation.php.

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

◆ setError()

PHPExcel_Cell_DataValidation::setError ( $value = '' )

Set Error.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 390 of file DataValidation.php.

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

◆ setErrorStyle()

PHPExcel_Cell_DataValidation::setErrorStyle ( $value = PHPExcel_Cell_DataValidation::STYLE_STOP )

Set Error style.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 250 of file DataValidation.php.

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

◆ setErrorTitle()

PHPExcel_Cell_DataValidation::setErrorTitle ( $value = '' )

Set Error title.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 370 of file DataValidation.php.

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

◆ setFormula1()

PHPExcel_Cell_DataValidation::setFormula1 ( $value = '' )

Set Formula 1.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 190 of file DataValidation.php.

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

◆ setFormula2()

PHPExcel_Cell_DataValidation::setFormula2 ( $value = '' )

Set Formula 2.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 210 of file DataValidation.php.

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

◆ setOperator()

PHPExcel_Cell_DataValidation::setOperator ( $value = '' )

Set Operator.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 270 of file DataValidation.php.

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

◆ setPrompt()

PHPExcel_Cell_DataValidation::setPrompt ( $value = '' )

Set Prompt.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 430 of file DataValidation.php.

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

◆ setPromptTitle()

PHPExcel_Cell_DataValidation::setPromptTitle ( $value = '' )

Set Prompt title.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 410 of file DataValidation.php.

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

◆ setShowDropDown()

PHPExcel_Cell_DataValidation::setShowDropDown ( $value = false )

Set Show DropDown.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 310 of file DataValidation.php.

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

◆ setShowErrorMessage()

PHPExcel_Cell_DataValidation::setShowErrorMessage ( $value = false )

Set Show ErrorMessage.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 350 of file DataValidation.php.

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

◆ setShowInputMessage()

PHPExcel_Cell_DataValidation::setShowInputMessage ( $value = false )

Set Show InputMessage.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 330 of file DataValidation.php.

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

◆ setType()

PHPExcel_Cell_DataValidation::setType ( $value = PHPExcel_Cell_DataValidation::TYPE_NONE )

Set Type.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 230 of file DataValidation.php.

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

Field Documentation

◆ $_allowBlank

PHPExcel_Cell_DataValidation::$_allowBlank

private

Definition at line 103 of file DataValidation.php.

Referenced by getAllowBlank().

◆ $_error

PHPExcel_Cell_DataValidation::$_error

private

Definition at line 138 of file DataValidation.php.

Referenced by getError().

◆ $_errorStyle

PHPExcel_Cell_DataValidation::$_errorStyle = PHPExcel_Cell_DataValidation::STYLE_STOP

private

Definition at line 89 of file DataValidation.php.

Referenced by getErrorStyle().

◆ $_errorTitle

PHPExcel_Cell_DataValidation::$_errorTitle

private

Definition at line 131 of file DataValidation.php.

Referenced by getErrorTitle().

◆ $_formula1

PHPExcel_Cell_DataValidation::$_formula1

private

Definition at line 68 of file DataValidation.php.

Referenced by getFormula1().

◆ $_formula2

PHPExcel_Cell_DataValidation::$_formula2

private

Definition at line 75 of file DataValidation.php.

Referenced by getFormula2().

◆ $_operator

PHPExcel_Cell_DataValidation::$_operator

private

Definition at line 96 of file DataValidation.php.

Referenced by getOperator().

◆ $_prompt

PHPExcel_Cell_DataValidation::$_prompt

private

Definition at line 152 of file DataValidation.php.

Referenced by getPrompt().

◆ $_promptTitle

PHPExcel_Cell_DataValidation::$_promptTitle

private

Definition at line 145 of file DataValidation.php.

Referenced by getPromptTitle().

◆ $_showDropDown

PHPExcel_Cell_DataValidation::$_showDropDown

private

Definition at line 110 of file DataValidation.php.

Referenced by getShowDropDown().

◆ $_showErrorMessage

PHPExcel_Cell_DataValidation::$_showErrorMessage

private

Definition at line 124 of file DataValidation.php.

Referenced by getShowErrorMessage().

◆ $_showInputMessage

PHPExcel_Cell_DataValidation::$_showInputMessage

private

Definition at line 117 of file DataValidation.php.

Referenced by getShowInputMessage().

◆ $_type

PHPExcel_Cell_DataValidation::$_type = PHPExcel_Cell_DataValidation::TYPE_NONE

private

Definition at line 82 of file DataValidation.php.

Referenced by getType().

◆ OPERATOR_BETWEEN

const PHPExcel_Cell_DataValidation::OPERATOR_BETWEEN = 'between'

Definition at line 54 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ OPERATOR_EQUAL

const PHPExcel_Cell_DataValidation::OPERATOR_EQUAL = 'equal'

Definition at line 55 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ OPERATOR_GREATERTHAN

const PHPExcel_Cell_DataValidation::OPERATOR_GREATERTHAN = 'greaterThan'

Definition at line 56 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ OPERATOR_GREATERTHANOREQUAL

const PHPExcel_Cell_DataValidation::OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual'

Definition at line 57 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ OPERATOR_LESSTHAN

const PHPExcel_Cell_DataValidation::OPERATOR_LESSTHAN = 'lessThan'

Definition at line 58 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ OPERATOR_LESSTHANOREQUAL

const PHPExcel_Cell_DataValidation::OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual'

Definition at line 59 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ OPERATOR_NOTBETWEEN

const PHPExcel_Cell_DataValidation::OPERATOR_NOTBETWEEN = 'notBetween'

Definition at line 60 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ OPERATOR_NOTEQUAL

const PHPExcel_Cell_DataValidation::OPERATOR_NOTEQUAL = 'notEqual'

Definition at line 61 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ STYLE_INFORMATION

const PHPExcel_Cell_DataValidation::STYLE_INFORMATION = 'information'

Definition at line 51 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ STYLE_STOP

const PHPExcel_Cell_DataValidation::STYLE_STOP = 'stop'

Definition at line 49 of file DataValidation.php.

Referenced by __construct(), PHPExcel_Reader_Excel5\_readDataValidation(), PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity(), and getHashCode().

◆ STYLE_WARNING

const PHPExcel_Cell_DataValidation::STYLE_WARNING = 'warning'

Definition at line 50 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ TYPE_CUSTOM

const PHPExcel_Cell_DataValidation::TYPE_CUSTOM = 'custom'

Definition at line 40 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ TYPE_DATE

const PHPExcel_Cell_DataValidation::TYPE_DATE = 'date'

Definition at line 41 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ TYPE_DECIMAL

const PHPExcel_Cell_DataValidation::TYPE_DECIMAL = 'decimal'

Definition at line 42 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ TYPE_LIST

const PHPExcel_Cell_DataValidation::TYPE_LIST = 'list'

Definition at line 43 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ TYPE_NONE

const PHPExcel_Cell_DataValidation::TYPE_NONE = 'none'

Definition at line 39 of file DataValidation.php.

Referenced by __construct(), PHPExcel_Reader_Excel5\_readDataValidation(), PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity(), and getHashCode().

◆ TYPE_TEXTLENGTH

const PHPExcel_Cell_DataValidation::TYPE_TEXTLENGTH = 'textLength'

Definition at line 44 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ TYPE_TIME

const PHPExcel_Cell_DataValidation::TYPE_TIME = 'time'

Definition at line 45 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

◆ TYPE_WHOLE

const PHPExcel_Cell_DataValidation::TYPE_WHOLE = 'whole'

Definition at line 46 of file DataValidation.php.

Referenced by PHPExcel_Reader_Excel5\_readDataValidation(), and PHPExcel_Writer_Excel5_Worksheet\_writeDataValidity().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Cell/DataValidation.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ getAllowBlank()

◆ getError()

◆ getErrorStyle()

◆ getErrorTitle()

◆ getFormula1()

◆ getFormula2()

◆ getHashCode()

◆ getOperator()

◆ getPrompt()

◆ getPromptTitle()

◆ getShowDropDown()

◆ getShowErrorMessage()

◆ getShowInputMessage()

◆ getType()

◆ setAllowBlank()

◆ setError()

◆ setErrorStyle()

◆ setErrorTitle()

◆ setFormula1()

◆ setFormula2()

◆ setOperator()

◆ setPrompt()

◆ setPromptTitle()

◆ setShowDropDown()

◆ setShowErrorMessage()

◆ setShowInputMessage()

◆ setType()

Field Documentation

◆ $_allowBlank

◆ $_error

◆ $_errorStyle

◆ $_errorTitle

◆ $_formula1

◆ $_formula2

◆ $_operator

◆ $_prompt

◆ $_promptTitle

◆ $_showDropDown

◆ $_showErrorMessage

◆ $_showInputMessage

◆ $_type

◆ OPERATOR_BETWEEN

◆ OPERATOR_EQUAL

◆ OPERATOR_GREATERTHAN

◆ OPERATOR_GREATERTHANOREQUAL

◆ OPERATOR_LESSTHAN

◆ OPERATOR_LESSTHANOREQUAL

◆ OPERATOR_NOTBETWEEN

◆ OPERATOR_NOTEQUAL

◆ STYLE_INFORMATION

◆ STYLE_STOP

◆ STYLE_WARNING

◆ TYPE_CUSTOM

◆ TYPE_DATE

◆ TYPE_DECIMAL

◆ TYPE_LIST

◆ TYPE_NONE

◆ TYPE_TEXTLENGTH

◆ TYPE_TIME

◆ TYPE_WHOLE