Class ID3_Frame_TXXX

Description
Description | Vars | Methods (details) Constants

This frame is intended for one-string text information concerning the audio

file in a similar way to the other T-frames. The frame body consists of a description of the string, represented as a terminated string, followed by the actual string. There may be more than one TXXX frame in each tag, but only one with the same description.

The description is the first value, and the its value the second in the text array.

Located in /ID3/Frame/TXXX.php (line 60) 

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_AbstractText
         |
         --ID3_Frame_TXXX
Method Summary
Description | Constants Vars | Methods (details)
ID3_Frame_TXXX __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getDescription ()
void setDescription (string $description, [integer $encoding = false])
string __toString ()
Variables
Description | Vars (details) Constants | Methods (details)

Inherited Variables

Inherited from ID3_Frame_AbstractText

ID3_Frame_AbstractText::$_encoding
 ID3_Frame_AbstractText::$_text

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

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

Constructs the class with given parameters and parses object related data.

  • access: public
ID3_Frame_TXXX __construct ([Reader $reader = null], [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options
Redefinition of:
ID3_Frame_AbstractText::__construct()
Constructs the class with given parameters and parses object related data.
getDescription (line 106)

Returns the description text.

  • access: public
string getDescription ()
setDescription (line 114)

Sets the description text using given encoding.

  • access: public
void setDescription (string $description, [integer $encoding = false])
  • string $description: The content description text.
  • integer $encoding: The text encoding.
__toString (line 126)

Returns the frame raw data.

  • access: public
string __toString ()
Redefinition of:
ID3_Frame_AbstractText::__toString()
Returns the frame raw data.

Inherited Methods

Inherited From ID3_Frame_AbstractText

ID3_Frame_AbstractText::__construct()
ID3_Frame_AbstractText::getEncoding()
ID3_Frame_AbstractText::getText()
ID3_Frame_AbstractText::getTexts()
ID3_Frame_AbstractText::setEncoding()
ID3_Frame_AbstractText::setText()
ID3_Frame_AbstractText::__toString()

Inherited From ID3_Frame

ID3_Frame::__construct()
ID3_Frame::getFlags()
ID3_Frame::getIdentifier()
ID3_Frame::getSize()
ID3_Frame::hasFlag()
ID3_Frame::setData()
ID3_Frame::setFlags()
ID3_Frame::setIdentifier()
ID3_Frame::__toString()

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)

Inherited Constants

Inherited from ID3_Frame

ID3_Frame::COMPRESSION
 ID3_Frame::DATA_LENGTH_INDICATOR
 ID3_Frame::DISCARD_ON_FILECHANGE
 ID3_Frame::DISCARD_ON_TAGCHANGE
 ID3_Frame::ENCRYPTION
 ID3_Frame::GROUPING_IDENTITY
 ID3_Frame::READ_ONLY
 ID3_Frame::UNSYNCHRONISATION

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