contao-community-alliance/dc-general » \ContaoCommunityAlliance\DcGeneral\Clipboard\Filter

Class Filter.

Methods

{@inheritdoc}

accepts(\ContaoCommunityAlliance\DcGeneral\Clipboard\ItemInterface $item)

SuppressWarnings	(PHPMD.UnusedLocalVariable)
SuppressWarnings	(PHPMD.EvalExpression)

Parameters

$item

And action is.

andActionIs(string $action) : static

Parameters

$action

string

The action name.

Returns

static

And action is in.

andActionIsIn(array|string[] $actions) : static

Parameters

$actions

arraystring[]

The action names.

Returns

static

And action is.

andActionIsNot(string $action) : static

Parameters

$action

string

The action name.

Returns

static

And action is not in.

andActionIsNotIn(array|string[] $actions) : static

Parameters

$actions

arraystring[]

The action names.

Returns

static

And has no parent.

andHasNoParent() : static

Returns

static

And model is.

andModelIs(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $modelId) : static

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The model id.

Returns

static

And model is from provider.

andModelIsFromProvider(string $modelProviderName) : static

Parameters

$modelProviderName

string

The provider name.

Returns

static

And model is not.

andModelIsNot(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $modelId) : static

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The model id.

Returns

static

And model is not from provider.

andModelIsNotFromProvider(string $modelProviderName) : static

Parameters

$modelProviderName

string

The provider name.

Returns

static

And parent is.

andParentIs(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $parentModelId) : static

Parameters

$parentModelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The parent id.

Returns

static

And parent is from provider.

andParentIsFromProvider(string $parentProviderName) : static

Parameters

$parentProviderName

string

The parent provider name.

Returns

static

And parent is in.

andParentIsIn(array|\ContaoCommunityAlliance\DcGeneral\Data\ModelId[] $parentModelIds) : static

Parameters

$parentModelIds

array\ContaoCommunityAlliance\DcGeneral\Data\ModelId[]

The parent ids.

Returns

static

And parent is not.

andParentIsNot(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $parentModelId) : static

Parameters

$parentModelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The parent id.

Returns

static

And parent is not from provider.

andParentIsNotFromProvider(string $parentProviderName) : static

Parameters

$parentProviderName

string

The parent provider name.

Returns

static

And parent is not in.

andParentIsNotIn(array|\ContaoCommunityAlliance\DcGeneral\Data\ModelId[] $parentModelIds) : static

Parameters

$parentModelIds

array\ContaoCommunityAlliance\DcGeneral\Data\ModelId[]

The parent ids.

Returns

static

And sub filter.

andSub(\ContaoCommunityAlliance\DcGeneral\Clipboard\Filter $filter) : static

Parameters

$filter

\ContaoCommunityAlliance\DcGeneral\Clipboard\Filter

The sub filter.

Returns

static

Factory method.

create() : static

Static

Returns

static

Return the expression.

getExpression() : string

internal

Returns

string

Return the variables.

getVariables() : array

internal

Returns

array

Or action is.

orActionIs(string $action) : static

Parameters

$action

string

The action name.

Returns

static

Or action is in.

orActionIsIn(array|string[] $actions) : static

Parameters

$actions

arraystring[]

The action names.

Returns

static

Or action is.

orActionIsNot(string $action) : static

Parameters

$action

string

The action name.

Returns

static

Or action is not in.

orActionIsNotIn(array|string[] $actions) : static

Parameters

$actions

arraystring[]

The action names.

Returns

static

Or has no parent.

orHasNoParent() : static

Returns

static

Or model is.

orModelIs(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $modelId) : static

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The model id.

Returns

static

Or model is from provider.

orModelIsFromProvider(string $modelProviderName) : static

Parameters

$modelProviderName

string

The provider name.

Returns

static

Or model is not.

orModelIsNot(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $modelId) : static

Parameters

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The model id.

Returns

static

Or model is not from provider.

orModelIsNotFromProvider(string $modelProviderName) : static

Parameters

$modelProviderName

string

The provider name.

Returns

static

Or parent is.

orParentIs(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $parentModelId) : static

Parameters

$parentModelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The parent id.

Returns

static

Or parent is from provider.

orParentIsFromProvider(string $parentProviderName) : static

Parameters

$parentProviderName

string

The parent provider name.

Returns

static

Or parent is in.

orParentIsIn(array|\ContaoCommunityAlliance\DcGeneral\Data\ModelId[] $parentModelIds) : static

Parameters

$parentModelIds

array\ContaoCommunityAlliance\DcGeneral\Data\ModelId[]

The parent ids.

Returns

static

Or parent is not.

orParentIsNot(\ContaoCommunityAlliance\DcGeneral\Data\ModelId $parentModelId) : static

Parameters

$parentModelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The parent id.

Returns

static

Or parent is not from provider.

orParentIsNotFromProvider(string $parentProviderName) : static

Parameters

$parentProviderName

string

The parent provider name.

Returns

static

Or parent is not in.

orParentIsNotIn(array|\ContaoCommunityAlliance\DcGeneral\Data\ModelId[] $parentModelIds) : static

Parameters

$parentModelIds

array\ContaoCommunityAlliance\DcGeneral\Data\ModelId[]

The parent ids.

Returns

static

Or sub filter.

