\OntologyWrapper\traitsEntityFax

Entity fax trait

This trait implements a method for managing the entity telefax number offset, {@link kTAG_ENTITY_FAX}. The method manages the individual telefax numbers by type.

Summary

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

EntityFax()

EntityFax(string $theType, mixed $theValue, boolean $getOld) : mixed

Manage telefax number

This method can be used to add, retrieve and delete individual telefax numbers by type, while managing all the telefaxes as a whole can be done using the {@link kTAG_ENTITY_FAX} offset.

The method expects the following parameters:

  • $theType: This parameter holds the type of the telefax number we want to manage. If NULL, it means that there is a fax without a type; this can occur if the telefax is the default one.
  • $theValue: This parameter identifies the telefax number or operation:
    • NULL: Return the fax of the provided type.
    • FALSE: Delete the fax of the provided type.
    • other: Any other value is cast to string and interpreted as the telefax number of provided type 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 fax number, or NULL if the type was not matched.

Parameters

string $theType

Telephone number type.

mixed $theValue

Telephone number or operation.

boolean $getOld

TRUE get old value.

Returns

mixed —

Old or new value.