Group identification registration frame enables grouping of * otherwise unrelated frames. This can be used when some frames are to be * signed. To identify which frames belongs to a set of frames a group * identifier must be registered in the tag with this frame. * * The owner identifier is a URL containing an email address, or a link to a * location where an email address can be found, that belongs to the * organisation responsible for this grouping. Questions regarding the grouping * should be sent to the indicated email address. * * The group symbol contains a value that associates the frame with this group * throughout the whole tag, in the range $80-F0. All other values are reserved. * The group symbol may optionally be followed by some group specific data, e.g. * a digital signature. There may be several GRID frames in a tag but only one * containing the same symbol and only one containing the same owner identifier. * The group symbol must be used somewhere in the tag. See * {@link ID3_Frame#GROUPING_ownerENTITY} for more information. * * @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_GRID extends ID3_Frame { /** @var string */ private $_owner; /** @var integer */ private $_group; /** @var string */ private $_groupData; /** * 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; list($this->_owner, $this->_data) = $this->explodeString8($this->_data, 2); $this->_group = Transform::fromUInt8($this->_data[0]); $this->_groupData = substr($this->_data, 1); } /** * Returns the owner identifier string. * * @return string */ public function getOwner() { return $this->_owner; } /** * Sets the owner identifier string. * * @param string $owner The owner identifier string. */ public function setOwner($owner) { $this->_owner = $owner; } /** * Returns the group symbol. * * @return integer */ public function getGroup() { return $this->_group; } /** * Sets the group symbol. * * @param integer $group The group symbol. */ public function setGroup($group) { $this->_group = $group; } /** * Returns the group dependent data. * * @return string */ public function getGroupData() { return $this->_groupData; } /** * Sets the group dependent data. * * @param string $groupData The data. */ public function setGroupData($groupData) { $this->_groupData = $groupData; } /** * Returns the frame raw data. * * @return string */ public function __toString() { parent::setData ($this->_owner . "\0" . Transform::toUInt8($this->_group) . $this->_groupData); return parent::__toString(); } }