Added in the item parent base class and added a couple of updates to …

…comments in the item base class and item grandparent base class.

Server/Library/ItemAbstract.php

@@ -52,7 +52,7 @@ abstract class Plex_Server_Library_ItemAbstract
 	protected $librarySectionId;
 
 	/**
-	 * TODO Figure out what the rating key is.
+	 * Unique integer that represents an item and helps build its key string.
 	 * @var integer
 	 */
 	protected $ratingKey;

Server/Library/ItemGrandparentAbstract.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Plex Library Grandparent Item
  * 

Server/Library/ItemParentAbstract.php

@@ -0,0 +1,284 @@
+<?php
+
+/**
+ * Season
+ * Album
+ */
+/**
+ * Plex Library Grandparent Item
+ * 
+ * @category php-plex
+ * @package Plex_Server
+ * @subpackage Plex_Server_Library
+ * @author <[email protected]> Nick Bartkowiak
+ * @copyright (c) 2012 Nick Bartkowiak
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GNU Public Licence (GPLv3)
+ * @version 0.0.1
+ *
+ * This file is part of php-plex.
+ * 
+ * php-plex is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * php-plex is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+/**
+ * Base class that represents a Plex library item at the top of the hierarchy.
+ * This includes items such as shows and artists. The methods and members,
+ * however, are still inherited by parent and child items.
+ * 
+ * @category php-plex
+ * @package Plex_Server
+ * @subpackage Plex_Server_Library
+ * @author <[email protected]> Nick Bartkowiak
+ * @copyright (c) 2012 Nick Bartkowiak
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GNU Public Licence (GPLv3)
+ * @version 0.0.1
+ */
+abstract class Plex_Server_Library_ItemParentAbstract 
+	extends Plex_Server_Library_ItemGrandparentAbstract
+
+{
+	/**
+	 * Unique integer that represents a parent item and helps build its key 
+	 * string.
+	 * @var integer
+	 */
+	protected $parentRatingKey;
+
+	/**
+	 * Parent item's key.
+	 * @var string
+	 */
+	protected $parentKey;
+
+	/**
+	 * Parent item's title.
+	 * @var string
+	 */
+	protected $parentTitle;
+
+	/**
+	 * Parent item's index.
+	 * @var integer
+	 */
+	protected $parentIndex;
+
+	/**
+	 * Reference to the parent item's thumb.
+	 * @var string
+	 */
+	protected $parentThumb;
+
+	/**
+	 * Date the item was made originally available.
+	 * @var DateTime
+	 */
+	protected $originallyAvailalbleAt;
+
+	/**
+	 * Sets an array of attribues, if they exist, to the corresponding class
+	 * member.
+	 * 
+	 * @param array $attribute An array of item attributes as passed back by the
+	 * Plex HTTP API.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::setParentRatingKey()
+	 * @uses Plex_Server_Library_ItemParentAbstract::setParentKey()
+	 * @uses Plex_Server_Library_ItemParentAbstract::setParentTitle()
+	 * @uses Plex_Server_Library_ItemParentAbstract::setParentIndex()
+	 * @uses Plex_Server_Library_ItemParentAbstract::setParentThumb()
+	 * @uses Plex_Server_Library_ItemParentAbstract::originallyAvailableAt()
+	 *
+	 * @return void 
+	 */
+	public function setAttributes($attribute)
+	{
+		parent::setAttributes($attribute);
+
+		if (isset($attribute['parentRatingKey'])) {
+			$this->setParentRatingKey($attribute['parentRatingKey']);
+		}
+		if (isset($attribute['parentKey'])) {
+			$this->setParentKey($attribute['parentKey']);
+		}
+		if (isset($attribute['parentTitle'])) {
+			$this->setParentTitle($attribute['parentTitle']);
+		}
+		if (isset($attribute['parentIndex'])) {
+			$this->setParentIndex($attribute['parentIndex']);
+		}
+		if (isset($attribute['parentThumb'])) {
+			$this->setParentThumb($attribute['parentThumb']);
+		}
+		if (isset($attribute['originallyAvailableAt'])) {
+			$this->setOriginallyAvailableAt(
+				$attribute['originallyAvailableAt']
+			);
+		}
+	}
+
+	/**
+	 * Returns the parent item's rating key.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentRatingKey
+	 *
+	 * @return integer The parent item's rating key.
+	 */
+	public function getParentRatingKey()
+	{
+		return (int) $this->parentRatingKey;
+	}
+
+	/**
+	 * Sets the parent item's rating key.
+	 *
+	 * @param integer $parentRatingKey The parent item's rating key.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentRatingKey
+	 *
+	 * @return void
+	 */
+	public function setParentRatingKey($parentRatingKey)
+	{
+		$this->parentRatingKey = (int) $parentRatingKey;
+	}
+
+	/**
+	 * Returns the parent item's key.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentKey
+	 *
+	 * @return string The parent item's key.
+	 */
+	public function getParentKey()
+	{
+		return $this->parentKey;
+	}
+
+	/**
+	 * Sets the parent item's key.
+	 *
+	 * @param string $parentKey The parent item's key.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentKey
+	 *
+	 * @return void
+	 */
+	public function setParentKey($parentKey)
+	{
+		$this->parentKey = $parentKey;
+	}
+
+	/**
+	 * Returns the parent item's title.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentTitle
+	 *
+	 * @return string The parent item's title.
+	 */
+	public function getParentTitle()
+	{
+		return $this->parentTitle;
+	}
+
+	/**
+	 * Sets the parent item's title.
+	 *
+	 * @param string $parentTitle string The parent item's title.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentTitle
+	 *
+	 * @return void
+	 */
+	public function setParentTitle($parentTitle)
+	{
+		$this->parentTitle = $parentTitle;
+	}
+
+	/**
+	 * Returns the parent item's index.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentIndex
+	 *
+	 * @return integer The parent item's index.
+	 */
+	public function getParentIndex()
+	{
+		return (int) $this->parentIndex;
+	}
+
+	/**
+	 * Sets the parent item's index.
+	 *
+	 * @param integer $parentRatingKey The parent item's index.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentIndex
+	 *
+	 * @return void
+	 */
+	public function setParentIndex($parentIndex)
+	{
+		$this->parentIndex = (int) $parentIndex;
+	}
+
+	/**
+	 * Returns the parent item's thumb.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentThumb
+	 *
+	 * @return string The parent item's thumb.
+	 */
+	public function getParentThumb()
+	{
+		return $this->parentThumb;
+	}
+
+	/**
+	 * Sets the parent item's thumb.
+	 *
+	 * @param string $parentTitle string The parent item's thumb.
+	 *
+	 * @uses Plex_Server_Library_ItemParentAbstract::$parentThumb
+	 *
+	 * @return void
+	 */
+	public function setParentThumb($parentThumb)
+	{
+		$this->parentThumb = $parentThumb;
+	}
+
+	/**
+	 * Returns the date at which the item was made available.
+	 *
+	 * @uses Plex_Server_Library_ItemAbstract::$originallyAvailableAt
+	 *
+	 * @return DateTime The time at which the item was made available.
+	 */	
+	public function getOriginallyAvailalbleAt()
+	{
+		return $this->originallyAvailableAt;
+	}
+
+	/**
+	 * Sets the time at which the item was made available.
+	 *
+	 * @param integer $updatedAtTs The unix timestamp representing the time the
+	 * item was made available. This will be turned into a DateTime object.
+	 * 
+	 * @uses Plex_Server_Library_ItemAbstract::$originallyAvailableAt
+	 *
+	 * @return void
+	 */
+	public function setOriginallyAvailableAt($originallyAvailableAtTs)
+	{
+		$originallyAvailableAt = new DateTime($originallyAvailableAtTs);
+		$this->originallyAvailableAt = $originallyAvailableAt;
+	}
+}