rik/plibreader
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix comments

Browse Source 
git-svn-id: http://php-reader.googlecode.com/svn/trunk@10 51a70ab9-7547-0410-9469-37e369ee0574
This commit is contained in:
svollbehr
2008-03-12 11:59:45 +00:00
parent 4916e45513
commit afdfc67582
10 changed files with 316 additions and 284 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
src/ASF/ContentDescriptionObject.php
View File

@@ -1,10 +1,6 @@
<?php
/**
* $Id$
*
*
* Copyright (C) 2006, 2007 The Bearpaw Project Work Group. All Rights Reserved.
* Copyright (C) 2007, 2008 BEHR Software Systems. All Rights Reserved.
* PHP Reader Library
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,7 +26,12 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @package php-reader
* @package php-reader
* @subpackage ASF
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Id$
*/
/**#@+ @ignore */
@@ -38,47 +39,42 @@ require_once("Object.php");
/**#@-*/
/**
* The ASF_Content_Description_Object object implementation. This object
* The <i>ASF_Content_Description_Object</i> object implementation. This object
* contains five core attribute fields giving more information about the file:
* title, author, description, copyright and rating.
*
* @package php-reader
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright 2006, 2007 The Bearpaw Project Work Group
* @copyright 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
* @package php-reader
* @subpackage ASF
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
*/
final class ASF_ContentDescriptionObject extends ASF_Object
{
/**
* @var string The title field.
*/
/** @var string */
private $_title;
/**
* @var string The author field.
*/
/** @var string */
private $_author;
/**
* @var string The copyright field.
*/
/** @var string */
private $_copyright;
/**
* @var string The description field.
*/
/** @var string */
private $_description;
/**
* @var string The rating field.
*/
/** @var string */
private $_rating;
/**
* Default constructor. Initiates the class with given parameters and reads
* object related data from the ASF file.
* Constructs the class with given parameters and reads object related data
* from the ASF file.
*
* @param Reader $reader The reader object.
* @param string $id The object GUID identifier.
* @param integer $size The object size.
*/
public function __construct($reader, $id, $size)
{
@@ -99,36 +95,34 @@ final class ASF_ContentDescriptionObject extends ASF_Object
/**
* Returns the title field.
*
* @return string Returns the title field.
*/
public function getTitle() { return $this->_title; }
/**
* Returns the author field.
*
* @return string Returns the author field.
* @return string
*/
public function getAuthor() { return $this->_author; }
/**
* Returns the copyright field.
*
* @return string Returns the copyright field.
* @return string
*/
public function getCopyright() { return $this->_copyright; }
/**
* Returns the description field.
*
* @return string Returns the description field.
* @return string
*/
public function getDescription() { return $this->_description; }
/**
* Returns the rating field.
*
* @return string Returns the rating field.
* @return string
*/
public function getRating() { return $this->_rating; }
}

46
src/ASF/ExtendedContentDescriptionObject.php
View File

@@ -1,10 +1,6 @@
<?php
/**
* $Id$
*
*
* Copyright (C) 2006, 2007 The Bearpaw Project Work Group. All Rights Reserved.
* Copyright (C) 2007, 2008 BEHR Software Systems. All Rights Reserved.
* PHP Reader Library
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,7 +26,12 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @package php-reader
* @package php-reader
* @subpackage ASF
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Id$
*/
/**#@+ @ignore */
@@ -38,27 +39,30 @@ require_once("Object.php");
/**#@-*/
/**
* The ASF_Extended_Content_Description_Object object implementation. This
* object contains unlimited number of attribute fields giving more information
* about the file.
* The <i>ASF_Extended_Content_Description_Object</i> object implementation.
* This object contains unlimited number of attribute fields giving more
* information about the file.
*
* @package php-reader
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright 2006, 2007 The Bearpaw Project Work Group
* @copyright 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
* @package php-reader
* @subpackage ASF
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
*/
final class ASF_ExtendedContentDescriptionObject extends ASF_Object
{
/**
* @var Array An associate array of descriptors and their values.
*/
/** @var Array */
private $_contentDescriptors = array();
/**
* Initiates the object class with given parameters and reads and processes
* the object information from the ASF file.
* Constructs the class with given parameters and reads object related data
* from the ASF file.
*
* @param Reader $reader The reader object.
* @param string $id The object GUID identifier.
* @param integer $size The object size.
*/
public function __construct($reader, $id, $size)
{
@@ -96,7 +100,7 @@ final class ASF_ExtendedContentDescriptionObject extends ASF_Object
* is no such descriptor defined.
*
* @param string $name The name of the descriptor (ie the name of the field).
* @return string Returns the value of a descriptor.
* @return string|false
*/
public function getDescriptor($name)
{

109
src/ASF/FilePropertiesObject.php
View File

@@ -1,10 +1,6 @@
<?php
/**
* $Id$
*
*
* Copyright (C) 2006, 2007 The Bearpaw Project Work Group. All Rights Reserved.
* Copyright (C) 2007, 2008 BEHR Software Systems. All Rights Reserved.
* PHP Reader Library
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,7 +26,12 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @package php-reader
* @package php-reader
* @subpackage ASF
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Id$
*/
/**#@+ @ignore */
@@ -38,76 +39,59 @@ require_once("Object.php");
/**#@-*/
/**
* The ASF_File_Properties_Object object implementation. This object contains
* various information about the ASF file.
* The <i>ASF_File_Properties_Object</i> object implementation. This object
* contains various information about the ASF file.
*
* @package php-reader
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright 2006, 2007 The Bearpaw Project Work Group
* @copyright 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
* @package php-reader
* @subpackage ASF
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
*/
final class ASF_FilePropertiesObject extends ASF_Object
{
/**
* @var string The file id field.
*/
/** @var string */
private $_fileId;
/**
* @var string The file size field.
*/
/** @var string */
private $_fileSize;
/**
* @var string The creation date field.
*/
/** @var string */
private $_creationDate;
/**
* @var string The data packets count field.
*/
/** @var string */
private $_dataPacketsCount;
/**
* @var string The play duration field.
*/
/** @var string */
private $_playDuration;
/**
* @var string The send duration field.
*/
/** @var string */
private $_sendDuration;
/**
* @var string The preroll field.
*/
/** @var string */
private $_preroll;
/**
* @var string The flags field.
*/
/** @var string */
private $_flags;
/**
* @var string The minimum data packet size field.
*/
/** @var string */
private $_minimumDataPacketSize;
/**
* @var string The maximum data packet size field.
*/
/** @var string */
private $_maximumDataPacketSize;
/**
* @var string The maximum bitrate field.
*/
/** @var string */
private $_maximumBitrate;
/**
* Initiates the object class with given parameters and reads and processes
* the object information from the ASF file.
* Constructs the class with given parameters and reads object related data
* from the ASF file.
*
* @param Reader $reader The reader object.
* @param string $id The object GUID identifier.
* @param integer $size The object size.
*/
public function __construct($reader, $id, $size)
{
@@ -146,63 +130,63 @@ final class ASF_FilePropertiesObject extends ASF_Object
/**
* Returns the file id field.
*
* @return integer Returns the file id field.
* @return integer
*/
public function getFileId() { return $this->_fileId; }
/**
* Returns the file size field.
*
* @return integer Returns the file size field.
* @return integer
*/
public function getFileSize() { return $this->_fileSize; }
/**
* Returns the creation date field.
*
* @return integer Returns the creation date field.
* @return integer
*/
public function getCreationDate() { return $this->_creationDate; }
/**
* Returns the data packets field.
*
* @return integer Returns the data packets field.
* @return integer
*/
public function getDataPacketsCount() { return $this->_dataPacketsCount; }
/**
* Returns the play duration field.
*
* @return integer Returns the play duration field.
* @return integer
*/
public function getPlayDuration() { return $this->_playDuration; }
/**
* Returns the send duration field.
*
* @return integer Returns the send duration field.
* @return integer
*/
public function getSendDuration() { return $this->_sendDuration; }
/**
* Returns the preroll field.
*
* @return integer Returns the preroll field.
* @return integer
*/
public function getPreroll() { return $this->_preroll; }
/**
* Returns the flags field.
*
* @return integer Returns the flags field.
* @return integer
*/
public function getFlags() { return $this->_flags; }
/**
* Returns the minimum data packet size field.
*
* @return integer Returns the minimum data packet size field.
* @return integer
*/
public function getMinimumDataPacketSize()
{
@@ -212,7 +196,7 @@ final class ASF_FilePropertiesObject extends ASF_Object
/**
* Returns the maximum data packet size field.
*
* @return integer Returns the maximum data packet size field.
* @return integer
*/
public function getMaximumDataPacketSize()
{
@@ -222,10 +206,7 @@ final class ASF_FilePropertiesObject extends ASF_Object
/**
* Returns the maximum bitrate field.
*
* @return integer Returns the maximum bitrate field.
* @return integer
*/
public function getMaximumBitrate()
{
return $this->_maximumBitrate;
}
public function getMaximumBitrate() { return $this->_maximumBitrate; }
}

68
src/ASF/HeaderObject.php
View File

@@ -1,10 +1,6 @@
<?php
/**
* $Id$
*
*
* Copyright (C) 2006, 2007 The Bearpaw Project Work Group. All Rights Reserved.
* Copyright (C) 2007, 2008 BEHR Software Systems. All Rights Reserved.
* PHP Reader Library
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,7 +26,12 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @package php-reader
* @package php-reader
* @subpackage ASF
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Id$
*/
/**#@+ @ignore */
@@ -38,38 +39,43 @@ require_once("Object.php");
/**#@-*/
/**
* The ASF_Header_Object object implementation. This object contains objects
* that give information about the file. See corresponding object classes for
* more.
* The <i>ASF_Header_Object</i> object implementation. This object contains
* objects that give information about the file. See corresponding object
* classes for more.
*
* @package php-reader
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright 2006, 2007 The Bearpaw Project Work Group
* @copyright 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
* @package php-reader
* @subpackage ASF
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
*/
final class ASF_HeaderObject extends ASF_Object
{
/**
* @var integer The number of the objects the header contains.
*/
/** @var integer */
private $_objectCount;
/**
* @var integer Internal variable to have the start of the stream stored in.
* @internal Internal variable to have the start of the stream stored in.
* @var integer
*/
private $_readerSOffset;
/**
* @var integer Internal variable to have the current position of the
* stream pointer stored in.
* @internal Internal variable to have the current position of the stream
* pointer stored in.
* @var integer
*/
private $_readerCOffset;
/**
* Default constructor. Initiates the class with given parameters and reads
* object information from the file.
* Constructs the class with given parameters and reads object related data
* from the ASF file.
*
* @param Reader $reader The reader object.
* @param string $id The object GUID identifier.
* @param integer $size The object size.
*/
public function __construct($reader, $id, $size)
{
@@ -84,15 +90,16 @@ final class ASF_HeaderObject extends ASF_Object
/**
* Returns the number of standard ASF header objects this object contains.
*
* @return integer The number of objects the header contains.
* @return integer
*/
public function getObjectCount() { return $this->_objectCount; }
/**
* Checks whether there is more to be read within the bounds of the parent
* object size.
* object size. Returns <var>true</var> if there are child objects unread,
* <var>false</var> otherwise.
*
* @return boolean Boolean value corresponding whether there is more to read.
* @return boolean
*/
public function hasChildObjects()
{
@@ -100,13 +107,12 @@ final class ASF_HeaderObject extends ASF_Object
}
/**
* Returns the next standard ASF object or <var>false</var> if end of stream
* has been reached.
* Returns the next ASF object or <var>false</var> if end of stream has been
* reached. Returned objects are of the type <var>ASFObject</var> or of any of
* the other object types that inherit from that base class.
*
* @todo Only limited subset of possible child objects are regognized.
* @return ASF_Object Returns the appropriate object. Returned objects are of
* the type ASFObject or of any of the other object types that inherit
* from that base class.
* @return ASF_Object|false
*/
public function nextChildObject()
{

48
src/ASF/Object.php
View File

@@ -1,10 +1,6 @@
<?php
/**
* $Id$
*
*
* Copyright (C) 2006, 2007 The Bearpaw Project Work Group. All Rights Reserved.
* Copyright (C) 2007, 2008 BEHR Software Systems. All Rights Reserved.
* PHP Reader Library
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
@@ -30,38 +26,50 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @package php-reader
* @package php-reader
* @subpackage ASF
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Id$
*/
/**
* The base class for all ASF objects.
*
* @package php-reader
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright 2006, 2007 The Bearpaw Project Work Group
* @copyright 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
* @package php-reader
* @subpackage ASF
* @author Sven Vollbehr <sven.vollbehr@behrss.eu>
* @copyright Copyright (c) 2006, 2007 The Bearpaw Project Work Group
* @copyright Copyright (c) 2007, 2008 BEHR Software Systems
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version $Rev$
*/
class ASF_Object
{
/**
* @var Reader The reader associated with this object.
* The reader object.
*
* @var Reader
*/
protected $_reader;
/**
* @var string Object's ID
*/
/** @var string */
private $_id;
/**
* @var integer Object size in bytes.
* The object size in bytes.
*
* @var integer
*/
protected $_size;
/**
* Constructs the object with the given parameters.
* Constructs the class with given parameters.
*
* @param Reader $reader The reader object.
* @param string $id The object GUID identifier.
* @param integer $size The object size.
*/
public function __construct($reader, $id, $size)
{
@@ -73,7 +81,7 @@ class ASF_Object
/**
* Returns the GUID of the ASF object.
*
* @return string Returns the GUID of the ASF object.
* @return string
*/
public function getID() { return $this->_id; }
public function getIdentifier() { return $this->_id; }
}