File Source for Tag.php

<?php
/**
* MediaSearch
*
* LICENSE
*
* "THE BEER-WARE LICENSE" (Revision 42):
* "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
* As long as you retain this notice you can do whatever you want with
* this stuff. If we meet some day, and you think this stuff is worth it,
* you can buy me a beer in return.
*
* $Author$
* $Revision$
*
* @category MediaSearch
* @package MediaSearch_Id3
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
/**
* @see MediaSearch_Id3_Exception
*/
require_once('MediaSearch/Id3/Exception.php');
/**
* @see MediaSearch_File_Util
*/
require_once('MediaSearch/File/Util.php');
/**
* Gives read access to the ID3 tags of a mp3 file.
*
* @category MediaSearch
* @package MediaSearch_Id3
* @uses MediaSearch_Id3_Exception
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
class MediaSearch_Id3_Tag {
/**
* ID3 Version 1.0
*/
const VERSION_1 = ID3_V1_0;
/**
* ID3 Version 1.1
*/
const VERSION_1_1 = ID3_V1_1;
/**
* ID3 Version 2.0
*/
const VERSION_2 = ID3_V2;
/**
* The version of the ID3 tags the file has.
* A mp3 can have 1.x and 2.x tags on same time!
*
* @access private
* @var int
*/
private $version;
/**
* File path of the mp3 file.
*
* @access private
* @var string
*/
private $filePath;
/**
* The tag data from the file.
*
* @access private
* @var array
*/
private $tagData;
/**
* Gather the tag version from the file.
*
* @access public
* @throws MediaSearch_Id3_Exception If the given file info object isnt a mp3.
* @param SplFileInfo $fileInfo
*/
public function __construct(SplFileInfo $fileInfo) {
$this->filePath = $fileInfo->getPathname();
if (!self::isMp3($this->filePath)) {
$message = 'The given file object (path: ' . $this->filePath;
$message .= ') doesnt refer to an mp3 file!';
throw new MediaSearch_Id3_Exception($message,
MediaSearch_Id3_Exception::UNSUPPORTED_FILE_TYPE);
}
$this->version = id3_get_version($this->filePath);
}
/**
* Checks the given file name string if it has the file name extension 'mp3'.
*
* @static
* @access public
* @param string $fileName
* @return bool
*/
public static function isMp3($fileName) {
return ('mp3' === MediaSearch_File_Util::getExtension($fileName));
}
/**
* Returns the version of ID3 tags this file has.
* Attend that a file can have version 1.x and 2.x tags together!
*
* @access public
* @return int
*/
public function getVersion() {
return $this->version;
}
/**
* Tells you if this file is of a version.
*
* Example:
* <code>
* // ...
* $tag = new MediaSearch_Id3_Tag($fileInfo);
* // ...
* if ($tag->isVersion(MediaSearch_Id3_Tag::VERSION_2)) {
* }
* </code>
*
* @access public
* @param int $int
* @return bool
*/
public function isVersion($int) {
return ($this->getVersion() & $int);
}
/**
* Returns a ID3 tag by its name. If the ta gis not setted or does not exists
* this method returns null.
*
* @access public
* @param string $name
* @return string
*/
public function get($name) {
if (null === $this->tagData) {
$this->tagData = id3_get_tag($this->filePath, $this->version);
}
if (!array_key_exists($name, $this->tagData)) {
return null;
}
return $this->tagData[$name];
}
/**
* @see get()
*
* @access public
* @param string $name
* @return string
*/
public function __get($name) {
return $this->get($name);
}
/**
* Throws permanent a BadEthodCallException because this object
* is imutable.
*
* @access public
* @throws BadEthodCallException
* @param atring $name
*/
public function __set($name) {
$message = 'Setting of tags is currently not supported!';
throw new BadEthodCallException($message);
}
}

Source for file Tag.php