Omeka_View_Helper_AllElementTexts¶
- class Omeka_View_Helper_AllElementTexts¶
Package: View\Helper
View helper for retrieving lists of metadata for any record that uses Mixin_ElementText.
- property _record¶
The record being printed.
- property _showEmptyElements¶
Flag to indicate whether to show elements that do not have text.
- property _emptyElementString¶
String to display if elements without text are shown.
- property _elementSetsToShow¶
Element sets to list.
- property _returnType¶
Type of data to return.
- property _partial¶
Path for the view partial.
- allElementTexts(Omeka_Record_AbstractRecord|string $record, array $options = Array)¶
Get the record metadata list.
Parameters: - $record (Omeka_Record_AbstractRecord|string) – Record to retrieve metadata from.
- $options (array) – Available options: - show_empty_elements’ => bool|string Whether to show elements that do not contain text. A string will set self::$_showEmptyElements to true and set self::$_emptyElementString to the provided string. - ‘show_element_sets’ => array List of names of element sets to display. - ‘return_type’ => string ‘array’, ‘html’. Defaults to ‘html’.
Returns: string|array
- _setOptions(array $options)¶
Set the options.
Parameters: - $options (array) –
Returns: void
- _getElementsBySet()¶
Get an array of all element sets containing their respective elements.
Returns: array
- _filterItemTypeElements(array $elementsBySet)¶
Filter the display of the Item Type element set, if present.
Parameters: - $elementsBySet (array) –
Returns: array
- _elementIsShowable(Element $element, array $texts)¶
Determine if an element is allowed to be shown.
Parameters: - $element (Element) –
- $texts (array) –
Returns: boolean
- _getFormattedElementTexts(Omeka_Record_AbstractRecord $record, array $metadata)¶
Return a formatted version of all the texts for the requested element.
Parameters: - $record (Omeka_Record_AbstractRecord) –
- $metadata (array) –
Returns: array
- _getOutputAsHtml()¶
Output the default HTML format for displaying record metadata.
Returns: string
- _getOutputAsArray()¶
Get the metadata list as a PHP array.
Returns: array
- _getOutput()¶
Get the metadata list.
Returns: string|array
- _loadViewPartial(array $vars = Array)¶
Load a view partial to display the data.
Parameters: - $vars (array) – Variables to pass to the partial.
Returns: string