Element¶
- class Element¶
Package: Record
An element and its metadata.
- property element_set_id¶
- property order¶
- property name¶
- property description¶
- property comment¶
- setElementSet(string $elementSetName)¶
Set the element set for the element.
Parameters: - $elementSetName (string) –
Returns: void
- getElementSet()¶
Return the ElementSet objection for this element.
Returns: ElementSet
- setOrder(integer $order)¶
Set the order of the element within its element set.
Parameters: - $order (integer) –
Returns: void
- setName(string $name)¶
Set the name of the element.
Parameters: - $name (string) –
Returns: void
- setDescription(string $description)¶
Set the description for the element.
Parameters: - $description (string) –
Returns: void
- setComment($comment)¶
Parameters: - $comment (unknown) –
- setArray(array|string $data)¶
Parameters: - $data (array|string) –
If string, it’s the name of the element. Otherwise, array of metadata for the element. May contain the following keys in the array:
- name
- description
- comment
- order
- element_set_id
- element_set
Returns: void
- $data (array|string) –
- _validate()¶
Validate the element prior to being saved.
Checks the following criteria:
- Name is not empty.
- Name does not already exist within the given element set.
- _delete()¶
When deleting an element, cascade delete all element texts and item type assignments associated with the element.
- _getElementSetId($elementSetName)¶
Retrieve the element set ID from the name.
Parameters: - $elementSetName (unknown) –
Returns: int
- _nameIsInSet($elementName, $elementSetId)¶
Calculate whether the element’s name already belongs to the current set.
Parameters: - $elementName (unknown) –
- $elementSetId (unknown) –
Returns: boolean