CSStagingQueueFilter
in package
Tags
Table of Contents
- __construct() : mixed
- Represents a filter for the staging queue in the CSStagingFilterConnector.
- __toString() : string
- Magic function to handle string representation of the CSStagingQueueFilter object.
- addCondition() : CSStagingQueueFilter
- Adds a condition to the staging queue filter.
- addSubFilter() : CSStagingQueueFilter
- Adds a sub-filter to the staging queue filter.
- getConditions() : array<string|int, mixed>
- Returns the conditions used in the filter.
- getConnector() : CSStagingFilterConnector
- Retrieves the connector for the CSStagingQueueFilter.
- setConnector() : void
- Sets the connector for the CSStagingQueueFilter.
Methods
__construct()
Represents a filter for the staging queue in the CSStagingFilterConnector.
public
__construct([CSStagingFilterConnector $iConnector = CSStagingFilterConnector::AND ]) : mixed
This is used to provide a db-language agnostic interface to developers using the CSStagingQueue API.
Parameters
- $iConnector : CSStagingFilterConnector = CSStagingFilterConnector::AND
-
The staging filter connector to use. Defaults to CSStagingFilterConnector::AND.
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 CSStagingQueueFilter object.
addCondition()
Adds a condition to the staging queue filter.
public
addCondition(CSStagingQueueFilterCondition $oCondition) : CSStagingQueueFilter
Parameters
- $oCondition : CSStagingQueueFilterCondition
-
The condition to add.
Tags
Return values
CSStagingQueueFilter —The updated staging queue filter to allow method-chaining.
addSubFilter()
Adds a sub-filter to the staging queue filter.
public
addSubFilter(CSStagingQueueFilter $oSubFilter) : CSStagingQueueFilter
Parameters
- $oSubFilter : CSStagingQueueFilter
-
The sub-filter to be added.
Tags
Return values
CSStagingQueueFilter —The updated staging queue filter to allow method-chaining.
getConditions()
Returns the conditions used in the filter.
public
getConditions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The conditions for filtering
getConnector()
Retrieves the connector for the CSStagingQueueFilter.
public
getConnector() : CSStagingFilterConnector
Tags
Return values
CSStagingFilterConnector —The connector for the CSStagingQueueFilter.
setConnector()
Sets the connector for the CSStagingQueueFilter.
public
setConnector(CSStagingFilterConnector $iConnector) : void
Parameters
- $iConnector : CSStagingFilterConnector
-
The connector to set.