* @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$ */ abstract class ID3_Frame_AbstractText extends ID3_Frame implements ID3_Encoding { /** * The text encoding. * * @var integer */ protected $_encoding; /** * The text array. * * @var string */ protected $_text; /** * 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]); $this->_data = substr($this->_data, 1); switch ($encoding) { case self::UTF16: $this->_text = $this->_convertString ($this->_explodeString16(Transform::fromString16($this->_data)), "utf-16"); break; case self::UTF16BE: $this->_text = $this->_convertString ($this->_explodeString16(Transform::fromString16($this->_data)), "utf-16be"); break; case self::UTF8: $this->_text = $this->_convertString ($this->_explodeString8(Transform::fromString8($this->_data)), "utf-8"); break; default: $this->_text = $this->_convertString ($this->_explodeString8(Transform::fromString8($this->_data)), "iso-8859-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 first text chunk the frame contains. * * @return string */ public function getText() { return $this->_text[0]; } /** * Returns an array of texts the frame contains. * * @return Array */ public function getTexts() { return $this->_text; } /** * Sets the text using given encoding. * * @param mixed $text The test string or an array of strings. * @param integer $encoding The text encoding. */ public function setText($text, $encoding = false) { $this->_text = is_array($text) ? $text : array($text); if ($encoding !== false) $this->_encoding = $encoding; } /** * Returns the frame raw data without the header. * * @return string */ protected function _getData() { $data = Transform::toUInt8($this->_encoding); switch ($this->_encoding) { case self::UTF16LE: $array = $this->_text; foreach ($array as &$text) $text = Transform::toString16($text, Transform::LITTLE_ENDIAN_ORDER); $data .= implode("\0\0", $array); break; case self::UTF16: case self::UTF16BE: $data .= implode("\0\0", $this->_text); break; default: $data .= implode("\0", $this->_text); } return $data; } }