Class ID3_Frame_ENCR

Description

To identify with which method a frame has been encrypted the encryption method must be registered in the tag with the Encryption method registration frame.

The owner identifier a URL containing an email address, or a link to a location where an email address can be found, that belongs to the organisation responsible for this specific encryption method. Questions regarding the encryption method should be sent to the indicated email address.

The method symbol contains a value that is associated with this method throughout the whole tag, in the range $80-F0. All other values are reserved. The method symbol may optionally be followed by encryption specific data.

There may be several ENCR frames in a tag but only one containing the same symbol and only one containing the same owner identifier. The method must be used somewhere in the tag. See ENCRYPTION for more information.

Located in /ID3/Frame/ENCR.php (line 69)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_ENCR
Method Summary
ID3_Frame_ENCR __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getData ()
integer getMethod ()
string getOwner ()
void setData (string $encryptionData)
void setMethod (integer $method)
void setOwner (string $owner)
string __toString ()
Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

ID3_Object::$_options
ID3_Object::$_reader
Methods
Constructor __construct (line 86)

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

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

Returns the encryption data.

  • access: public
string getData ()
getMethod (line 117)

Returns the method symbol.

  • access: public
integer getMethod ()
getOwner (line 103)

Returns the owner identifier string.

  • access: public
string getOwner ()
setData (line 138)

Sets the encryption data.

  • access: public
void setData (string $encryptionData)
  • string $encryptionData: The encryption data string.

Redefinition of:
ID3_Frame::setData()
Sets the frame raw data.
setMethod (line 124)

Sets the method symbol.

  • access: public
void setMethod (integer $method)
  • integer $method: The method symbol byte.
setOwner (line 110)

Sets the owner identifier string.

  • access: public
void setOwner (string $owner)
  • string $owner: The owner identifier string.
__toString (line 148)

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::encodeSynchsafe32()
ID3_Object::getOptions()
ID3_Object::setOptions()
ID3_Object::__get()
ID3_Object::__set()
Class Constants

Documentation generated on Tue, 15 Apr 2008 03:32:59 +0300 by phpDocumentor 1.4.1