Class ID3_Frame_OWNE

Description

Implements interfaces:

The Ownership frame might be used as a reminder of a made transaction or, if signed, as proof. Note that the ID3_Frame_USER and ID3_Frame_TOWN frames are good to use in conjunction with this one.

There may only be one OWNE frame in a tag.

Located in /ID3/Frame/OWNE.php (line 58)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_OWNE
Method Summary
ID3_Frame_OWNE __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getCurrency ()
string getDate ()
integer getEncoding ()
string getPrice ()
string getSeller ()
void setCurrency (string $currency)
void setDate (string $date)
void setEncoding (integer $encoding)
void setPrice (integer $price)
void setSeller (string $seller, [integer $encoding = false])
string __toString ()
Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_reader
Methods
Constructor __construct (line 82)

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

  • access: public
ID3_Frame_OWNE __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.
getCurrency (line 131)

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

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

Returns the date of purchase as an 8 character date string (YYYYMMDD).

  • access: public
string getDate ()
getEncoding (line 114)

Returns the text encoding.

  • access: public
integer getEncoding ()

Implementation of:
ID3_Encoding::getEncoding()
Returns the text encoding.
getPrice (line 147)

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

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

Returns the name of the seller.

  • access: public
string getSeller ()
setCurrency (line 140)

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 172)

Sets the date of purchase. The date must be an 8 character date string (YYYYMMDD).

  • access: public
void setDate (string $date)
  • string $date: The date string.
setEncoding (line 122)

Sets the text encoding.

void setEncoding (integer $encoding)
  • integer $encoding: The text encoding.

Implementation of:
ID3_Encoding::setEncoding()
Sets the text encoding.
setPrice (line 154)

Sets the price.

  • access: public
void setPrice (integer $price)
  • integer $price: The price.
setSeller (line 187)

Sets the name of the seller using given encoding.

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

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

Documentation generated on Fri, 05 Sep 2008 20:19:11 +0300 by phpDocumentor 1.4.1