Collaboration diagram for PhpOffice\PhpSpreadsheet\Cell\DataValidation:

Public Member Functions
	__construct ()
	Create a new 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)
	Set Type. More...

	getErrorStyle ()
	Get Error style. More...

	setErrorStyle ($value)
	Set Error style. More...

	getOperator ()
	Get Operator. More...

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

	getAllowBlank ()
	Get Allow Blank. More...

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

	getShowDropDown ()
	Get Show DropDown. More...

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

	getShowInputMessage ()
	Get Show InputMessage. More...

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

	getShowErrorMessage ()
	Get Show ErrorMessage. More...

	setShowErrorMessage ($value)
	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 = self::TYPE_NONE

	$errorStyle = self::STYLE_STOP

	$operator = self::OPERATOR_BETWEEN

	$allowBlank = false

	$showDropDown = false

	$showInputMessage = false

	$showErrorMessage = false

	$errorTitle = ''

	$error = ''

	$promptTitle = ''

	$prompt = ''

Detailed Description

Definition at line 5 of file DataValidation.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::__construct ( )

Create a new DataValidation.

Definition at line 126 of file DataValidation.php.

127 {

128 }

Member Function Documentation

◆ __clone()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::__clone ( )

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

Definition at line 470 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()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getAllowBlank ( )

Get Allow Blank.

Returns: bool

Definition at line 255 of file DataValidation.php.

    {
        return $this->allowBlank;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$allowBlank.

◆ getError()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getError ( )

Get Error.

Returns: string

Definition at line 375 of file DataValidation.php.

    {
        return $this->error;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$error.

◆ getErrorStyle()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getErrorStyle ( )

Get Error style.

Returns: string

Definition at line 207 of file DataValidation.php.

    {
        return $this->errorStyle;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$errorStyle.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\CellDataValidation\errorStyle().

Here is the caller graph for this function:

◆ getErrorTitle()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getErrorTitle ( )

Get Error title.

Returns: string

Definition at line 351 of file DataValidation.php.

    {
        return $this->errorTitle;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$errorTitle.

◆ getFormula1()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getFormula1 ( )

Get Formula 1.

Returns: string

Definition at line 135 of file DataValidation.php.

    {
        return $this->formula1;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$formula1.

◆ getFormula2()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getFormula2 ( )

Get Formula 2.

Returns: string

Definition at line 159 of file DataValidation.php.

    {
        return $this->formula2;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$formula2.

◆ getHashCode()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getHashCode ( )

Get hash code.

Returns: string Hash code

Definition at line 447 of file DataValidation.php.

    {
        return md5(
            $this->formula1 .
            $this->formula2 .
            $this->type .
            $this->errorStyle .
            $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 error().

Here is the call graph for this function:

◆ getOperator()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getOperator ( )

Get Operator.

Returns: string

Definition at line 231 of file DataValidation.php.

    {
        return $this->operator;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$operator.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\CellDataValidation\operator().

Here is the caller graph for this function:

◆ getPrompt()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getPrompt ( )

Get Prompt.

Returns: string

Definition at line 423 of file DataValidation.php.

    {
        return $this->prompt;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$prompt.

◆ getPromptTitle()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getPromptTitle ( )

Get Prompt title.

Returns: string

Definition at line 399 of file DataValidation.php.

    {
        return $this->promptTitle;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$promptTitle.

◆ getShowDropDown()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getShowDropDown ( )

Get Show DropDown.

Returns: bool

Definition at line 279 of file DataValidation.php.

    {
        return $this->showDropDown;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$showDropDown.

◆ getShowErrorMessage()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getShowErrorMessage ( )

Get Show ErrorMessage.

Returns: bool

Definition at line 327 of file DataValidation.php.

    {
        return $this->showErrorMessage;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$showErrorMessage.

◆ getShowInputMessage()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getShowInputMessage ( )

Get Show InputMessage.

Returns: bool

Definition at line 303 of file DataValidation.php.

    {
        return $this->showInputMessage;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$showInputMessage.

◆ getType()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::getType ( )

Get Type.

Returns: string

Definition at line 183 of file DataValidation.php.

    {
        return $this->type;
    }

References PhpOffice\PhpSpreadsheet\Cell\DataValidation\$type.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\CellDataValidation\type().

Here is the caller graph for this function:

◆ setAllowBlank()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setAllowBlank ( $value )

Set Allow Blank.

Parameters

bool $value

Returns: $this

Definition at line 267 of file DataValidation.php.

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

◆ setError()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setError ( $value )

Set Error.

Parameters

string $value

Returns: $this

Definition at line 387 of file DataValidation.php.

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

References error().

Here is the call graph for this function:

◆ setErrorStyle()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setErrorStyle ( $value )

Set Error style.

Parameters

string $value see self::STYLE_*

Returns: $this

Definition at line 219 of file DataValidation.php.

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

◆ setErrorTitle()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setErrorTitle ( $value )

Set Error title.

Parameters

string $value

Returns: $this

Definition at line 363 of file DataValidation.php.

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

◆ setFormula1()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setFormula1 ( $value )

Set Formula 1.

Parameters

string $value

Returns: $this

Definition at line 147 of file DataValidation.php.

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

◆ setFormula2()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setFormula2 ( $value )

Set Formula 2.

Parameters

string $value

Returns: $this

Definition at line 171 of file DataValidation.php.

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

◆ setOperator()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setOperator ( $value )

Set Operator.

Parameters

string $value

Returns: $this

Definition at line 243 of file DataValidation.php.

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

◆ setPrompt()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setPrompt ( $value )

Set Prompt.

Parameters

string $value

Returns: $this

Definition at line 435 of file DataValidation.php.

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

◆ setPromptTitle()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setPromptTitle ( $value )

Set Prompt title.

Parameters

string $value

Returns: $this

Definition at line 411 of file DataValidation.php.

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

◆ setShowDropDown()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setShowDropDown ( $value )

Set Show DropDown.

Parameters

bool $value

Returns: $this

Definition at line 291 of file DataValidation.php.

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

◆ setShowErrorMessage()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setShowErrorMessage ( $value )

Set Show ErrorMessage.

Parameters

bool $value

Returns: $this

Definition at line 339 of file DataValidation.php.

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

◆ setShowInputMessage()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setShowInputMessage ( $value )

Set Show InputMessage.

Parameters

bool $value

Returns: $this

Definition at line 315 of file DataValidation.php.

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

◆ setType()

PhpOffice\PhpSpreadsheet\Cell\DataValidation::setType ( $value )

Set Type.

Parameters

string $value

Returns: $this

Definition at line 195 of file DataValidation.php.

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

Field Documentation

◆ $allowBlank

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$allowBlank = false

private

Definition at line 72 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getAllowBlank().

◆ $error

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$error = ''

private

Definition at line 107 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getError().

◆ $errorStyle

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$errorStyle = self::STYLE_STOP

private

Definition at line 58 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getErrorStyle().

◆ $errorTitle

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$errorTitle = ''

private

Definition at line 100 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getErrorTitle().

◆ $formula1

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$formula1 = ''

private

Definition at line 37 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getFormula1().

◆ $formula2

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$formula2 = ''

private

Definition at line 44 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getFormula2().

◆ $operator

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$operator = self::OPERATOR_BETWEEN

private

Definition at line 65 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getOperator().

◆ $prompt

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$prompt = ''

private

Definition at line 121 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getPrompt().

◆ $promptTitle

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$promptTitle = ''

private

Definition at line 114 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getPromptTitle().

◆ $showDropDown

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$showDropDown = false

private

Definition at line 79 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getShowDropDown().

◆ $showErrorMessage

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$showErrorMessage = false

private

Definition at line 93 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getShowErrorMessage().

◆ $showInputMessage

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$showInputMessage = false

private

Definition at line 86 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getShowInputMessage().

◆ $type

PhpOffice\PhpSpreadsheet\Cell\DataValidation::$type = self::TYPE_NONE

private

Definition at line 51 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidation\getType().

◆ OPERATOR_BETWEEN

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_BETWEEN = 'between'

Definition at line 23 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\CellDataValidation\operator(), and PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ OPERATOR_EQUAL

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_EQUAL = 'equal'

Definition at line 24 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ OPERATOR_GREATERTHAN

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_GREATERTHAN = 'greaterThan'

Definition at line 25 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ OPERATOR_GREATERTHANOREQUAL

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual'

Definition at line 26 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ OPERATOR_LESSTHAN

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_LESSTHAN = 'lessThan'

Definition at line 27 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ OPERATOR_LESSTHANOREQUAL

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual'

Definition at line 28 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ OPERATOR_NOTBETWEEN

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_NOTBETWEEN = 'notBetween'

Definition at line 29 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ OPERATOR_NOTEQUAL

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::OPERATOR_NOTEQUAL = 'notEqual'

Definition at line 30 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ STYLE_INFORMATION

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::STYLE_INFORMATION = 'information'

Definition at line 20 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ STYLE_STOP

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::STYLE_STOP = 'stop'

Definition at line 18 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\CellDataValidation\errorStyle(), and PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ STYLE_WARNING

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::STYLE_WARNING = 'warning'

Definition at line 19 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ TYPE_CUSTOM

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_CUSTOM = 'custom'

Definition at line 9 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ TYPE_DATE

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_DATE = 'date'

Definition at line 10 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ TYPE_DECIMAL

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_DECIMAL = 'decimal'

Definition at line 11 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ TYPE_LIST

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_LIST = 'list'

Definition at line 12 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Cell\DataValidator\isValid(), and PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ TYPE_NONE

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_NONE = 'none'

Definition at line 8 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation(), and PhpOffice\PhpSpreadsheet\Writer\Xls\CellDataValidation\type().

◆ TYPE_TEXTLENGTH

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_TEXTLENGTH = 'textLength'

Definition at line 13 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ TYPE_TIME

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_TIME = 'time'

Definition at line 14 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

◆ TYPE_WHOLE

const PhpOffice\PhpSpreadsheet\Cell\DataValidation::TYPE_WHOLE = 'whole'

Definition at line 15 of file DataValidation.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDataValidation().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/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