Class ID3_Frame_IPLS

Description

Implements interfaces:

The Involved people list is a frame containing the names of those involved, and how they were involved. There may only be one IPLS frame in each tag.

  • author: Sven Vollbehr <svollbehr@gmail.com>
  • version: $Rev: 75 $
  • copyright: Copyright (c) 2008 The PHP Reader Project Workgroup
  • deprecated: ID3v2.3.0
  • license: New BSD License

Located in /ID3/Frame/IPLS.php (line 57)

ID3_Object
   |
   --ID3_Frame
      |
      --ID3_Frame_IPLS
Method Summary
ID3_Frame_IPLS __construct ([Reader $reader = null], [ &$options = array()], Array $options)
string addPerson ( $involvement,  $person)
integer getEncoding ()
Array getPeople ()
void setEncoding (integer $encoding)
void setPeople (Array $people)
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 72)

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

  • access: public
ID3_Frame_IPLS __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.
addPerson (line 126)

Adds a person with his involvement.

  • access: public
string addPerson ( $involvement,  $person)
  • $involvement
  • $person
getEncoding (line 102)

Returns the text encoding.

  • access: public
integer getEncoding ()

Implementation of:
ID3_Encoding::getEncoding()
Returns the text encoding.
getPeople (line 119)

Returns the involved people list as an array. For each person, the array contains an entry, which too is an associate array with involvement as its key and involvee as its value.

  • access: public
Array getPeople ()
setEncoding (line 110)

Sets the text encoding.

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

Implementation of:
ID3_Encoding::setEncoding()
Sets the text encoding.
setPeople (line 138)

Sets the involved people list array. For each person, the array must contain an associate array with involvement as its key and involvee as its value.

  • access: public
void setPeople (Array $people)
  • Array $people: The involved people list.
__toString (line 145)

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