Contentserv PHP API

CSRuleApiRuleStatusFilter extends ObjectDatabaseSearchFilter
in package

Tags

Table of Contents

FILTER_TYPE_MATCH  = 'match'
FILTER_TYPE_RANGE  = 'range'
FILTER_TYPE_TERMS  = 'terms'
FILTER_TYPE_WILDCARD  = 'wildcard'
TYPE_AND  = 1
TYPE_NOT  = 3
TYPE_OR  = 2
__construct()  : mixed
addMatchFilter()  : void
addRangeFilter()  : void
addSubFilter()  : void
addTermsFilter()  : void
addWildcardFilter()  : void
createFilter()  : CSRuleApiRuleStatusFilter
Creates a plain rule status filter object.
getDefinition()  : array<string|int, mixed>
getFilterRecordClassName()  : string|null
Returns the rulestatus class name.
getType()  : int
setContextClassConfigurationFilter()  : mixed
Sets the filter for the given context configuration class ids.
setContextClassFilter()  : mixed
Sets the filter for the given context class ids.
setContextFilter()  : bool
Sets the filter for the given context ids.
setContextStatusFilter()  : mixed
Sets the filter for the given context status ids.
setLanguageFilter()  : mixed
Sets the filter for the given language ids.
setLastUpdatedIsNewerThanDateTimeFilter()  : mixed
Sets the filter for the "last updated is newer than date time".
setLastUpdatedIsOlderThanDateTimeFilter()  : mixed
Sets the filter for the "last updated is older than date time".
setOutdatedFilter()  : mixed
Sets the filter whether only outdated records should be returned or all.
setRuleIdsFilter()  : mixed
Sets the filter for the given rule ids.
setRuleTypeFilter()  : mixed
Sets the filter for the given rule type.
setStatusFilter()  : mixed
Sets the filter for the given status ids.
setTagsFilter()  : mixed
Sets the filter for the given tag ids

Constants

Methods

__construct()

public __construct([int $iType = self::TYPE_AND ]) : mixed
Parameters
$iType : int = self::TYPE_AND
Tags
Return values
mixed —

getDefinition()

public final getDefinition() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

getFilterRecordClassName()

Returns the rulestatus class name.

public getFilterRecordClassName() : string|null
Tags
access

public

Return values
string|null —

setContextClassConfigurationFilter()

Sets the filter for the given context configuration class ids.

public setContextClassConfigurationFilter(int|array<string|int, mixed> $mContextConfigurationClassIds) : mixed
Parameters
$mContextConfigurationClassIds : int|array<string|int, mixed>

An array with the context configuration class ids or an id with one context configuration class id.

Tags
Return values
mixed —

setContextClassFilter()

Sets the filter for the given context class ids.

public setContextClassFilter(int|array<string|int, mixed> $mObjectClassIds) : mixed
Parameters
$mObjectClassIds : int|array<string|int, mixed>

An array with the context class ids or an id with one context class id.

Tags
Return values
mixed —

setContextFilter()

Sets the filter for the given context ids.

public setContextFilter(int|array<string|int, mixed> $mContextIds) : bool
Parameters
$mContextIds : int|array<string|int, mixed>

An array with the context ids or an id with one context id.

Tags
Return values
bool —

whether the filter has been successfully added to the filter object.

setContextStatusFilter()

Sets the filter for the given context status ids.

public setContextStatusFilter(int|array<string|int, mixed> $mContextStatusIds) : mixed
Parameters
$mContextStatusIds : int|array<string|int, mixed>

An array with the context status ids or an id with one context status id.

Tags
Return values
mixed —

setLanguageFilter()

Sets the filter for the given language ids.

public setLanguageFilter(int|array<string|int, mixed> $mLanguageIds) : mixed
Parameters
$mLanguageIds : int|array<string|int, mixed>

An array with the language ids or an id with one language id.

Tags
Return values
mixed —

setLastUpdatedIsNewerThanDateTimeFilter()

Sets the filter for the "last updated is newer than date time".

public setLastUpdatedIsNewerThanDateTimeFilter(string $sDateTime) : mixed
Parameters
$sDateTime : string

The date time to compare with the last updated time.

Tags
Return values
mixed —

setLastUpdatedIsOlderThanDateTimeFilter()

Sets the filter for the "last updated is older than date time".

public setLastUpdatedIsOlderThanDateTimeFilter(string $sDateTime) : mixed
Parameters
$sDateTime : string

The date time to compare with the last updated time.

Tags
Return values
mixed —

setOutdatedFilter()

Sets the filter whether only outdated records should be returned or all.

public setOutdatedFilter(bool $bIsOutdated) : mixed
Parameters
$bIsOutdated : bool

Whether only outdated records should return or all.

Tags
Return values
mixed —

setRuleIdsFilter()

Sets the filter for the given rule ids.

public setRuleIdsFilter(int|array<string|int, mixed> $mRuleIds) : mixed
Parameters
$mRuleIds : int|array<string|int, mixed>

An array or an id of rule ids.

Tags
Return values
mixed —

setRuleTypeFilter()

Sets the filter for the given rule type.

public setRuleTypeFilter(string|array<string|int, mixed> $mRuleTypes) : mixed
Parameters
$mRuleTypes : string|array<string|int, mixed>

An array with the rule types or a string with one rule type.

Tags
Return values
mixed —

setStatusFilter()

Sets the filter for the given status ids.

public setStatusFilter(int|array<string|int, mixed> $mStatus) : mixed
Parameters
$mStatus : int|array<string|int, mixed>

An array with the status ids or an id with one status id.

Tags
Return values
mixed —

setTagsFilter()

Sets the filter for the given tag ids

public setTagsFilter(int|array<string|int, mixed> $mTags) : mixed
Parameters
$mTags : int|array<string|int, mixed>

An array with the tag ids or an id with one tag id.

Tags
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results