Docs For Class MP3_IDv2

$_changed = false

[line 63]

indicates that the content of the frame was changed

Var: true if content was changed and must created again
Access: protected

Type:

bool

[ Top ]

$_content = null

[line 75]

the raw content of the tag

Access: protected

Type:

string

[ Top ]

$_decompressedSize = null

[line 124]

size of the frame data after uncompression

Access: protected

Type:

int

[ Top ]

$_encryptionMethod = null

[line 131]

Identifier of the method used for encryption

Access: protected

Type:

string

[ Top ]

$_flagCompression = false

[line 103]

flag to indicate that the frame content is compressed

Access: protected

Type:

bool

[ Top ]

$_flagEncryption = false

[line 117]

flag to indicate that the frame encrypted

Access: protected

Type:

bool

[ Top ]

$_flagFileAlterPres = false

[line 89]

flag to indicate to drop this frame or not while changing the file if unknown

Access: protected

Type:

bool

[ Top ]

$_flagGroup = false

[line 110]

flag to indicate that the frame has a group identifier

Access: protected

Type:

bool

[ Top ]

$_flagReadOnly = false

[line 96]

flag to indicate to that tis frame should nor be changed

Access: protected

Type:

bool

[ Top ]

$_flagTagAlterPres = false

[line 82]

flag to indicate to drop this frame or not while changing the tag if unknown

Access: protected

Type:

bool

[ Top ]

$_groupid = null

[line 138]

The identifier for the group

Access: protected

Type:

string

[ Top ]

$_id = null

[line 56]

the identifier of the frame (name of the frame)

Access: protected

Type:

string

[ Top ]

$_purpose = null

[line 69]

the purpose of this frame

Access: protected

Type:

string

[ Top ]

createContent [line 467]

string createContent(
)

Creates the content from the frame data parts.

This method must be overwritten by the FrameID-specific implementations.

Return: the created content
Access: public

Overridden in child classes as:

MP3_IDv2_Frame_PCNT::createContent(): Creates the content of the frame (encoding+language+tou)

MP3_IDv2_Frame_RBUF::createContent(): Creates the content of the frame (encoding+language+tou)

MP3_IDv2_Frame_CommonLink::createContent(): Creates the content of the frame

MP3_IDv2_Frame_WXXX::createContent(): Creates the content of the frame

MP3_IDv2_Frame_PRIV::createContent(): Creates the content of the frame (encoding+language+tou)

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

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

MP3_IDv2_Frame_POPM::createContent(): Creates the content of the frame (encoding+language+tou)

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

MP3_IDv2_Frame_TXXX::createContent(): Creates the whole content (descr+value).

MP3_IDv2_Frame_USER::createContent(): Creates the content of the frame (encoding+language+tou)

MP3_IDv2_Frame_USLT::createContent(): Creates the content of the frame (encoding+language+description+lyrics)

[ Top ]

createFrame [line 477]

string createFrame(
)

Creates the whole frame (header + headerdata + content).

Access: public

[ Top ]

createHeader [line 393]

string createHeader(
)

Creates the header of the frame including the header extension according to the frame settings.

Return: the created header
Access: public

[ Top ]

getEncryptionMethod [line 289]

string getEncryptionMethod(
)

Get the encryption method for the frame data.

Return: the method identifier or null
See: MP3_IDv2_Frame::useGroupingIdentifier()
Access: public

[ Top ]

getGroupIdentifier [line 267]

bool getGroupIdentifier(
)

Get the group identifier of the frame

Return: the group identifier or null
See: MP3_IDv2_Frame::useGroupingIdentifier()
Access: public

[ Top ]

getId [line 310]

string getId(
)

Returns the identifier of the frame.

Access: public

[ Top ]

getInstance [line 149]

Object getInstance(
String
$frameId)

Singleton method the create a specific frame object.

If a specific frame class does not exists, a Frame object is returned.

Return: the specific frame object
Access: public

Parameters:

String $frameId — the frame type

[ Top ]

getPurpose [line 171]

string getPurpose(
)

Returns the purpose of the frame

Return: the frame purpose
Access: public

[ Top ]

getRawContent [line 451]

string getRawContent(
)

Returns the unprocessed content of the frame (excluding header)

Return: the content 'as is'description
Access: public

[ Top ]

hasGroupingIdentifier [line 223]

bool hasGroupingIdentifier(
)

Checks if the frame belongs to a group or should be

Return: true if should belongs to a group
Access: public

[ Top ]

isCompressed [line 244]

bool isCompressed(
)

Checks if the frame data is compressed or should be

Return: true if compression is/should be used
Access: public

[ Top ]

isEncrypted [line 202]

bool isEncrypted(
)

Checks if the frame data is encrypted or should be

Return: true if encryption is/should be used
Access: public

[ Top ]

isFlagFileAlterPres [line 372]

bool isFlagFileAlterPres(
)

Checks if the header flag "File alter preservation" is set.

