\OntologyWrapper\traitsEntityKind

EntityKind trait

This trait implements a method for managing the entity kind offset, {@link kTAG_ENTITY_KIND}. The method allows the management of the individual elements of the enumerated set.

Summary

Methods
Properties
Constants
EntityKind()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

EntityKind()

EntityKind(string $theValue, mixed $theOperation, boolean $getOld) : mixed

Manage entity kind

This method can be used to add, retrieve and delete individual entity kind enumerated values; to manage the enumerated set as a whole, use the {@link kTAG_ENTITY_KIND} offset.

The method expects the following parameters:

  • $theValue: This parameter represents the enumerated value we want to manage.
  • $theOperation: This parameter identifies the operation:
    • NULL: Return the enumerated value, if it exists, or NULL.
    • FALSE: Delete the enumerated value, if it exists.
    • other: Any other value means that we want to set the enumerated value provided in the previous parameter.
  • $getOld: Determines what the method will return:
    • TRUE: Return the value before it was eventually modified.
    • FALSE: Return the value after it was eventually modified.

The method will return either the enumerated value, or NULL if the value was not matched.

Parameters

string $theValue

Data type.

mixed $theOperation

Operation.

boolean $getOld

TRUE get old value.

Returns

mixed —

Old or new value.