class EqualityConstraint implements ConstraintInterface

EqualityConstraint class.

The EqualityConstraint can be used to compare a resource's field or meta dataagainst a specific value.

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

{
  "equals": [{"doc": "sys.type"}, "Asset"]
}

Methods

__construct(string $doc = '', mixed|null $value = null)

InConstraint constructor.

string
getDoc()

No description

setDoc(string $doc)

No description

mixed|null
getValue()

No description

setValue(mixed $value)

No description

array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Details

at line 46
__construct(string $doc = '', mixed|null $value = null)

InConstraint constructor.

Parameters

string $doc
mixed|null $value

at line 55
string getDoc()

Return Value

string

at line 65
EqualityConstraint setDoc(string $doc)

Parameters

string $doc

Return Value

EqualityConstraint

at line 75
mixed|null getValue()

Return Value

mixed|null

at line 85
EqualityConstraint setValue(mixed $value)

Parameters

mixed $value

Return Value

EqualityConstraint

at line 97
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array