Abstract Class Omeka_Output_Xml_Abstract

Description
  • abstract:

Located in /application/libraries/Omeka/Output/Xml/Abstract.php (line 2)

Omeka_Output_Xml
   |
   --Omeka_Output_Xml_Abstract
Direct descendents
Class Constant Summary
 XMLNS = 'http://omeka.org/schemas/omeka-xml/v2'
 XMLNS_SCHEMALOCATION = 'http://omeka.org/schemas/omeka-xml/v2/omeka-xml-2-2.xsd'
 XMLNS_XSI = 'http://www.w3.org/2001/XMLSchema-instance'
Variable Summary
 string $_context
 DOMDocument $_doc
 DOMNode $_node
Method Summary
 DOMDocument getDoc ()
 void __construct (Omeka_Record|array $record, string $context)
 void|null _buildCollectionForItem ( $item,  $parentElement)
 void|null _buildElementSetContainerForRecord ( $record,  $parentElement)
 void|null _buildFileContainerForItem ( $item,  $parentElement)
 void|null _buildItemTypeForItem ( $item,  $parentElement)
 void _buildNode ()
 void|null _buildTagContainerForItem ( $item,  $parentElement)
 void _buildTagUri ()
 void _buildUrl ()
 DOMElement _createElement (string $name, [null|string $value = null], [null|int $id = null], [null|DOMElement $parentElement = null])
 stdClass _getElemetSetsByElementTexts ( $record, [bool $getItemType = false])
 void _setContainerPagination ( $parentElement)
 DOMElement _setRootElement (DOMElement $rootElement)
Variables
string $_context (line 20)

The context of this DOMDocument. elements.

The context of this DOMDocument. Determines how buildNode() builds the elements. Valid contexts include: item, file.

  • access: protected
DOMDocument $_doc (line 26)

The final document object.

The final document object.

  • access: protected
DOMNode $_node (line 32)

The node built and set in child::_buildNode()

The node built and set in child::_buildNode()

  • access: protected
array|Omeka_Record $_record (line 12)

This class' contextual record(s).

This class' contextual record(s).

  • access: protected
Methods
getDoc (line 58)

Get the document object.

Get the document object.

  • access: public
DOMDocument getDoc ()
Constructor __construct (line 44)
  • access: public
void __construct (Omeka_Record|array $record, string $context)
  • Omeka_Record|array $record
  • string $context: The context of this DOM document.
_buildCollectionForItem (line 306)

Build a collection element in an item context.

Build a collection element in an item context.

  • access: protected
void|null _buildCollectionForItem ( $item,  $parentElement)
  • Item $item: The item from which to build the collection.
  • DOMElement $parentElement: The collection will append to this element.
_buildElementSetContainerForRecord (line 187)

Build an elementSetContainer element in a record (item or file) context.

Build an elementSetContainer element in a record (item or file) context.

  • access: protected
void|null _buildElementSetContainerForRecord ( $record,  $parentElement)
  • Omeka_Record $record: The record from which to build element sets.
  • DOMElement $parentElement: The element set container will append to this element.
_buildFileContainerForItem (line 281)

Build a fileContainer element in an item context.

Build a fileContainer element in an item context.

  • access: protected
void|null _buildFileContainerForItem ( $item,  $parentElement)
  • Item $item: The item from which to build the file container.
  • DOMElement $parentElement: The file container will append to this element.
_buildItemTypeForItem (line 234)

Build an itemType element in an item context.

Build an itemType element in an item context.

  • access: protected
void|null _buildItemTypeForItem ( $item,  $parentElement)
  • Item $item: The item from which to build the item type.
  • DOMElement $parentElement: The item type will append to this element.
_buildNode (line 37)

Abstract method.

Abstract method. child::_buildNode() should set self::$_node.

  • abstract:
  • access: protected
void _buildNode ()

Redefined in descendants as:
_buildTagContainerForItem (line 328)

Build a tagContainer element in an item context.

Build a tagContainer element in an item context.

  • access: protected
void|null _buildTagContainerForItem ( $item,  $parentElement)
  • Item $item: The item from which to build the tag container.
  • DOMElement $parentElement: The tag container will append to this element.
_buildTagUri (line 346)
  • access: protected
void _buildTagUri ()
_buildUrl (line 353)
  • access: protected
void _buildUrl ()
_createElement (line 89)

Create a DOM element.

Create a DOM element.

  • access: protected
DOMElement _createElement (string $name, [null|string $value = null], [null|int $id = null], [null|DOMElement $parentElement = null])
  • string $name: The name of the element.
  • null|string $value: The value of the element.
  • null|int $id: The id attribute of the element.
  • null|DOMElement $parentElement: The parent element.
_getElemetSetsByElementTexts (line 139)

Get all element sets, elements, and element texts associated with the provided record.

Get all element sets, elements, and element texts associated with the provided record.

  • return: A list of element sets or an item type.
  • access: protected
stdClass _getElemetSetsByElementTexts ( $record, [bool $getItemType = false])
  • Omeka_Record $record: The record from which to extract metadata.
  • bool $getItemType: Whether to get the item type metadata.
_setContainerPagination (line 118)

Set the pagination node for container elements

Set the pagination node for container elements

  • access: protected
void _setContainerPagination ( $parentElement)
  • DOMElement $parentElement: The parent container element.
_setRootElement (line 70)

Set an element as root.

Set an element as root.

  • return: The root element, including required attributes.
  • access: protected
DOMElement _setRootElement (DOMElement $rootElement)
  • DOMElement $rootElement
Class Constants
XMLNS = 'http://omeka.org/schemas/omeka-xml/v2' (line 5)
XMLNS_SCHEMALOCATION = 'http://omeka.org/schemas/omeka-xml/v2/omeka-xml-2-2.xsd' (line 6)
XMLNS_XSI = 'http://www.w3.org/2001/XMLSchema-instance' (line 4)

Documentation generated on Thu, 15 Oct 2009 15:35:08 -0400 by phpDocumentor 1.4.2