Collaboration diagram for PHPExcel_Cell_DataValidation:

Public Member Functions
	__construct (PHPExcel_Cell $pCell=null)
	Create a new PHPExcel_Cell_DataValidation.
	getFormula1 ()
	Get Formula 1.
	setFormula1 ($value= '')
	Set Formula 1.
	getFormula2 ()
	Get Formula 2.
	setFormula2 ($value= '')
	Set Formula 2.
	getType ()
	Get Type.
	setType ($value=PHPExcel_Cell_DataValidation::TYPE_NONE)
	Set Type.
	getErrorStyle ()
	Get Error style.
	setErrorStyle ($value=PHPExcel_Cell_DataValidation::STYLE_STOP)
	Set Error style.
	getOperator ()
	Get Operator.
	setOperator ($value= '')
	Set Operator.
	getAllowBlank ()
	Get Allow Blank.
	setAllowBlank ($value=false)
	Set Allow Blank.
	getShowDropDown ()
	Get Show DropDown.
	setShowDropDown ($value=false)
	Set Show DropDown.
	getShowInputMessage ()
	Get Show InputMessage.
	setShowInputMessage ($value=false)
	Set Show InputMessage.
	getShowErrorMessage ()
	Get Show ErrorMessage.
	setShowErrorMessage ($value=false)
	Set Show ErrorMessage.
	getErrorTitle ()
	Get Error title.
	setErrorTitle ($value= '')
	Set Error title.
	getError ()
	Get Error.
	setError ($value= '')
	Set Error.
	getPromptTitle ()
	Get Prompt title.
	setPromptTitle ($value= '')
	Set Prompt title.
	getPrompt ()
	Get Prompt.
	setPrompt ($value= '')
	Set Prompt.
	getParent ()
	Get parent.
	setParent ($value=null)
	Set Parent.
	getHashCode ()
	Get hash code.
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy.

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
	$_parent

Detailed Description

Definition at line 36 of file DataValidation.php.

Constructor & Destructor Documentation

PHPExcel_Cell_DataValidation::__construct ( PHPExcel_Cell $pCell = null )

Create a new PHPExcel_Cell_DataValidation.

Parameters

PHPExcel_Cell $pCell Parent cell

Exceptions

Exception

Definition at line 167 of file DataValidation.php.

References STYLE_STOP, and TYPE_NONE.

    {
        // 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                          = '';
        
        // Set cell
        $this->_parent = $pCell;
    }

Member Function Documentation

PHPExcel_Cell_DataValidation::__clone ( )

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

Definition at line 496 of file DataValidation.php.

References $key, and setParent().

                                  {
                // unbind parent
                $this->setParent(null);
                
                $vars = get_object_vars($this);
                foreach ($vars as $key => $value) {
                        if (is_object($value) && $key != '_parent') {
                                $this->$key = clone $value;
                        } else {
                                $this->$key = $value;
                        }
                }
        }

Here is the call graph for this function:

PHPExcel_Cell_DataValidation::getAllowBlank ( )

Get Allow Blank.

Returns: boolean

Definition at line 293 of file DataValidation.php.

References $_allowBlank.

                                        {
                return $this->_allowBlank;
        }

PHPExcel_Cell_DataValidation::getError ( )

Get Error.

Returns: string

Definition at line 393 of file DataValidation.php.

References $_error.

                                   {
                return $this->_error;
        }

PHPExcel_Cell_DataValidation::getErrorStyle ( )

Get Error style.

Returns: string

Definition at line 253 of file DataValidation.php.

References $_errorStyle.

                                        {
                return $this->_errorStyle;
        }

PHPExcel_Cell_DataValidation::getErrorTitle ( )

Get Error title.

Returns: string

Definition at line 373 of file DataValidation.php.

References $_errorTitle.

                                        {
                return $this->_errorTitle;
        }

PHPExcel_Cell_DataValidation::getFormula1 ( )

