Class ASF_Object_Container

Description

An abstract base container class that contains other ASF objects.

Located in /ASF/Object/Container.php (line 52)

ASF_Object
   |
   --ASF_Object_Container
Direct descendents
Class Description
ASF This class represents a file in Advanced Systems Format (ASF) as described in
ASF_Object_Header The role of the header object is to provide a well-known byte sequence at the beginning of ASF files and to contain all the information that is needed to properly interpret the information within the data object. The header object can optionally contain metadata such as bibliographic information.
ASF_Object_HeaderExtension The Header Extension Object allows additional functionality to be added to an ASF file while maintaining backward compatibility. The Header Extension Object is a container containing zero or more additional extended header objects.
Method Summary
void constructObjects ([ $defaultclassnames = array()])
Array getObjects ()
Array getObjectsByIdentifier ( $identifier)
boolean hasObject ( $identifier)
mixed __get (string $name)
boolean __isset (string $name)
Variables

Inherited Variables

Inherited from ASF_Object

ASF_Object::$_options
ASF_Object::$_reader
Methods
addObject (line 145)

Adds a new object into the current object and returns it.

  • access: public
ASF_Object addObject (ASF_Object $object)
constructObjects (line 60)

Reads and constructs the objects found within this object.

  • access: protected
void constructObjects ([ $defaultclassnames = array()])
  • $defaultclassnames
getObjects (line 108)

Returns all the objects the file contains as an associate array. The object identifiers work as keys having an array of ASF objects as associated value.

  • access: public
Array getObjects ()
getObjectsByIdentifier (line 127)

Returns an array of objects matching the given object GUID or an empty array if no object matched the identifier.

The identifier may contain wildcard characters "*" and "?". The asterisk matches against zero or more characters, and the question mark matches any single character.

Please note that one may also use the shorthand $obj->identifier to access the first box with the identifier given. Wildcards cannot be used with the shorthand and they will not work with user defined uuid types.

  • access: public
Array getObjectsByIdentifier ( $identifier)
  • $identifier
hasObject (line 96)

Checks whether the object with given GUID is present in the file. Returns true if one or more objects are present, false otherwise.

  • access: public
boolean hasObject ( $identifier)
  • $identifier
__get (line 165)

Override magic function so that $obj->value will work as expected.

The method first attempts to call the appropriate getter method. If no field with given name is found, the method attempts to return the right object instead. In other words, calling $obj->value will attempt to return the first object returned by $this->getObjectsByIdentifier(self::value).

  • access: public
mixed __get (string $name)
  • string $name: The field or object name.

Redefinition of:
ASF_Object::__get()
Magic function so that $obj->value will work.
__isset (line 185)

Magic function so that isset($obj->value) will work. This method checks whether the object by given identifier is contained by this container.

  • access: public
boolean __isset (string $name)
  • string $name: The object name.

Inherited Methods

Inherited From ASF_Object

ASF_Object::__construct()
ASF_Object::getIdentifier()
ASF_Object::getOffset()
ASF_Object::getOption()
ASF_Object::getOptions()
ASF_Object::getParent()
ASF_Object::getSize()
ASF_Object::setIdentifier()
ASF_Object::setOffset()
ASF_Object::setOption()
ASF_Object::setOptions()
ASF_Object::setParent()
ASF_Object::setSize()
ASF_Object::__get()
ASF_Object::__set()

Documentation generated on Fri, 05 Sep 2008 20:18:26 +0300 by phpDocumentor 1.4.1