Added search capability for TV shows.

Author: nickbart

Server/Library/Section/Show.php

@@ -246,4 +246,27 @@ public function getContentRatings()
 			)
 		);
 	}
+	
+	/**
+	 * Searches show titles for the passed query and returns the shows that
+	 * match.
+	 *
+	 * @param string $query The search term against which the shows will be
+	 * matched.
+	 *
+	 * @uses Plex_Server_Library::getItems()
+	 * @uses Plex_Server_Library_SectionAbstract::buildSearchEndpoint()
+	 * @uses Plex_Server_Library_SectionAbstract::SEARCH_TYPE_SHOW
+	 *
+	 * @return Plex_Server_Library_Item_Show[] An array of show objects.
+	 */
+	public function searchShows($query)
+	{
+		return $this->getItems(
+			$this->buildSearchEndpoint(
+				Plex_Server_Library_SectionAbstract::SEARCH_TYPE_SHOW,
+				$query
+			)
+		);
+	}
 }

Server/Library/SectionAbstract.php

@@ -106,12 +106,12 @@ abstract class Plex_Server_Library_SectionAbstract extends Plex_Server_Library
 	protected $createdAt;
 
 	/**
-	 * Endpoint for retrieiving all items for a section.
+	 * Endpoint for retrieving all items for a section.
 	 */
 	const ENDPOINT_CATEGORY_ALL = 'all';
 
 	/**
-	 * Endpoint for retrieiving all unwatched items for a section.
+	 * Endpoint for retrieving all unwatched items for a section.
 	 */
 	const ENDPOINT_CATEGORY_UNWATCHED = 'unwatched';
 
@@ -151,10 +151,40 @@ abstract class Plex_Server_Library_SectionAbstract extends Plex_Server_Library
 	const ENDPOINT_CATEGORY_GENRE = 'genre';
 
 	/**
-	 * Endpoint for retrieiving items for a sectoin by year.
+	 * Endpoint for retrieiving items for a section by year.
 	 */
 	const ENDPOINT_CATEGORY_YEAR = 'year';
 
+	/**
+	 * Endpoing for searching a section for items.
+	 */
+	const ENDPOINT_SEARCH = 'search';
+	
+	/**
+	 * Parameter for searching movies.
+	 */
+	const SEARCH_TYPE_MOVIE = 1;
+
+	/**
+	 * Parameter for searching television shows.
+	 */
+	const SEARCH_TYPE_SHOW = 2;
+	
+	/**
+	 * Parameter for searching teleivision episodes.
+	 */
+	const SEARCH_TYPE_EPISODE = 4;
+
+	/**
+	 * Parameter for searching artists.
+	 */
+	const SEARCH_TYPE_ARTIST = 8;
+
+	/**
+	 * Parameter for searching tracks.
+	 */
+	const SEARCH_TYPE_TRACK = 10;
+	
 	/**
 	 * Adds the attributes to the object if they exist.
 	 *
@@ -220,7 +250,7 @@ public function setAttributes($attribute)
 	 * @uses Plex_Server_Library::ENDPOINT_SECTION
 	 * @uses Plex_Server_Library_SectionAbstract::getKey()
 	 *
-	 * @return void
+	 * @return string The requested endpoint.
 	 */
 	protected function buildEndpoint($endpoint)
 	{
@@ -232,6 +262,30 @@ protected function buildEndpoint($endpoint)
 		);
 	}
 
+	/**
+	 * Builds an endpoint to search a Plex library section.
+	 *
+	 * @param integer $type The type of item to be searched.
+	 * @param string $query The string of text against which the search will be
+	 * run.
+	 *
+	 * @uses Plex_Server_Library_SectionAbstract::ENDPOINT_SEARCH
+	 * @uses Plex_Server_Library_SectionAbstract::buildEndpoint()
+	 *
+	 * @return string The requested search endpoint.
+	 */
+	protected function buildSearchEndpoint($type, $query)
+	{
+		$endpoint = sprintf(
+			'%s?type=%d&query=%s',
+			self::ENDPOINT_SEARCH,
+			$type,
+			trim($query)
+		);
+		
+		return $this->buildEndpoint($endpoint);
+	}
+	
 	/**
 	 * Generic method allowing a child class to retrieve all items for its
 	 * section.