General encapsulated object frame any type of file can be * encapsulated. * * @package php-reader * @subpackage ID3 * @author Sven Vollbehr * @author Ryan Butterfield * @copyright Copyright (c) 2008 The PHP Reader Project Workgroup * @license http://code.google.com/p/php-reader/wiki/License New BSD License * @version $Rev: 105 $ */ final class ID3_Frame_GEOB extends ID3_Frame implements ID3_Encoding { /** @var integer */ private $_encoding = ID3_Encoding::UTF8; /** @var string */ private $_mimeType; /** @var string */ private $_filename; /** @var string */ private $_description; /** @var string */ private $_objectData; /** * 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); if ($reader === null) return; $this->_encoding = Transform::fromUInt8($this->_data[0]); $this->_mimeType = substr ($this->_data, 1, ($pos = strpos($this->_data, "\0", 1)) - 1); $this->_data = substr($this->_data, $pos + 1); switch ($this->_encoding) { case self::UTF16: list ($this->_filename, $this->_description, $this->_objectData) = $this->explodeString16($this->_data, 3); $this->_filename = Transform::fromString16($this->_filename); $this->_description = Transform::fromString16($this->_description); break; case self::UTF16BE: list ($this->_filename, $this->_description, $this->_objectData) = $this->explodeString16($this->_data, 3); $this->_filename = Transform::fromString16BE($this->_filename); $this->_description = Transform::fromString16BE($this->_description); break; default: list ($this->_filename, $this->_description, $this->_objectData) = $this->explodeString8($this->_data, 3); $this->_filename = Transform::fromString8($this->_filename); $this->_description = Transform::fromString8($this->_description); } } /** * Returns the text encoding. * * @return integer */ public function getEncoding() { return $this->_encoding; } /** * Sets the text encoding. * * @see ID3_Encoding * @param integer $encoding The text encoding. */ public function setEncoding($encoding) { $this->_encoding = $encoding; } /** * Returns the MIME type. The MIME type is always encoded with ISO-8859-1. * * @return string */ public function getMimeType() { return $this->_mimeType; } /** * Sets the MIME type. The MIME type is always ISO-8859-1 encoded. * * @param string $mimeType The MIME type. */ public function setMimeType($mimeType) { $this->_mimeType = $mimeType; } /** * Returns the file name. * * @return string */ public function getFilename() { return $this->_filename; } /** * Sets the file name using given encoding. The file name encoding must be * that of the description text. * * @param string $description The file description text. * @param integer $encoding The text encoding. */ public function setFilename($filename, $encoding = false) { $this->_filename = $filename; if ($encoding !== false) $this->_encoding = $encoding; } /** * Returns the file description. * * @return string */ public function getDescription() { return $this->_description; } /** * Sets the file description text using given encoding. The description * encoding must be that of the file name. * * @param string $description The file description text. * @param integer $encoding The text encoding. */ public function setDescription($description, $encoding = false) { $this->_description = $description; if ($encoding !== false) $this->_encoding = $encoding; } /** * Returns the embedded object binary data. * * @return string */ public function getObjectData() { return $this->_objectData; } /** * Sets the embedded object binary data. * * @param string $objectData The object data. */ public function setObjectData($objectData) { $this->_objectData = $objectData; } /** * Returns the frame raw data. * * @return string */ public function __toString() { $data = Transform::toUInt8($this->_encoding) . $this->_mimeType . "\0"; switch ($this->_encoding) { case self::UTF16: case self::UTF16LE: $order = $this->_encoding == self::UTF16 ? Transform::MACHINE_ENDIAN_ORDER : Transform::LITTLE_ENDIAN_ORDER; $data .= Transform::toString16($this->_filename, $order) . "\0\0" . Transform::toString16($this->_description, $order) . "\0\0"; break; case self::UTF16BE: $data .= Transform::toString16BE ($this->_filename . "\0\0" . $this->_description . "\0\0"); break; default: $data .= $this->_filename . "\0" . $this->_description . "\0"; } $this->setData($data . $this->_objectData); return parent::__toString(); } }