Class: MP3_IDv2_Frame_POPM

Source Location: /MP3_IDv2-0.1.8/MP3/IDv2/Frame/POPM.php

Class Overview

MP3_IDv2_Frame
   |
   --MP3_IDv2_Frame_POPM

Data stucture for POPM frame in a tag.

Author(s):

Alexander Merz <alexander.merz at web.de>

Version:

Release: @package_version@

Copyright:

2006-2007 Alexander Merz

Variables

$_rating

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

MP3_IDv2_Frame::__construct(): Constructor
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 54]
Data stucture for POPM frame in a tag.

(Popularimeter)

The implementation is an optimistic one, it expects, that the counter doesn't become larger then 32 bit.

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

[ Top ]

Class Variables

$_rating = 0

[line 61]

the rating

Access: public

Type:

int

[ Top ]

Method Detail

__construct (Constructor) [line 209]

void __construct(
)

Sets the id and the purpose of the frame

Access: public

Overrides MP3_IDv2_Frame::__construct() (Constructor)

[ Top ]

createContent [line 173]

string createContent(
)

Creates the content of the frame (encoding+language+tou)

Return: the frame content
Access: public

Overrides MP3_IDv2_Frame::createContent() (Creates the content from the frame data parts.)

[ Top ]

getCounter [line 95]

int getCounter(
)

Returns the counter.

Return: the counter value
Access: public

[ Top ]

getEmail [line 156]

string getEmail(
[bool
$nul = false])

Returns the email address.

Return: the email address
Access: public

Parameters:

bool $nul — if true appends a null

[ Top ]

getRating [line 126]

int getRating(
)

Returns the rating.

Return: the rating value
Access: public

[ Top ]

setCounter [line 83]

void setCounter(
int
$c)

Sets the counter.

Access: public

Parameters:

int $c — counter value

[ Top ]

setEmail [line 139]

void setEmail(
string
$email)

Sets the email address.

Access: public

Parameters:

string $email — the email adsress

[ Top ]

setRating [line 109]

void setRating(
int
$c)

Sets the rating.

Must between 0 (worst) and 255 (best).

Access: public

Parameters:

int $c — rating value

[ Top ]

setRawContent [line 188]

void setRawContent(
string
$content)

Sets the data of the frame and processes it.

Access: public

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

Parameters:

string $content — the unproccess content for the frame

[ Top ]

toString [line 221]

string toString(
)

Returns the frame content as something printable

Return: the frame content
Access: public

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

[ Top ]