Adding clear list functionality, fixes php-tmdb#22 and thus can be cl…

…osed.

examples/lists/api/list_clear.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * This file is part of the Tmdb PHP API created by Michael Roterman.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @package Tmdb
+ * @author Michael Roterman <[email protected]>
+ * @copyright (c) 2013, Michael Roterman
+ * @version 0.0.1
+ */
+require_once '../../../vendor/autoload.php';
+require_once '../../../apikey.php';
+
+$token = new \Tmdb\ApiToken(TMDB_API_KEY);
+$client = new \Tmdb\Client($token);
+
+$sessionToken = new \Tmdb\SessionToken(TMDB_SESSION_TOKEN);
+$client->setSessionToken($sessionToken);
+
+$clear = $client->getListsApi()->clearList(TMDB_LIST_ID, true);
+
+var_dump($clear);

lib/Tmdb/Api/Lists.php

@@ -98,4 +98,23 @@ public function deleteList($id)
     {
         return $this->delete('list/' . $id);
     }
+
+    /**
+     * Clear all of the items within a list.
+     *
+     * This is a irreversible action and should be treated with caution.
+     * A valid session id is required.
+     *
+     * @param  string  $id
+     * @param  boolean $confirm
+     * @return mixed
+     */
+    public function clearList($id, $confirm)
+    {
+        return $this->post(sprintf(
+                'list/%s/clear?confirm=%s',
+                $id,
+                (bool) $confirm === true ? 'true':'false'
+            ));
+    }
 }

lib/Tmdb/Repository/ListRepository.php

@@ -114,6 +114,23 @@ public function deleteList($id)
         );
     }
 
+    /**
+     * Clear all of the items within a list.
+     *
+     * This is a irreversible action and should be treated with caution.
+     * A valid session id is required.
+     *
+     * @param  string     $id
+     * @param  boolean    $confirm
+     * @return ItemStatus
+     */
+    public function clearList($id, $confirm)
+    {
+        return $this->getFactory()->createResult(
+            $this->getApi()->deleteList($id, (bool) $confirm)
+        );
+    }
+
     /**
      * Return the related API class
      *

test/Tmdb/Tests/Api/ListsTest.php

@@ -78,6 +78,15 @@ public function shouldDeleteList()
         $api->deleteList(self::LIST_ID);
     }
 
+    /**
+     * @test
+     */
+    public function shouldClearList()
+    {
+        $api = $this->getApiMock();
+        $api->clearList(self::LIST_ID, true);
+    }
+
     protected function getApiClass()
     {
         return 'Tmdb\Api\Lists';

test/Tmdb/Tests/Repository/ListRepositoryTest.php

@@ -77,6 +77,16 @@ public function shouldDeleteList()
         $repository->deleteList('list-id');
     }
 
+    /**
+     * @test
+     */
+    public function shouldClearList()
+    {
+        $repository = $this->getRepositoryWithMockedHttpClient();
+
+        $repository->clearList('list-id', true);
+    }
+
     protected function getApiClass()
     {
         return 'Tmdb\Api\Lists';