Class: MP3_IDv2_Frame_TXXX

Source Location: /MP3_IDv2-0.1.4/IDv2/Frame/TXXX.php

Class Overview

MP3_IDv2_Frame
   |
   --MP3_IDv2_Frame_CommonText
      |
      --MP3_IDv2_Frame_TXXX

Data stucture for TXXX frame in a tag (User-defined text frame)

Author(s):

Alexander Merz <alexander.merz at web.de>

Version:

Release: @package_version@

Copyright:

2006 Alexander Merz

Methods

Inherited Variables

Class: MP3_IDv2_Frame

MP3_IDv2_Frame::$_changed
MP3_IDv2_Frame::$_content
MP3_IDv2_Frame::$_decompressedSize
MP3_IDv2_Frame::$_encryptionMethod
MP3_IDv2_Frame::$_flagCompression
MP3_IDv2_Frame::$_flagEncryption
MP3_IDv2_Frame::$_flagFileAlterPres
MP3_IDv2_Frame::$_flagGroup
MP3_IDv2_Frame::$_flagReadOnly
MP3_IDv2_Frame::$_flagTagAlterPres
MP3_IDv2_Frame::$_groupid
MP3_IDv2_Frame::$_id
MP3_IDv2_Frame::$_purpose

Inherited Methods

Class: MP3_IDv2_Frame_CommonText

MP3_IDv2_Frame_CommonText::createContent(): Creates the content of the frame (encoding+text)
MP3_IDv2_Frame_CommonText::getEncoding(): Returns the encoding identifier for the text in the frame.
MP3_IDv2_Frame_CommonText::getText(): Returns the text in the frame.
MP3_IDv2_Frame_CommonText::setEncoding(): Sets the encoding for the text for the frame.
MP3_IDv2_Frame_CommonText::setRawContent(): Sets the data of the frame and processes it.
MP3_IDv2_Frame_CommonText::setText(): Sets the text for the frame.
MP3_IDv2_Frame_CommonText::toString(): Returns the frame content as something printable

Class: MP3_IDv2_Frame

MP3_IDv2_Frame::createContent(): Creates the content from the frame data parts.
MP3_IDv2_Frame::createFrame(): Creates the whole frame (header + headerdata + content).
MP3_IDv2_Frame::createHeader(): Creates the header of the frame including the header extension according to the frame settings.
MP3_IDv2_Frame::getEncryptionMethod(): Get the encryption method for the frame data.
MP3_IDv2_Frame::getGroupIdentifier(): Get the group identifier of the frame
MP3_IDv2_Frame::getId(): Returns the identifier of the frame.
MP3_IDv2_Frame::getInstance(): Singleton method the create a specific frame object.
MP3_IDv2_Frame::getPurpose(): Returns the purpose of the frame
MP3_IDv2_Frame::getRawContent(): Returns the unprocessed content of the frame (excluding header)
MP3_IDv2_Frame::hasGroupingIdentifier(): Checks if the frame belongs to a group or should be
MP3_IDv2_Frame::isCompressed(): Checks if the frame data is compressed or should be
MP3_IDv2_Frame::isEncrypted(): Checks if the frame data is encrypted or should be
MP3_IDv2_Frame::isFlagFileAlterPres(): Checks if the header flag "File alter preservation" is set.
MP3_IDv2_Frame::isFlagReadOnly(): Checks if the frame is marked as read only
MP3_IDv2_Frame::isFlagTagAlterPres(): Checks if the header flag "Tag alter preservation" is set.
MP3_IDv2_Frame::setEncryptionMethod(): Sets the encryption method
MP3_IDv2_Frame::setFlagFileAlterPres(): Sets the header flag "File alter preservation"
MP3_IDv2_Frame::setFlagReadOnly(): Sets the header flag "Read only".
MP3_IDv2_Frame::setFlagTagAlterPres(): Sets the header flag "Tag alter preservation"
MP3_IDv2_Frame::setGroupIdentifier(): Sets the grouping identifier for the frame.
MP3_IDv2_Frame::setId(): Sets the identifier of the frame.
MP3_IDv2_Frame::setPurpose(): Sets the purpose text of the frame
MP3_IDv2_Frame::setRawContent(): Sets the unproccess content of the frame (excluding header!)
MP3_IDv2_Frame::toString(): Returns the frame content as something printable
MP3_IDv2_Frame::useCompression(): Enables/disables the compression of the frame data
MP3_IDv2_Frame::useEncryption(): Enables/disables the use of encryption for the frame data
MP3_IDv2_Frame::useGroupingIdentifier(): Enables/disables the use of a group identifier

Class Details

[line 47]
Data stucture for TXXX frame in a tag (User-defined text frame)

Author: Alexander Merz <alexander.merz@web.de>
Version: Release: @package_version@
Copyright: 2006 Alexander Merz
Link: http://pear.php.net/package/MP3_IDv2
Since: Class available since Release 0.1.0

[ Top ]

Method Detail

__construct (Constructor) [line 65]

MP3_IDv2_Frame_TXXX __construct(
)

Sets the id and purpose of the frame only

Access: public

[ Top ]

createContent [line 127]

string createContent(
)

Creates the whole content (descr+value).

Access: public

Overrides MP3_IDv2_Frame_CommonText::createContent() (Creates the content of the frame (encoding+text))

[ Top ]

getDescription [line 77]

string getDescription(
[
$b = false], bool
$nul)

Returns the frame description.

Return: the frame description
Access: public

Parameters:

bool	`$nul`	—	if true adds a null
	`$b`	—

[ Top ]

getValue [line 92]

string getValue(
)

Returns the frame value.

Return: the frame value
Access: public

[ Top ]

setDescription [line 102]

void setDescription(
string
$descr)

Sets the frame description

Access: public

Parameters:

string $descr — the frame description

[ Top ]

setRawContent [line 138]

void setRawContent(
string
$content)

Sets the unproccess content of the frame (excluding header!)

Access: public

Overrides MP3_IDv2_Frame_CommonText::setRawContent() (Sets the data of the frame and processes it.)

Parameters:

string $content — the raw frame data without the header

[ Top ]

setValue [line 116]

void setValue(
string
$value)

Sets the frame value

Access: public

Parameters:

string $value — the frame value

[ Top ]

toString [line 154]

string toString(
)

Returns the frame content as something printable

Return: the frame content
Access: public

Overrides MP3_IDv2_Frame_CommonText::toString() (Returns the frame content as something printable)

[ Top ]