Class ID3_Frame_AbstractText
Description
Implements interfaces:
A base class for all the text frames.
Located in /ID3/Frame/AbstractText.php (line 54)
ID3_Object | --ID3_Frame | --ID3_Frame_AbstractText
Direct descendents
| Class | Description |
|---|---|
| ID3_Frame_TALB | The Album/Movie/Show title frame is intended for the title of the recording (or source of sound) from which the audio in the file is taken. |
| ID3_Frame_TBPM | The BPM frame contains the number of beats per minute in the main part of the audio. The BPM is an integer and represented as a numerical string. |
| ID3_Frame_TCOM | The Composer frame is intended for the name of the composer. |
| ID3_Frame_TCON | The Content type, which ID3v1 was stored as a one byte numeric value only, is now a string. You may use one or several of the ID3v1 types as numerical strings, or, since the category list would be impossible to maintain with accurate and up to date categories, define your own. |
| ID3_Frame_TCOP | The Copyright message frame, in which the string must begin with a |
| ID3_Frame_TDAT | The Date frame is a numeric string in the DDMM format containing the date for the recording. This field is always four characters long. |
| ID3_Frame_TDEN | The Encoding time frame contains a timestamp describing when the audio was encoded. Timestamp format is described in the ID3v2 structure document. |
| ID3_Frame_TDLY | The Playlist delay defines the numbers of milliseconds of silence that should be inserted before this audio. The value zero indicates that this is a part of a multifile audio track that should be played continuously. |
| ID3_Frame_TDOR | The Original release time frame contains a timestamp describing when the original recording of the audio was released. Timestamp format is described in the ID3v2 structure document. |
| ID3_Frame_TDRC | The Recording time frame contains a timestamp describing when the audio was recorded. Timestamp format is described in the ID3v2 structure document. |
| ID3_Frame_TDRL | The Release time frame contains a timestamp describing when the audio was first released. Timestamp format is described in the ID3v2 structure document. |
| ID3_Frame_TDTG | The Tagging time frame contains a timestamp describing then the audio was tagged. Timestamp format is described in the ID3v2 structure document. |
| ID3_Frame_TENC | The Encoded by frame contains the name of the person or organisation that encoded the audio file. This field may contain a copyright message, if the audio file also is copyrighted by the encoder. |
| ID3_Frame_TEXT | The Lyricist/Text writer frame is intended for the writer of the text or lyrics in the recording. |
| ID3_Frame_TFLT | The File type frame indicates which type of audio this tag defines. |
| ID3_Frame_TIME | The Time frame is a numeric string in the HHMM format containing the time for the recording. This field is always four characters long. |
| ID3_Frame_TIPL | The Involved people list is very similar to the musician credits list, but maps between functions, like producer, and names. |
| ID3_Frame_TIT1 | The Content group description frame is used if the sound belongs to a larger category of sounds/music. For example, classical music is often sorted in different musical sections (e.g. "Piano Concerto", "Weather - Hurricane"). |
| ID3_Frame_TIT2 | The Title/Songname/Content description frame is the actual name of the piece (e.g. "Adagio", "Hurricane Donna"). |
| ID3_Frame_TIT3 | The Subtitle/Description refinement frame is used for information directly related to the contents title (e.g. "Op. 16" or "Performed live at Wembley"). |
| ID3_Frame_TKEY | The Initial key frame contains the musical key in which the sound |
| ID3_Frame_TLAN | The Language frame should contain the languages of the text or lyrics |
| ID3_Frame_TLEN | The Length frame contains the length of the audio file in milliseconds, represented as a numeric string. |
| ID3_Frame_TMCL | The Musician credits list is intended as a mapping between instruments and the musician that played it. Every odd field is an instrument and every even is an artist or a comma delimited list of artists. |
| ID3_Frame_TMED | The Media type frame describes from which media the sound originated. |
| ID3_Frame_TMOO | The Mood frame is intended to reflect the mood of the audio with a few keywords, e.g. "Romantic" or "Sad". |
| ID3_Frame_TOAL | The Original album/movie/show title frame is intended for the title of the original recording (or source of sound), if for example the music in the file should be a cover of a previously released song. |
| ID3_Frame_TOFN | The Original filename frame contains the preferred filename for the file, since some media doesn't allow the desired length of the filename. The filename is case sensitive and includes its suffix. |
| ID3_Frame_TOLY | The Original lyricist/text writer frame is intended for the text writer of the original recording, if for example the music in the file should be a cover of a previously released song. |
| ID3_Frame_TOPE | The Original artist/performer frame is intended for the performer of the original recording, if for example the music in the file should be a cover of a previously released song. |
| ID3_Frame_TORY | The Original release year frame is intended for the year when the original recording, if for example the music in the file should be a cover of a previously released song, was released. The field is formatted as in the ID3_Frame_TYER frame. |
| ID3_Frame_TOWN | The File owner/licensee frame contains the name of the owner or licensee of the file and it's contents. |
| ID3_Frame_TPE1 | The Lead artist/Lead performer/Soloist/Performing group is used for the main artist. |
| ID3_Frame_TPE2 | The Band/Orchestra/Accompaniment frame is used for additional information about the performers in the recording. |
| ID3_Frame_TPE3 | The Conductor frame is used for the name of the conductor. |
| ID3_Frame_TPE4 | The Interpreted, remixed, or otherwise modified by frame contains more information about the people behind a remix and similar interpretations of another existing piece. |
| ID3_Frame_TPOS | The Part of a set frame is a numeric string that describes which part of a set the audio came from. This frame is used if the source described in the ID3_Frame_TALB frame is divided into several mediums, e.g. |
| ID3_Frame_TPRO | The Produced notice frame, in which the string must begin with a year and a space character (making five characters), is intended for the production copyright holder of the original sound, not the audio file itself. |
| ID3_Frame_TPUB | The Publisher frame simply contains the name of the label or publisher. |
| ID3_Frame_TRCK | The Track number/Position in set frame is a numeric string containing the order number of the audio-file on its original recording. This may be extended with a "/" character and a numeric string containing the total number of tracks/elements on the original recording. E.g. "4/9". |
| ID3_Frame_TRDA | The Recording dates frame is intended to be used as complement to the ID3_Frame_TYER, ID3_Frame_TDAT and ID3_Frame_TIME frames. E.g. "4th-7th June, 12th June" in combination with the ID3_Frame_TYER frame. |
| ID3_Frame_TRSN | The Internet radio station name frame contains the name of the internet radio station from which the audio is streamed. |
| ID3_Frame_TRSO | The Internet radio station owner frame contains the name of the owner of the internet radio station from which the audio is streamed. |
| ID3_Frame_TSIZ | The Size frame contains the size of the audiofile in bytes, excluding the ID3v2 tag, represented as a numeric string. |
| ID3_Frame_TSOA | The Album sort order frame defines a string which should be used instead of the ID3_Frame_TALB album name frame for sorting purposes. |
| ID3_Frame_TSOP | The Performer sort order frame defines a string which should be used instead of the ID3_Frame_TPE2 performer frame for sorting purposes. |
| ID3_Frame_TSOT | The Title sort order frame defines a string which should be used instead of the ID3_Frame_TIT2 title frame for sorting purposes. |
| ID3_Frame_ISRC | The ISRC frame should contain the International Standard Recording Code (12 characters). |
| ID3_Frame_TSSE | The Software/Hardware and settings used for encoding frame includes the used audio encoder and its settings when the file was encoded. Hardware refers to hardware encoders, not the computer on which a program was run. |
| ID3_Frame_TSST | The Set subtitle frame is intended for the subtitle of the part of a set this track belongs to. |
| ID3_Frame_TXXX | This frame is intended for one-string text information concerning the audio |
| ID3_Frame_TYER | The Year frame is a numeric string with a year of the recording. This frames is always four characters long (until the year 10000). |
Variable Summary
integer
$_encoding
string
$_text
Method Summary
ID3_Frame_AbstractText
__construct
([Reader $reader = null], [ &$options = array()], Array $options)
integer
getEncoding
()
string
getText
()
Array
getTexts
()
string
__toString
()
Variables
integer
$_encoding
= ID3_Encoding::UTF8 (line 62)
The text encoding.
string
$_text
(line 69)
The text array.
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.
ID3_Frame_AbstractText
__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.
Redefined in descendants as:
- ID3_Frame_TXXX::__construct() : Constructs the class with given parameters and parses object related data.
getEncoding (line 106)
Returns the text encoding.
integer
getEncoding
()
Implementation of:
- ID3_Encoding::getEncoding()
- Returns the text encoding.
getText (line 121)
Returns the first text chunk the frame contains.
string
getText
()
getTexts (line 128)
Returns an array of texts the frame contains.
Array
getTexts
()
setEncoding (line 114)
Sets the text encoding.
void
setEncoding
(integer $encoding)
- integer $encoding: The text encoding.
Implementation of:
- ID3_Encoding::setEncoding()
- Sets the text encoding.
setText (line 136)
Sets the text using given encoding.
void
setText
(mixed $text, [integer $encoding = false])
- mixed $text: The test string or an array of strings.
- integer $encoding: The text encoding.
__toString (line 148)
Returns the frame raw data.
string
__toString
()
Redefinition of:
- ID3_Frame::__toString()
- Returns the frame raw data.
Redefined in descendants as:
- ID3_Frame_TXXX::__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
Documentation generated on Fri, 05 Sep 2008 20:18:14 +0300 by phpDocumentor 1.4.1