Class ID3_Frame_LINK

Description

The Linked information frame is used to keep information duplication

as low as possible by linking information from another ID3v2 tag that might reside in another audio file or alone in a binary file. It is recommended that this method is only used when the files are stored on a CD-ROM or other circumstances when the risk of file separation is low.

Data should be retrieved from the first tag found in the file to which this link points. There may be more than one LINK frame in a tag, but only one with the same contents.

A linked frame is to be considered as part of the tag and has the same restrictions as if it was a physical part of the tag (i.e. only one ID3_Frame_RVRB frame allowed, whether it's linked or not).

Frames that may be linked and need no additional data are ID3_Frame_ASPI, ID3_Frame_ETCO, ID3_Frame_EQU2, ID3_Frame_MCDI, ID3_Frame_MLLT, ID3_Frame_OWNE, ID3_Frame_RVA2, ID3_Frame_RVRB, ID3_Frame_SYTC, the text information frames (ie frames descendats of ID3_Frame_AbstractText) and the URL link frames (ie frames descendants of ID3_Frame_AbstractLink).

The ID3_Frame_AENC, ID3_Frame_APIC, ID3_Frame_GEOB and ID3_Frame_TXXX frames may be linked with the content descriptor as additional ID data.

The ID3_Frame_USER frame may be linked with the language field as additional ID data.

The ID3_Frame_PRIV frame may be linked with the owner identifier as additional ID data.

The ID3_Frame_COMM, ID3_Frame_SYLT and ID3_Frame_USLT frames may be linked with three bytes of language descriptor directly followed by a content descriptor as additional ID data.

Located in /ID3/Frame/LINK.php (line 87)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_LINK
Method Summary
ID3_Frame_LINK __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string getQualifier ()
string getTarget ()
string getUrl ()
void setQualifier ( $qualifier, string $identifier)
void setTarget (string $target)
void setUrl (string $url)
string __toString ()
Variables

Inherited Variables

Inherited from ID3_Frame

ID3_Frame::$_data

Inherited from ID3_Object

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

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

  • access: public
ID3_Frame_LINK __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.
getQualifier (line 149)

Returns the additional data to identify further the tag.

  • access: public
string getQualifier ()
getTarget (line 121)

Returns the target tag identifier.

  • access: public
string getTarget ()
getUrl (line 135)

Returns the target tag URL.

  • access: public
string getUrl ()
setQualifier (line 156)

Sets the additional data to be used in tag identification.

  • access: public
void setQualifier ( $qualifier, string $identifier)
  • string $identifier: The qualifier.
  • $qualifier
setTarget (line 128)

Sets the target tag identifier.

  • access: public
void setTarget (string $target)
  • string $target: The target tag identifier.
setUrl (line 142)

Sets the target tag URL.

  • access: public
void setUrl (string $url)
  • string $url: The target URL.
__toString (line 166)

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:18:59 +0300 by phpDocumentor 1.4.1