Ontology Wrapper
\
OntologyWrapper
traits

\OntologyWrapper\traitsSynonym

Synonym trait

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

Summary

Methods
Properties
Constants
Synonym()
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

Synonym()

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

Manage synonym

This method can be used to add, retrieve and delete individual synonym stringss; to manage the synonym set as a whole, use the {@link kTAG_SYNONYM} offset.

The method expects the following parameters:

  • $theValue: This parameter represents the synonym we want to manage.
  • $theOperation: This parameter identifies the operation:
    • NULL: Return the synonym, if it exists, or NULL.
    • FALSE: Delete the synonym, if it exists.
    • other: Any other value means that we want to set the synonym 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 synonym, or NULL if the value was not matched.

Parameters

string $theValue

Synonym.
mixed $theOperation

Operation.
boolean $getOld

TRUE get old value.

Returns

mixed —

Old or new value.