CSStagingQueueFilterCondition
in package
Condition object to be used with the CSStagingQueueFilter.
Tags
Table of Contents
- __construct() : mixed
- Constructor for CSStagingQueueFilterCondition class.
- __toString() : string
- Magic function to handle string representation of the CSStagingQueueFilter object.
- getComparator() : CSStagingFilterComparator
- Get the comparator for the CSStagingQueueFilterCondition.
- getField() : mixed
- Retrieves the field used for filtering the staging queue condition.
- getValue() : mixed
- Get the value of the CSStagingQueueFilterCondition.
- setComparator() : void
- Sets the comparator for the CSStagingQueueFilterCondition.
- setField() : void
- Sets the field for the CSStagingQueueFilterCondition.
- setValue() : void
- Sets the value for the CSStagingQueueFilterCondition.
Methods
__construct()
Constructor for CSStagingQueueFilterCondition class.
public
__construct(mixed $mField, CSStagingFilterComparator $iComparator, mixed $mValue) : mixed
Parameters
- $mField : mixed
-
The field to filter on.
- $iComparator : CSStagingFilterComparator
-
The comparator to use for the filter.
- $mValue : mixed
-
The value to compare against.
Tags
Return values
mixed —__toString()
Magic function to handle string representation of the CSStagingQueueFilter object.
public
__toString() : string
Tags
Return values
string —The string representation of the CSStagingQueueFilterCondition object.
getComparator()
Get the comparator for the CSStagingQueueFilterCondition.
public
getComparator() : CSStagingFilterComparator
Tags
Return values
CSStagingFilterComparator —The comparator for the CSStagingQueueFilterCondition.
getField()
Retrieves the field used for filtering the staging queue condition.
public
getField() : mixed
Tags
Return values
mixed —The field used for filtering.
getValue()
Get the value of the CSStagingQueueFilterCondition.
public
getValue() : mixed
Tags
Return values
mixed —The value of the CSStagingQueueFilterCondition.
setComparator()
Sets the comparator for the CSStagingQueueFilterCondition.
public
setComparator(CSStagingFilterComparator $iComparator) : void
Parameters
- $iComparator : CSStagingFilterComparator
-
The comparator to set.
Tags
Return values
void —setField()
Sets the field for the CSStagingQueueFilterCondition.
public
setField(mixed $mField) : void
Parameters
- $mField : mixed
-
The field value to set.
Tags
Return values
void —setValue()
Sets the value for the CSStagingQueueFilterCondition.
public
setValue(mixed $mValue) : void
Parameters
- $mValue : mixed
-
The value to be set.