Documentation

CellValue extends WizardAbstract
in package
implements WizardInterface

Table of Contents

Interfaces

WizardInterface

Constants

MAGIC_OPERATIONS  = ['equals' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_EQUAL, 'notEquals' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NOTEQUAL, 'greaterThan' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_GREATERTHAN, 'greaterThanOrEqual' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_GREATERTHANOREQUAL, 'lessThan' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHAN, 'lessThanOrEqual' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHANOREQUAL, 'between' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_BETWEEN, 'notBetween' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NOTBETWEEN]
RANGE_OPERATORS  = \PhpOffice\PhpSpreadsheet\Style\ConditionalFormatting\CellMatcher::COMPARISON_RANGE_OPERATORS
SINGLE_OPERATORS  = \PhpOffice\PhpSpreadsheet\Style\ConditionalFormatting\CellMatcher::COMPARISON_OPERATORS

Properties

$cellRange  : string
$expression  : string
$operand  : array<string|int, mixed>
$operandValueType  : array<string|int, string>
$operator  : string
$referenceCell  : string
$referenceColumn  : int
$referenceRow  : int
$stopIfTrue  : bool
$style  : Style|null

Methods

__call()  : self
__construct()  : mixed
and()  : CellValue
between()  : CellValue
equals()  : CellValue
fromConditional()  : WizardInterface
getCellRange()  : string
getConditional()  : Conditional
getStopIfTrue()  : bool
getStyle()  : Style
greaterThan()  : CellValue
greaterThanOrEqual()  : CellValue
lessThan()  : CellValue
lessThanOrEqual()  : CellValue
notBetween()  : CellValue
notEquals()  : CellValue
reverseAdjustCellRef()  : string
setCellRange()  : void
setStopIfTrue()  : void
setStyle()  : void
adjustConditionsForCellReferences()  : array<string|int, mixed>
cellConditionCheck()  : string
conditionCellAdjustment()  : string
operand()  : void
operator()  : void
reverseCellAdjustment()  : string
setReferenceCellForExpressions()  : void
unwrapString()  : string
validateOperand()  : string
wrapValue()  : float|int|string

Constants

MAGIC_OPERATIONS

protected mixed MAGIC_OPERATIONS = ['equals' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_EQUAL, 'notEquals' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NOTEQUAL, 'greaterThan' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_GREATERTHAN, 'greaterThanOrEqual' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_GREATERTHANOREQUAL, 'lessThan' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHAN, 'lessThanOrEqual' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_LESSTHANOREQUAL, 'between' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_BETWEEN, 'notBetween' => \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_NOTBETWEEN]

RANGE_OPERATORS

protected mixed RANGE_OPERATORS = \PhpOffice\PhpSpreadsheet\Style\ConditionalFormatting\CellMatcher::COMPARISON_RANGE_OPERATORS

SINGLE_OPERATORS

protected mixed SINGLE_OPERATORS = \PhpOffice\PhpSpreadsheet\Style\ConditionalFormatting\CellMatcher::COMPARISON_OPERATORS

Properties

$operand

protected array<string|int, mixed> $operand = [0]

$operandValueType

protected array<string|int, string> $operandValueType = []

$operator

protected string $operator = \PhpOffice\PhpSpreadsheet\Style\Conditional::OPERATOR_EQUAL

Methods

__call()

public __call(string $methodName, array<string|int, mixed> $arguments) : self
Parameters
$methodName : string
$arguments : array<string|int, mixed>
Return values
self

__construct()

public __construct(string $cellRange) : mixed
Parameters
$cellRange : string

and()

public and([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

between()

public between([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

equals()

public equals([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

getCellRange()

public getCellRange() : string
Return values
string

getStopIfTrue()

public getStopIfTrue() : bool
Return values
bool

greaterThan()

public greaterThan([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

greaterThanOrEqual()

public greaterThanOrEqual([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

lessThan()

public lessThan([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

lessThanOrEqual()

public lessThanOrEqual([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

notBetween()

public notBetween([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

notEquals()

public notEquals([mixed $value = ][, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : CellValue
Parameters
$value : mixed =
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
CellValue

reverseAdjustCellRef()

public static reverseAdjustCellRef(string $condition, string $cellRange) : string
Parameters
$condition : string
$cellRange : string
Return values
string

setCellRange()

public setCellRange(string $cellRange) : void
Parameters
$cellRange : string

setStopIfTrue()

public setStopIfTrue(bool $stopIfTrue) : void
Parameters
$stopIfTrue : bool

adjustConditionsForCellReferences()

protected adjustConditionsForCellReferences(array<string|int, mixed> $conditions) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>
Return values
array<string|int, mixed>

cellConditionCheck()

protected cellConditionCheck(string $condition) : string
Parameters
$condition : string
Return values
string

conditionCellAdjustment()

protected conditionCellAdjustment(array<string|int, mixed> $matches) : string
Parameters
$matches : array<string|int, mixed>
Return values
string

operand()

protected operand(int $index, mixed $operand[, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : void
Parameters
$index : int
$operand : mixed
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL

operator()

protected operator(string $operator) : void
Parameters
$operator : string

reverseCellAdjustment()

protected static reverseCellAdjustment(array<string|int, mixed> $matches, int $referenceColumn, int $referenceRow) : string
Parameters
$matches : array<string|int, mixed>
$referenceColumn : int
$referenceRow : int
Return values
string

setReferenceCellForExpressions()

protected setReferenceCellForExpressions(string $conditionalRange) : void
Parameters
$conditionalRange : string

unwrapString()

protected static unwrapString(string $condition) : string
Parameters
$condition : string
Return values
string

validateOperand()

protected validateOperand(string $operand[, string $operandValueType = Wizard::VALUE_TYPE_LITERAL ]) : string
Parameters
$operand : string
$operandValueType : string = Wizard::VALUE_TYPE_LITERAL
Return values
string

wrapValue()

protected wrapValue(null|bool|float|int|string $value, string $operandValueType) : float|int|string
Parameters
$value : null|bool|float|int|string

value to be wrapped

$operandValueType : string
Return values
float|int|string

        
On this page

Search results