Description()
Description(string $theLanguage, mixed $theValue, boolean $getOld) : mixed
Manage term description
This method can be used to add, retrieve and delete individual definitions by language, while managing all the definitions as a whole can be done using the {@link kTAG_DEFINITION} offset.
The method expects the following parameters:
- $theLanguage: This parameter holds the language code of the text we want to manage. The NULL value should only be used if the label is not related to a specific language.
- $theValue: This parameter identifies the definition text or operation:
- NULL: Return the definition of the provided language.
- FALSE: Delete the definition of the provided language.
- other: Any other value is cast to string and interpreted as the text of the definition in the provided language which will be inserted, or that will replace an existing entry.
- $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 definition text, or NULL if the language was not matched.
Parameters
| string | $theLanguage | Description language. |
| mixed | $theValue | Description text or operation. |
| boolean | $getOld | TRUE get old value. |
Returns
mixed —Old or new value.