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. * * @package php-reader * @subpackage ID3 * @author Sven Vollbehr * @author Ryan Butterfield * @copyright Copyright (c) 2008-2009 The PHP Reader Project Workgroup * @license http://code.google.com/p/php-reader/wiki/License New BSD License * @version $Rev$ * @deprecated ID3v2.3.0 */ final class ID3_Frame_IPLS extends ID3_Frame implements ID3_Encoding { /** @var integer */ private $_encoding; /** @var Array */ private $_people = array(); /** * Constructs the class with given parameters and parses object related data. * * @param Reader $reader The reader object. * @param Array $options The options array. */ public function __construct($reader = null, &$options = array()) { parent::__construct($reader, $options); $this->_encoding = $this->getOption("encoding", ID3_Encoding::UTF8); if ($reader === null) return; $encoding = Transform::fromUInt8($this->_data[0]); $data = substr($this->_data, 1); $order = Transform::MACHINE_ENDIAN_ORDER; switch ($encoding) { case self::UTF16: $data = $this->_explodeString16($data); foreach ($data as &$str) $str = $this->_convertString (Transform::fromString16($str, $order), "utf-16"); break; case self::UTF16BE: $data = $this->_explodeString16($data); foreach ($data as &$str) $str = $this->_convertString (Transform::fromString16($str), "utf-16be"); break; case self::UTF8: $data = $this->_convertString($this->_explodeString8($data), "utf-8"); break; default: $data = $this->_convertString($this->_explodeString8($data), "iso-8859-1"); } for ($i = 0; $i < count($data) - 1; $i += 2) $this->_people[] = array($data[$i] => @$data[$i + 1]); } /** * Returns the text encoding. * * All the strings read from a file are automatically converted to the * character encoding specified with the encoding option. See * {@link ID3v2} for details. This method returns the original text encoding * used to write the frame. * * @return integer */ public function getEncoding() { return $this->_encoding; } /** * Sets the text encoding. * * All the string written to the frame are done so using given character * encoding. No conversions of existing data take place upon the call to this * method thus all texts must be given in given character encoding. * * The default character encoding used to write the frame is UTF-8. * * @see ID3_Encoding * @param integer $encoding The text encoding. */ public function setEncoding($encoding) { $this->_encoding = $encoding; } /** * 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. * * @return Array */ public function getPeople() { return $this->_people; } /** * Adds a person with his involvement. * * @return string */ public function addPerson($involvement, $person) { $this->_people[] = array($involvement => $person); } /** * 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. * * @param Array $people The involved people list. */ public function setPeople($people) { $this->_people = $people; } /** * Returns the frame raw data without the header. * * @return string */ protected function _getData() { $data = Transform::toUInt8($this->_encoding); foreach ($this->_people as $entry) { foreach ($entry as $key => $val) { switch ($this->_encoding) { case self::UTF16LE: $data .= Transform::toString16 ($key, Transform::LITTLE_ENDIAN_ORDER, 1) . Transform::toString16($val, Transform::LITTLE_ENDIAN_ORDER, 1); case self::UTF16: case self::UTF16BE: $data .= Transform::toString16($key, false, 1) . Transform::toString16($val, false, 1); break; default: $data .= $key . "\0" . $val . "\0"; } } } return $data; } }