Docs For Class ID3_Frame

Description

Implements interfaces:

The Terms of use frame contains a brief description of the terms of

use and ownership of the file. More detailed information concerning the legal terms might be available through the ID3_Frame_WCOP frame. Newlines are allowed in the text. There may be more than one Terms of use frames in a tag, but only one with the same language.

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/USER.php (line 59)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_USER

Method Summary

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

integer getEncoding ()

string getLanguage ()

string getText ()

void setEncoding (integer $encoding)

void setLanguage (string $language)

void setText (string $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 77)

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

access: public

ID3_Frame_USER __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.

getEncoding (line 107)

Returns the text encoding.

access: public

integer getEncoding ()

Implementation of:

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

getLanguage (line 123)

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 144)

Returns the text.

access: public

string getText ()

setEncoding (line 115)

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 132)

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 153)

Sets the text using given language and encoding.

access: public

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

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

__toString (line 167)

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_USER

Inherited Variables

Inherited Methods

Inherited Constants