Class ID3_Object

Description

The base class for all ID3v2 objects.

Located in /ID3/Object.php (line 48)


	
			
Direct descendents
Class Description
ID3_ExtendedHeader The extended header contains information that can provide further insight in the structure of the tag, but is not vital to the correct parsing of the tag information; hence the extended header is optional.
ID3_Frame A base class for all ID3v2 frames as described in the ID3v2 frames document.
ID3_Header The first part of the ID3v2 tag is the 10 byte tag header. The header contains information about the tag version and options.
Variable Summary
Method Summary
ID3_Object __construct ([Reader $reader = null], [ &$options = array()], Array $options)
integer decodeSynchsafe32 (integer $val)
integer encodeSynchsafe32 (integer $val)
Array getOptions ()
void setOptions ( &$options, Array $options)
mixed __get (string $name)
mixed __set (string $name, string $value)
Variables
Array $_options (line 62)

The options array.

  • access: protected
Reader $_reader (line 55)

The reader object.

  • access: protected
Methods
Constructor __construct (line 71)

Constructs the class with given parameters and reads object related data from the ID3v2 tag.

  • access: public
ID3_Object __construct ([Reader $reader = null], [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options

Redefined in descendants as:
decodeSynchsafe32 (line 143)

Decodes the given 28-bit synchsafe integer to regular 32-bit integer.

  • access: protected
integer decodeSynchsafe32 (integer $val)
  • integer $val: The integer to decode
encodeSynchsafe32 (line 127)

Encodes the given 32-bit integer to 28-bit synchsafe integer, where the most significant bit of each byte is zero, making seven bits out of eight available.

  • access: protected
integer encodeSynchsafe32 (integer $val)
  • integer $val: The integer to encode.
getOptions (line 82)

Returns the options array.

  • access: public
Array getOptions ()
setOptions (line 89)

Sets the options array. See ID3v2 class for available options.

  • access: public
void setOptions ( &$options, Array $options)
  • Array $options: The options array.
  • &$options
__get (line 97)

Magic function so that $obj->value will work.

  • access: public
mixed __get (string $name)
  • string $name: The field name.
__set (line 111)

Magic function so that assignments with $obj->value will work.

  • access: public
mixed __set (string $name, string $value)
  • string $name: The field name.
  • string $value: The field value.

Documentation generated on Tue, 15 Apr 2008 03:33:17 +0300 by phpDocumentor 1.4.1