class EqualityFilter implements FilterInterface

EqualityFilter class.

The EqualityFilter can be used to compare a resource's field or metadata against a specific value.

EqualityFilters are one of the very basic filters and are typically used ensure the type of a document or to match entries of a content type:

{
  "equals": [{"doc": "sys.environment.sys.id"}, "staging"]
}

Methods

__construct(string $doc, string $value)

EqualityFilter constructor.

string
getDoc()

No description

setDoc(string $doc)

No description

string
getValue()

No description

setValue(string $value)

No description

jsonSerialize()

{@inheritdoc}

Details

at line 47
__construct(string $doc, string $value)

EqualityFilter constructor.

Parameters

string $doc
string $value

at line 56
string getDoc()

Return Value

string

at line 66
EqualityFilter setDoc(string $doc)

Parameters

string $doc

Return Value

EqualityFilter

at line 76
string getValue()

Return Value

string

at line 86
EqualityFilter setValue(string $value)

Parameters

string $value

Return Value

EqualityFilter

at line 96
jsonSerialize()

{@inheritdoc}