Get Formula 1.

Returns: string

Definition at line 193 of file DataValidation.php.

References $_formula1.

                                      {
                return $this->_formula1;
        }

PHPExcel_Cell_DataValidation::getFormula2 ( )

Get Formula 2.

Returns: string

Definition at line 213 of file DataValidation.php.

References $_formula2.

                                      {
                return $this->_formula2;
        }

PHPExcel_Cell_DataValidation::getHashCode ( )

Get hash code.

Returns: string Hash code

Definition at line 473 of file DataValidation.php.

References STYLE_STOP, and TYPE_NONE.

                                      {
        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
                . $this->_parent->getCoordinate()
                . __CLASS__
        );
    }

PHPExcel_Cell_DataValidation::getOperator ( )

Get Operator.

Returns: string

Definition at line 273 of file DataValidation.php.

References $_operator.

                                      {
                return $this->_operator;
        }

PHPExcel_Cell_DataValidation::getParent ( )

Get parent.

Returns: PHPExcel_Cell

Definition at line 453 of file DataValidation.php.

References $_parent.

                                {
        return $this->_parent;
    }

PHPExcel_Cell_DataValidation::getPrompt ( )

Get Prompt.

Returns: string

Definition at line 433 of file DataValidation.php.

References $_prompt.

                                    {
                return $this->_prompt;
        }

PHPExcel_Cell_DataValidation::getPromptTitle ( )

Get Prompt title.

Returns: string

Definition at line 413 of file DataValidation.php.

References $_promptTitle.

                                         {
                return $this->_promptTitle;
        }

PHPExcel_Cell_DataValidation::getShowDropDown ( )

Get Show DropDown.

Returns: boolean

Definition at line 313 of file DataValidation.php.

References $_showDropDown.

                                          {
                return $this->_showDropDown;
        }

PHPExcel_Cell_DataValidation::getShowErrorMessage ( )

Get Show ErrorMessage.

Returns: boolean

Definition at line 353 of file DataValidation.php.

References $_showErrorMessage.

                                              {
                return $this->_showErrorMessage;
        }

PHPExcel_Cell_DataValidation::getShowInputMessage ( )

Get Show InputMessage.

Returns: boolean

Definition at line 333 of file DataValidation.php.

References $_showInputMessage.

                                              {
                return $this->_showInputMessage;
        }

PHPExcel_Cell_DataValidation::getType ( )

Get Type.

Returns: string

Definition at line 233 of file DataValidation.php.

References $_type.

                                  {
                return $this->_type;
        }

PHPExcel_Cell_DataValidation::setAllowBlank ( $value = false )

Set Allow Blank.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 303 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setError ( $value = '' )

Set Error.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 403 of file DataValidation.php.

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

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

Set Error style.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 263 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setErrorTitle ( $value = '' )

Set Error title.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 383 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setFormula1 ( $value = '' )

Set Formula 1.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 203 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setFormula2 ( $value = '' )

Set Formula 2.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 223 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setOperator ( $value = '' )

Set Operator.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 283 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setParent ( $value = null )

Set Parent.

Parameters

PHPExcel_Cell $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 463 of file DataValidation.php.

Referenced by __clone().

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

Here is the caller graph for this function:

PHPExcel_Cell_DataValidation::setPrompt ( $value = '' )

Set Prompt.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 443 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setPromptTitle ( $value = '' )

Set Prompt title.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 423 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setShowDropDown ( $value = false )

Set Show DropDown.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 323 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setShowErrorMessage ( $value = false )

Set Show ErrorMessage.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 363 of file DataValidation.php.

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

PHPExcel_Cell_DataValidation::setShowInputMessage ( $value = false )

Set Show InputMessage.

Parameters

boolean $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 343 of file DataValidation.php.

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

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

Set Type.

Parameters

string $value

Returns: PHPExcel_Cell_DataValidation

Definition at line 243 of file DataValidation.php.

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