orSub(\ContaoCommunityAlliance\DcGeneral\Clipboard\Filter $filter) : static

Parameters

$filter

\ContaoCommunityAlliance\DcGeneral\Clipboard\Filter

The sub filter.

Returns

static

Add action is.

actionIs(string $conjunction, string $action) : static

Parameters

$conjunction

string

AND or OR.

$action

string

The action name.

Returns

static

Add action is in.

actionIsIn(string $conjunction, array|string[] $actions) : static

Parameters

$conjunction

string

AND or OR.

$actions

arraystring[]

The action names.

Returns

static

Add action is.

actionIsNot(string $conjunction, string $action) : static

Parameters

$conjunction

string

AND or OR.

$action

string

The action name.

Returns

static

Add action is not in.

actionIsNotIn(string $conjunction, array|string[] $actions) : static

Parameters

$conjunction

string

AND or OR.

$actions

arraystring[]

The action names.

Returns

static

Add has no parent.

hasNoParent(string $conjunction) : static

Parameters

$conjunction

string

AND or OR.

Returns

static

Add model is.

modelIs(string $conjunction, \ContaoCommunityAlliance\DcGeneral\Data\ModelId $modelId) : static

Parameters

$conjunction

string

AND or OR.

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The model id.

Returns

static

Add model is from provider fragment.

modelIsFromProvider(string $conjunction, string $modelProviderName) : static

Parameters

$conjunction

string

AND or OR.

$modelProviderName

string

The provider name.

Returns

static

Add model is not.

modelIsNot(string $conjunction, \ContaoCommunityAlliance\DcGeneral\Data\ModelId $modelId) : static

Parameters

$conjunction

string

AND or OR.

$modelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The model id.

Returns

static

Add model is not from provider.

modelIsNotFromProvider(string $conjunction, string $modelProviderName) : static

Parameters

$conjunction

string

AND or OR.

$modelProviderName

string

The provider name.

Returns

static

Add parent is.

parentIs(string $conjunction, \ContaoCommunityAlliance\DcGeneral\Data\ModelId $parentModelId) : static

Parameters

$conjunction

string

AND or OR.

$parentModelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The parent id.

Returns

static

Add parent is from provider.

parentIsFromProvider(string $conjunction, string $parentProviderName) : static

Parameters

$conjunction

string

AND or OR.

$parentProviderName

string

The parent provider name.

Returns

static

Add parent is in.

parentIsIn(string $conjunction, array|\ContaoCommunityAlliance\DcGeneral\Data\ModelId[] $parentModelIds) : static

Parameters

$conjunction

string

AND or OR.

$parentModelIds

array\ContaoCommunityAlliance\DcGeneral\Data\ModelId[]

The parent ids.

Returns

static

Add parent is not.

parentIsNot(string $conjunction, \ContaoCommunityAlliance\DcGeneral\Data\ModelId $parentModelId) : static

Parameters

$conjunction

string

AND or OR.

$parentModelId

\ContaoCommunityAlliance\DcGeneral\Data\ModelId

The parent id.

Returns

static

And parent is not from provider.

parentIsNotFromProvider(string $conjunction, string $parentProviderName) : static

Parameters

$conjunction

string

AND or OR.

$parentProviderName

string

The parent provider name.

Returns

static

Add parent is not in.

parentIsNotIn(string $conjunction, array|\ContaoCommunityAlliance\DcGeneral\Data\ModelId[] $parentModelIds) : static

Parameters

$conjunction

string

AND or OR.

$parentModelIds

array\ContaoCommunityAlliance\DcGeneral\Data\ModelId[]

The parent ids.

Returns

static

Add sub filter.

sub(string $conjunction, \ContaoCommunityAlliance\DcGeneral\Clipboard\Filter $filter) : static

Parameters

$conjunction

string

AND or OR.

$filter

\ContaoCommunityAlliance\DcGeneral\Clipboard\Filter

The sub filter.

Returns

static

Properties

Pre-compiled expression.

$compiled : string

The expression parts.

$expression : array

The expression variables.

$variables : array

Constants

ACTION_IS_EXPRESSION

ACTION_IS_EXPRESSION

ACTION_IS_NOT_EXPRESSION

ACTION_IS_NOT_EXPRESSION

HAS_NO_PARENT_EXPRESSION

HAS_NO_PARENT_EXPRESSION

MODEL_IS_EXPRESSION

MODEL_IS_EXPRESSION

MODEL_IS_FROM_PROVIDER_EXPRESSION

MODEL_IS_FROM_PROVIDER_EXPRESSION

MODEL_IS_NOT_EXPRESSION

MODEL_IS_NOT_EXPRESSION

MODEL_IS_NOT_FROM_PROVIDER_EXPRESSION

MODEL_IS_NOT_FROM_PROVIDER_EXPRESSION

PARENT_IS_EXPRESSION

PARENT_IS_EXPRESSION

PARENT_IS_FROM_PROVIDER_EXPRESSION

PARENT_IS_FROM_PROVIDER_EXPRESSION

PARENT_IS_NOT_EXPRESSION

PARENT_IS_NOT_EXPRESSION

PARENT_IS_NOT_FROM_PROVIDER_EXPRESSION

PARENT_IS_NOT_FROM_PROVIDER_EXPRESSION