Class ID3_Header

Description
Description | Vars | Methods (details) Constants (details)

The first part of the ID3v2 tag is the 10 byte tag header. The header contains information about the tag version and options.

Located in /ID3/Header.php (line 53) 

ID3_Object
   |
   --ID3_Header
Class Constant Summary
Description | Constants (details) Vars | | Methods (details)
EXPERIMENTAL = 32
EXTENDEDHEADER = 64
FOOTER = 16
UNSYNCHRONISATION = 128
Method Summary
Description | Constants (details) Vars | Methods (details)
ID3_Header __construct ([Reader $reader = null], [ &$options = array()], Array $options)
integer getFlags ()
integer getSize ()
integer getVersion ()
boolean hasFlag (integer $flag)
void setFlags (string $flags)
void setSize (integer $size)
void setVersion (integer $version)
string __toString ()
Variables
Description | Vars (details) Constants (details) | Methods (details)

Inherited Variables

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Description | Vars Constants (details) Methods (details)
Constructor __construct (line 90)

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

  • access: public
ID3_Header __construct ([Reader $reader = null], [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options
Redefinition of:
ID3_Object::__construct()
Constructs the class with given parameters and reads object related data from the ID3v2 tag.
getFlags (line 137)

Returns the flags byte.

  • access: public
integer getFlags ()
getSize (line 151)

Returns the tag size, excluding the header and the footer.

  • access: public
integer getSize ()
getVersion (line 109)

Returns the tag version number. The version number is in the form of major.revision.

  • access: public
integer getVersion ()
hasFlag (line 130)

Checks whether or not the flag is set. Returns true if the flag is set, false otherwise.

  • access: public
boolean hasFlag (integer $flag)
  • integer $flag: The flag to query.
setFlags (line 144)

Sets the flags byte.

  • access: public
void setFlags (string $flags)
  • string $flags: The flags byte.
setSize (line 159)

Sets the tag size, excluding the header and the footer. Called automatically upon tag generation to adjust the tag size.

  • access: public
void setSize (integer $size)
  • integer $size: The size of the tag, in bytes.
setVersion (line 118)

Sets the tag version number. Supported version numbers are 3.0 and 4.0 for ID3v2.3.0 and ID3v2.4.0 standards, respectively.

  • access: public
void setVersion (integer $version)
  • integer $version: The tag version number in the form of major.revision.
__toString (line 166)

Returns the header/footer raw data without the identifier.

  • access: public
string __toString ()

Inherited Methods

Inherited From ID3_Object

ID3_Object::__construct()
ID3_Object::decodeSynchsafe32()
ID3_Object::decodeUnsynchronisation()
ID3_Object::encodeSynchsafe32()
ID3_Object::encodeUnsynchronisation()
ID3_Object::explodeString8()
ID3_Object::explodeString16()
ID3_Object::getOption()
ID3_Object::getOptions()
ID3_Object::setOption()
ID3_Object::setOptions()
ID3_Object::__get()
ID3_Object::__set()
Class Constants
Description | Constants (details) Vars | Methods (details)
EXPERIMENTAL = 32 (line 65)

A flag used as an experimental indicator. This flag shall always be set

EXTENDEDHEADER = 64 (line 61)

A flag to denote whether or not the header is followed by an extended

FOOTER = 16 (line 72)

A flag to denote whether a footer is present at the very end of the tag.

  • since: ID3v2.4.0
UNSYNCHRONISATION = 128 (line 57)

A flag to denote whether or not unsynchronisation is applied on all

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