Field Documentation

PHPExcel_Cell_DataValidation::$_allowBlank

private

Definition at line 103 of file DataValidation.php.

Referenced by getAllowBlank().

PHPExcel_Cell_DataValidation::$_error

private

Definition at line 138 of file DataValidation.php.

Referenced by getError().

PHPExcel_Cell_DataValidation::$_errorStyle = PHPExcel_Cell_DataValidation::STYLE_STOP

private

Definition at line 89 of file DataValidation.php.

Referenced by getErrorStyle().

PHPExcel_Cell_DataValidation::$_errorTitle

private

Definition at line 131 of file DataValidation.php.

Referenced by getErrorTitle().

PHPExcel_Cell_DataValidation::$_formula1

private

Definition at line 68 of file DataValidation.php.

Referenced by getFormula1().

PHPExcel_Cell_DataValidation::$_formula2

private

Definition at line 75 of file DataValidation.php.

Referenced by getFormula2().

PHPExcel_Cell_DataValidation::$_operator

private

Definition at line 96 of file DataValidation.php.

Referenced by getOperator().

PHPExcel_Cell_DataValidation::$_parent

private

Definition at line 159 of file DataValidation.php.

Referenced by getParent().

PHPExcel_Cell_DataValidation::$_prompt

private

Definition at line 152 of file DataValidation.php.

Referenced by getPrompt().

PHPExcel_Cell_DataValidation::$_promptTitle

private

Definition at line 145 of file DataValidation.php.

Referenced by getPromptTitle().

PHPExcel_Cell_DataValidation::$_showDropDown

private

Definition at line 110 of file DataValidation.php.

Referenced by getShowDropDown().

PHPExcel_Cell_DataValidation::$_showErrorMessage

private

Definition at line 124 of file DataValidation.php.

Referenced by getShowErrorMessage().

PHPExcel_Cell_DataValidation::$_showInputMessage

private

Definition at line 117 of file DataValidation.php.

Referenced by getShowInputMessage().

PHPExcel_Cell_DataValidation::$_type = PHPExcel_Cell_DataValidation::TYPE_NONE

private

Definition at line 82 of file DataValidation.php.

Referenced by getType().

const PHPExcel_Cell_DataValidation::OPERATOR_BETWEEN = 'between'

Definition at line 54 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::OPERATOR_EQUAL = 'equal'

Definition at line 55 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::OPERATOR_GREATERTHAN = 'greaterThan'

Definition at line 56 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual'

Definition at line 57 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::OPERATOR_LESSTHAN = 'lessThan'

Definition at line 58 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual'

Definition at line 59 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::OPERATOR_NOTBETWEEN = 'notBetween'

Definition at line 60 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::OPERATOR_NOTEQUAL = 'notEqual'

Definition at line 61 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::STYLE_INFORMATION = 'information'

Definition at line 51 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::STYLE_STOP = 'stop'

Definition at line 49 of file DataValidation.php.

Referenced by __construct(), and getHashCode().

const PHPExcel_Cell_DataValidation::STYLE_WARNING = 'warning'

Definition at line 50 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::TYPE_CUSTOM = 'custom'

Definition at line 40 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::TYPE_DATE = 'date'

Definition at line 41 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::TYPE_DECIMAL = 'decimal'

Definition at line 42 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::TYPE_LIST = 'list'

Definition at line 43 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::TYPE_NONE = 'none'

Definition at line 39 of file DataValidation.php.

Referenced by __construct(), and getHashCode().

const PHPExcel_Cell_DataValidation::TYPE_TEXTLENGTH = 'textLength'

Definition at line 44 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::TYPE_TIME = 'time'

Definition at line 45 of file DataValidation.php.

const PHPExcel_Cell_DataValidation::TYPE_WHOLE = 'whole'

Definition at line 46 of file DataValidation.php.

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

Services/Excel/classes/PHPExcel/Cell/DataValidation.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation