Documentation

DataValidation
in package

Table of Contents

Constants

OPERATOR_BETWEEN  = 'between'
OPERATOR_EQUAL  = 'equal'
OPERATOR_GREATERTHAN  = 'greaterThan'
OPERATOR_GREATERTHANOREQUAL  = 'greaterThanOrEqual'
OPERATOR_LESSTHAN  = 'lessThan'
OPERATOR_LESSTHANOREQUAL  = 'lessThanOrEqual'
OPERATOR_NOTBETWEEN  = 'notBetween'
OPERATOR_NOTEQUAL  = 'notEqual'
STYLE_INFORMATION  = 'information'
STYLE_STOP  = 'stop'
STYLE_WARNING  = 'warning'
TYPE_CUSTOM  = 'custom'
TYPE_DATE  = 'date'
TYPE_DECIMAL  = 'decimal'
TYPE_LIST  = 'list'
TYPE_NONE  = 'none'
TYPE_TEXTLENGTH  = 'textLength'
TYPE_TIME  = 'time'
TYPE_WHOLE  = 'whole'
DEFAULT_OPERATOR  = self::OPERATOR_BETWEEN

Properties

$allowBlank  : bool
Allow Blank.
$error  : string
Error.
$errorStyle  : string
Error style.
$errorTitle  : string
Error title.
$formula1  : string
Formula 1.
$formula2  : string
Formula 2.
$operator  : string
Operator.
$prompt  : string
Prompt.
$promptTitle  : string
Prompt title.
$showDropDown  : bool
Show DropDown.
$showErrorMessage  : bool
Show ErrorMessage.
$showInputMessage  : bool
Show InputMessage.
$sqref  : string|null
$type  : string
Type.

Methods

__clone()  : mixed
Implement PHP __clone to create a deep clone, not just a shallow copy.
__construct()  : mixed
Create a new DataValidation.
getAllowBlank()  : bool
Get Allow Blank.
getError()  : string
Get Error.
getErrorStyle()  : string
Get Error style.
getErrorTitle()  : string
Get Error title.
getFormula1()  : string
Get Formula 1.
getFormula2()  : string
Get Formula 2.
getHashCode()  : string
Get hash code.
getOperator()  : string
Get Operator.
getPrompt()  : string
Get Prompt.
getPromptTitle()  : string
Get Prompt title.
getShowDropDown()  : bool
Get Show DropDown.
getShowErrorMessage()  : bool
Get Show ErrorMessage.
getShowInputMessage()  : bool
Get Show InputMessage.
getSqref()  : string|null
getType()  : string
Get Type.
setAllowBlank()  : $this
Set Allow Blank.
setError()  : $this
Set Error.
setErrorStyle()  : $this
Set Error style.
setErrorTitle()  : $this
Set Error title.
setFormula1()  : $this
Set Formula 1.
setFormula2()  : $this
Set Formula 2.
setOperator()  : $this
Set Operator.
setPrompt()  : $this
Set Prompt.
setPromptTitle()  : $this
Set Prompt title.
setShowDropDown()  : $this
Set Show DropDown.
setShowErrorMessage()  : $this
Set Show ErrorMessage.
setShowInputMessage()  : $this
Set Show InputMessage.
setSqref()  : self
setType()  : $this
Set Type.

Constants

OPERATOR_GREATERTHAN

public mixed OPERATOR_GREATERTHAN = 'greaterThan'

OPERATOR_GREATERTHANOREQUAL

public mixed OPERATOR_GREATERTHANOREQUAL = 'greaterThanOrEqual'

OPERATOR_LESSTHANOREQUAL

public mixed OPERATOR_LESSTHANOREQUAL = 'lessThanOrEqual'

OPERATOR_NOTBETWEEN

public mixed OPERATOR_NOTBETWEEN = 'notBetween'

STYLE_INFORMATION

public mixed STYLE_INFORMATION = 'information'

DEFAULT_OPERATOR

private mixed DEFAULT_OPERATOR = self::OPERATOR_BETWEEN

Properties

$errorStyle

Error style.

private string $errorStyle = self::STYLE_STOP

$operator

Operator.

private string $operator = self::DEFAULT_OPERATOR

$showErrorMessage

Show ErrorMessage.

private bool $showErrorMessage = false

$showInputMessage

Show InputMessage.

private bool $showInputMessage = false

Methods

__clone()

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

public __clone() : mixed

__construct()

Create a new DataValidation.

public __construct() : mixed

getAllowBlank()

Get Allow Blank.

public getAllowBlank() : bool
Return values
bool

getError()

Get Error.

public getError() : string
Return values
string

getErrorStyle()

Get Error style.

public getErrorStyle() : string
Return values
string

getErrorTitle()

Get Error title.

public getErrorTitle() : string
Return values
string

getFormula1()

Get Formula 1.

public getFormula1() : string
Return values
string

getFormula2()

Get Formula 2.

public getFormula2() : string
Return values
string

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string

Hash code

getOperator()

Get Operator.

public getOperator() : string
Return values
string

getPrompt()

Get Prompt.

public getPrompt() : string
Return values
string

getPromptTitle()

Get Prompt title.

public getPromptTitle() : string
Return values
string

getShowDropDown()

Get Show DropDown.

public getShowDropDown() : bool
Return values
bool

getShowErrorMessage()

Get Show ErrorMessage.

public getShowErrorMessage() : bool
Return values
bool

getShowInputMessage()

Get Show InputMessage.

public getShowInputMessage() : bool
Return values
bool

getSqref()

public getSqref() : string|null
Return values
string|null

getType()

Get Type.

public getType() : string
Return values
string

setAllowBlank()

Set Allow Blank.

public setAllowBlank(bool $allowBlank) : $this
Parameters
$allowBlank : bool
Return values
$this

setError()

Set Error.

public setError(string $error) : $this
Parameters
$error : string
Return values
$this

setErrorStyle()

Set Error style.

public setErrorStyle(string $errorStyle) : $this
Parameters
$errorStyle : string

see self::STYLE_*

Return values
$this

setErrorTitle()

Set Error title.

public setErrorTitle(string $errorTitle) : $this
Parameters
$errorTitle : string
Return values
$this

setFormula1()

Set Formula 1.

public setFormula1(string $formula) : $this
Parameters
$formula : string
Return values
$this

setFormula2()

Set Formula 2.

public setFormula2(string $formula) : $this
Parameters
$formula : string
Return values
$this

setOperator()

Set Operator.

public setOperator(string $operator) : $this
Parameters
$operator : string
Return values
$this

setPrompt()

Set Prompt.

public setPrompt(string $prompt) : $this
Parameters
$prompt : string
Return values
$this

setPromptTitle()

Set Prompt title.

public setPromptTitle(string $promptTitle) : $this
Parameters
$promptTitle : string
Return values
$this

setShowDropDown()

Set Show DropDown.

public setShowDropDown(bool $showDropDown) : $this
Parameters
$showDropDown : bool
Return values
$this

setShowErrorMessage()

Set Show ErrorMessage.

public setShowErrorMessage(bool $showErrorMessage) : $this
Parameters
$showErrorMessage : bool
Return values
$this

setShowInputMessage()

Set Show InputMessage.

public setShowInputMessage(bool $showInputMessage) : $this
Parameters
$showInputMessage : bool
Return values
$this

setSqref()

public setSqref(string|null $str) : self
Parameters
$str : string|null
Return values
self

setType()

Set Type.

public setType(string $type) : $this
Parameters
$type : string
Return values
$this

        
On this page

Search results