Return: true if flag is set
Access: public

[ Top ]

isFlagReadOnly [line 382]

bool isFlagReadOnly(
)

Checks if the frame is marked as read only

Return: true if flag is set
Access: public

[ Top ]

isFlagTagAlterPres [line 362]

bool isFlagTagAlterPres(
)

Checks if the header flag "Tag alter preservation" is set.

Return: true if flag is set
Access: public

[ Top ]

setEncryptionMethod [line 278]

void setEncryptionMethod(
string
$m)

Sets the encryption method

See: MP3_IDv2_Frame::useEncryption()
Access: public

Parameters:

string $m — one character for the method identifier

[ Top ]

setFlagFileAlterPres [line 341]

void setFlagFileAlterPres(
[bool
$f = true])

Sets the header flag "File alter preservation"

Access: public

Parameters:

bool $f — true to set the tag

[ Top ]

setFlagReadOnly [line 351]

void setFlagReadOnly(
bool
$f)

Sets the header flag "Read only".

Access: public

Parameters:

bool $f — true to set the tag

[ Top ]

setFlagTagAlterPres [line 331]

void setFlagTagAlterPres(
[bool
$f = true])

Sets the header flag "Tag alter preservation"

Access: public

Parameters:

bool $f — true to set the tag

[ Top ]

setGroupIdentifier [line 255]

void setGroupIdentifier(
string
$gid)

Sets the grouping identifier for the frame.

See: MP3_IDv2_Frame::useGroupingIdentifier()
Access: public

Parameters:

string $gid — one character as group identifier

[ Top ]

setId [line 300]

void setId(
string
$id)

Sets the identifier of the frame.

Access: protected

Parameters:

string $id — a four byte string for the name of the frame

[ Top ]

setPurpose [line 181]

void setPurpose(
string
$purpose)

Sets the purpose text of the frame

Access: protected

Parameters:

string $purpose — the frame purpose

[ Top ]

setRawContent [line 320]

void setRawContent(
string
$content)

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

Access: public

Overridden in child classes as:

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

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

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

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

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

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

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

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

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

MP3_IDv2_Frame_TCON::setRawContent()

MP3_IDv2_Frame_TXXX::setRawContent(): Sets the unproccess content of the frame (excluding header!)

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

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

Parameters:

string $content — the raw frame data without the header

[ Top ]

toString [line 489]

string toString(
)

Returns the frame content as something printable

Return: the frame content
Access: public

Overridden in child classes as:

MP3_IDv2_Frame_PCNT::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_RBUF::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_CommonLink::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_PRIV::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_MCDI::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_APIC::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_POPM::toString(): Returns the frame content as something printable

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

MP3_IDv2_Frame_TCON::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_TXXX::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_IPLS::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_TCOP::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_USER::toString(): Returns the frame content as something printable

MP3_IDv2_Frame_USLT::toString(): Returns the frame content as something printable

[ Top ]

useCompression [line 233]

void useCompression(
[bool
$b = true])

Enables/disables the compression of the frame data

Access: public

Parameters:

bool $b — true if compression should be used

[ Top ]

useEncryption [line 192]

void useEncryption(
[bool
$b = true])

Enables/disables the use of encryption for the frame data

Access: public

Parameters:

bool $b — true for enabling, false to disable

[ Top ]

useGroupingIdentifier [line 213]

void useGroupingIdentifier(
[bool
$b = true])

Enables/disables the use of a group identifier

Access: public

Parameters:

bool $b — true to use a group identifier

[ Top ]

Class: MP3_IDv2_Frame

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_changed = false

$_content = null

$_decompressedSize = null

$_encryptionMethod = null

$_flagCompression = false

$_flagEncryption = false

$_flagFileAlterPres = false

$_flagGroup = false

$_flagReadOnly = false

$_flagTagAlterPres = false

$_groupid = null

$_id = null

$_purpose = null

Method Detail

createContent [line 467]

createFrame [line 477]

createHeader [line 393]

getEncryptionMethod [line 289]

getGroupIdentifier [line 267]

getId [line 310]

getInstance [line 149]

Parameters:

getPurpose [line 171]

getRawContent [line 451]

hasGroupingIdentifier [line 223]

isCompressed [line 244]

isEncrypted [line 202]

isFlagFileAlterPres [line 372]

isFlagReadOnly [line 382]

isFlagTagAlterPres [line 362]

setEncryptionMethod [line 278]

Parameters:

setFlagFileAlterPres [line 341]

Parameters:

setFlagReadOnly [line 351]

Parameters:

setFlagTagAlterPres [line 331]

Parameters:

setGroupIdentifier [line 255]

Parameters:

setId [line 300]

Parameters:

setPurpose [line 181]

Parameters:

setRawContent [line 320]

Parameters:

toString [line 489]

useCompression [line 233]

Parameters:

useEncryption [line 192]

Parameters:

useGroupingIdentifier [line 213]

Parameters: