Class ID3_Frame_COMR

Description
Description | Vars (details) | Methods (details) Constants

Implements interfaces:

The Commercial frame enables several competing offers in the same tag by bundling all needed information. That makes this frame rather complex but it's an easier solution than if one tries to achieve the same result with several frames.

There may be more than one commercial frame in a tag, but no two may be identical.

Located in /ID3/Frame/COMR.php (line 60) 

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_COMR
Variable Summary
Description | Vars (details) | Methods (details) Constants
static Array $types
Method Summary
Description | Constants Vars (details) | Methods (details)
ID3_Frame_COMR __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getContact ()
string getCurrency ()
string getDate ()
integer getDelivery ()
string getDescription ()
integer getEncoding ()
string getImageData ()
integer getImageSize ()
string getMimeType ()
string getPrice ()
string getSeller ()
void setContact (string $contact)
void setCurrency (string $currency)
void setDate (string $date)
void setDelivery (integer $delivery)
void setDescription (string $description, [integer $encoding = false])
void setEncoding (integer $encoding)
void setImageData (string $imageData)
void setMimeType (string $mimeType)
void setPrice (string $price)
void setSeller (string $seller, [integer $encoding = false])
string __toString ()
Variables
Description | Vars (details) Constants | Methods (details)
static Array $types = array
("Other", "Standard CD album with other songs", "Compressed audio on CD",
"File over the Internet", "Stream over the Internet", "As note sheets",
"As note sheets in a book with other sheets", "Music on other media",
"Non-musical merchandise") (line 68)

The delivery types.

  • access: public

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Description | Vars (details) Constants Methods (details)
Constructor __construct (line 113)

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

  • access: public
ID3_Frame_COMR __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.
getContact (line 235)

Returns the contact URL, with which the user can contact the seller.

  • access: public
string getContact ()
getCurrency (line 182)

Returns the currency code, encoded according to ISO 4217 alphabetic currency code.

  • access: public
string getCurrency ()
getDate (line 220)

Returns the date as an 8 character date string (YYYYMMDD), describing for how long the price is valid.

  • access: public
string getDate ()
getDelivery (line 249)

Returns the delivery type with whitch the audio was delivered when bought.

  • access: public
integer getDelivery ()
getDescription (line 284)

Returns the short description of the product.

  • access: public
string getDescription ()
getEncoding (line 165)

Returns the text encoding.

  • access: public
integer getEncoding ()
Implementation of:
ID3_Encoding::getEncoding()
Returns the text encoding.
getImageData (line 322)

Returns the embedded image binary data.

  • access: public
string getImageData ()
getImageSize (line 341)

Returns the size of the embedded image data.

  • access: public
integer getImageSize ()
getMimeType (line 307)

Returns the MIME type of the seller's company logo, if attached, or false otherwise. Currently only "image/png" and "image/jpeg" are allowed.

  • access: public
string getMimeType ()
getPrice (line 201)

Returns the price as a numerical string using "." as the decimal separator.

In the price string several prices may be concatenated, separated by a "/" character, but there may only be one currency of each type.

  • access: public
string getPrice ()
getSeller (line 263)

Returns the name of the seller.

  • access: public
string getSeller ()
setContact (line 242)

Sets the contact URL, with which the user can contact the seller.

  • access: public
void setContact (string $contact)
  • string $contact: The contact URL.
setCurrency (line 191)

Sets the currency used in transaction, encoded according to ISO 4217 alphabetic currency code.

  • access: public
void setCurrency (string $currency)
  • string $currency: The currency code.
setDate (line 228)

Sets the date describing for how long the price is valid for. The date must be an 8 character date string (YYYYMMDD).

  • access: public
void setDate (string $date)
  • string $date: The date string.
setDelivery (line 256)

Sets the delivery type with whitch the audio was delivered when bought.

  • access: public
void setDelivery (integer $delivery)
  • integer $delivery: The delivery type code.
setDescription (line 293)

Sets the content description text using given encoding. The description encoding must be that of the seller text.

  • access: public
void setDescription (string $description, [integer $encoding = false])
  • string $description: The content description text.
  • integer $encoding: The text encoding.
setEncoding (line 173)

Sets the text encoding.

void setEncoding (integer $encoding)
  • integer $encoding: The text encoding.
Implementation of:
ID3_Encoding::setEncoding()
Sets the text encoding.
setImageData (line 330)

Sets the embedded image data. Also updates the image size to correspond the new data.

  • access: public
void setImageData (string $imageData)
  • string $imageData: The image data.
setMimeType (line 315)

Sets the MIME type. Currently only "image/png" and "image/jpeg" are allowed. The MIME type is always ISO-8859-1 encoded.

  • access: public
void setMimeType (string $mimeType)
  • string $mimeType: The MIME type.
setPrice (line 209)

Sets the price. The price must use "." as the decimal separator and have multiple values be separated by a "/" character.

  • access: public
void setPrice (string $price)
  • string $price: The price.
setSeller (line 272)

Sets the name of the seller using given encoding. The seller text encoding must be that of the description text.

  • access: public
void setSeller (string $seller, [integer $encoding = false])
  • string $seller: The name of the seller.
  • integer $encoding: The text encoding.
__toString (line 348)

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
Description | Constants (details) Vars (details) | Methods (details)

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

Documentation generated on Fri, 05 Sep 2008 20:18:25 +0300 by phpDocumentor 1.4.1