Docs For Class ID3_Frame

Description

Implements interfaces:

The Comments frame is intended for any kind of full text information

that does not fit in any other frame. It consists of a frame header followed by encoding, language and content descriptors and is ended with the actual comment as a text string. Newline characters are allowed in the comment text string. There may be more than one comment frame in each tag, but only one with the same language and content descriptor.

author: Ryan Butterfield <buttza@gmail.com>
author: Sven Vollbehr <svollbehr@gmail.com>
version: $Rev: 105 $
copyright: Copyright (c) 2008 The PHP Reader Project Workgroup
license: New BSD License

Located in /ID3/Frame/COMM.php (line 61)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_COMM

Method Summary

ID3_Frame_COMM __construct ([Reader $reader = null], [ &$options = array()], Array $options)

string getDescription ()

integer getEncoding ()

string getLanguage ()

string getText ()

void setDescription (string $description, [string $language = false], [integer $encoding = false])

void setEncoding (integer $encoding)

void setLanguage (string $language)

void setText (mixed $text, [string $language = false], [integer $encoding = false])

string __toString ()

Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader

Methods

Constructor __construct (line 82)

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

access: public

ID3_Frame_COMM __construct ([Reader $reader = null], [ &$options = array()], Array $options)

Reader $reader: The reader object.
Array $options: The options array.
&$options

Redefinition of:

ID3_Frame::__construct(): Constructs the class with given parameters and reads object related data from the ID3v2 tag.

getDescription (line 158)

Returns the short content description.

access: public

string getDescription ()

getEncoding (line 121)

Returns the text encoding.

access: public

integer getEncoding ()

Implementation of:

ID3_Encoding::getEncoding(): Returns the text encoding.

getLanguage (line 137)

Returns the language code as specified in the ISO-639-2 standard.

access: public

string getLanguage ()

Implementation of:

ID3_Language::getLanguage(): Returns the text language code.

getText (line 183)

Returns the comment text.

access: public

string getText ()

setDescription (line 168)

Sets the content description text using given encoding. The description language and encoding must be that of the actual text.

access: public

void setDescription (string $description, [string $language = false], [integer $encoding = false])

string $description: The content description text.
string $language: The language code.
integer $encoding: The text encoding.

setEncoding (line 129)

Sets the text encoding.

see: ID3_Encoding
access: public

void setEncoding (integer $encoding)

integer $encoding: The text encoding.

Implementation of:

ID3_Encoding::setEncoding(): Sets the text encoding.

setLanguage (line 146)

Sets the text language code as specified in the ISO-639-2 standard.

see: ID3_Language
access: public

void setLanguage (string $language)

string $language: The language code.

Implementation of:

ID3_Language::setLanguage(): Sets the text language code.

setText (line 193)

Sets the text using given encoding. The text language and encoding must be that of the description text.

access: public

void setText (mixed $text, [string $language = false], [integer $encoding = false])

mixed $text: The test string.
string $language: The language code.
integer $encoding: The text encoding.

__toString (line 207)

Returns the frame raw data.

access: public

string __toString ()

Redefinition of:

ID3_Frame::__toString(): Returns the frame raw data.

Inherited Methods

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

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

Class ID3_Frame_COMM

Inherited Variables

Inherited Methods

Inherited Constants