Overview

Packages

  • ClipIt
    • clipit
      • api
    • urjc
      • backend
  • Elgg
    • Core
      • Access
      • Authentication
      • Cache
      • Caches
      • Core
      • DataMode
        • Site
      • DataModel
        • Annotations
        • Entities
        • Extender
        • File
        • Importable
        • Loggable
        • Notable
        • Object
        • User
      • DataStorage
      • Exception
      • Exceptions
        • Stub
      • FileStore
        • Disk
      • Groups
      • Helpers
      • HMAC
      • Memcache
      • Metadata
      • Navigation
      • ODD
      • Output
      • Plugins
        • Settings
      • Sessions
      • SocialModel
        • Friendable
        • Locatable
      • WebServicesAPI
      • Widgets
      • XML
      • XMLRPC
    • Exceptions
      • Stub
  • None
  • PHP

Classes

  • ODD
  • ODDDocument
  • ODDEntity
  • ODDMetaData

Interfaces

  • Exportable
  • Overview
  • Package
  • Class
  • Tree

Class ODDDocument

This class is used during import and export to construct.

ODDDocument implements Iterator
Package: Elgg\Core\ODD
Located at ODDDocument.php
Methods summary
public
# __construct( array $elements = NULL )

Create a new ODD Document.

Create a new ODD Document.

Parameters

$elements
array
$elements Elements to add
public string
# getVersion( )

Return the version of ODD being used.

Return the version of ODD being used.

Returns

string
public integer
# getNumElements( )

Returns the number of elements

Returns the number of elements

Returns

integer
public
# addElement( ODD $element )

Add an element

Add an element

Parameters

$element
ODD
$element An ODD element
public
# addElements( array $elements )

Add multiple elements at once

Add multiple elements at once

Parameters

$elements
array
$elements Array of ODD elements
public array
# getElements( )

Return all elements

Return all elements

Returns

array
public
# setWrapperFactory( ODDWrapperFactory $factory )

Set an optional wrapper factory to optionally embed the ODD document in another format.

Set an optional wrapper factory to optionally embed the ODD document in another format.

Parameters

$factory
ODDWrapperFactory
$factory The factory
public string
# __toString( )

Magic function to generate valid ODD XML for this item.

Magic function to generate valid ODD XML for this item.

Returns

string
public
# rewind( )

Iterator interface

Iterator interface

See

Iterator::rewind()

Implementation of

Iterator::rewind()
public
# current( )

Iterator interface

Iterator interface

See

Iterator::current()

Implementation of

Iterator::current()
public
# key( )

Iterator interface

Iterator interface

See

Iterator::key()

Implementation of

Iterator::key()
public
# next( )

Iterator interface

Iterator interface

See

Iterator::next()

Implementation of

Iterator::next()
public
# valid( )

Iterator interface

Iterator interface

See

Iterator::valid()

Implementation of

Iterator::valid()
API documentation generated by ApiGen 2.8.0