Class ID3_Frame_GRID

Description

The Group identification registration frame enables grouping of otherwise unrelated frames. This can be used when some frames are to be signed. To identify which frames belongs to a set of frames a group identifier must be registered in the tag with this frame.

The owner identifier is 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 grouping. Questions regarding the grouping should be sent to the indicated email address.

The group symbol contains a value that associates the frame with this group throughout the whole tag, in the range $80-F0. All other values are reserved. The group symbol may optionally be followed by some group specific data, e.g. a digital signature. There may be several GRID frames in a tag but only one containing the same symbol and only one containing the same owner identifier. The group symbol must be used somewhere in the tag. See GROUPING_ownerENTITY for more information.

Located in /ID3/Frame/GRID.php (line 68)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_GRID
Method Summary
ID3_Frame_GRID __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getData ()
integer getGroup ()
string getOwner ()
void setData (string $groupData)
void setGroup (integer $group)
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 85)

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

  • access: public
ID3_Frame_GRID __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 130)

Returns the group dependent data.

  • access: public
string getData ()
getGroup (line 116)

Returns the group symbol.

  • access: public
integer getGroup ()
getOwner (line 102)

Returns the owner identifier string.

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

Sets the group dependent data.

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

Redefinition of:
ID3_Frame::setData()
Sets the frame raw data.
setGroup (line 123)

Sets the group symbol.

  • access: public
void setGroup (integer $group)
  • integer $group: The group symbol.
setOwner (line 109)

Sets the owner identifier string.

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

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:33:08 +0300 by phpDocumentor 1.4.1