Merge pull request #248 from php-tmdb/TvEpisodeGroups

Tv episode groups

lib/Tmdb/Api/Tv.php

@@ -295,4 +295,15 @@ public function getAlternativeTitles($id)
     {
         return $this->get('tv/' . $id . '/alternative_titles');
     }
+
+    /**
+     * Get the alternative titles for a specific show ID.
+     *
+     * @param integer $id
+     * @return mixed
+     */
+    public function getEpisodeGroups($id)
+    {
+        return $this->get('tv/' . $id . '/episode_groups');
+    }
 }

lib/Tmdb/Api/TvEpisodeGroup.php

@@ -0,0 +1,46 @@
+<?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 sheriffmarley
+ * @copyright (c) 2013, Michael Roterman
+ * @version 4.0.0
+ */
+
+namespace Tmdb\Api;
+
+/**
+ * Class TvEpisode
+ * @package Tmdb\Api
+ * @see http://docs.themoviedb.apiary.io/#tvepisodes
+ */
+class TvEpisodeGroup extends AbstractApi
+{
+    /**
+     * Get the primary information about a TV episode group by it's id.
+     *
+     * @param $episode_group
+     * @param array $parameters
+     * @param array $headers
+     * @return mixed
+     */
+    public function getEpisodeGroup(
+        $episode_group,
+        array $parameters = [],
+        array $headers = []
+    ) {
+        return $this->get(
+            sprintf(
+                'tv/episode_group/%s',
+                $episode_group
+            ),
+            $parameters,
+            $headers
+        );
+    }
+}

lib/Tmdb/ApiMethodsTrait.php

@@ -207,4 +207,12 @@ public function getTvEpisodeApi()
     {
         return new Api\TvEpisode($this);
     }
+
+    /**
+     * @return Api\TvEpisodeGroup
+     */
+    public function getTvEpisodeGroupApi()
+    {
+        return new Api\TvEpisodeGroup($this);
+    }
 }

lib/Tmdb/Factory/MovieFactory.php

@@ -211,7 +211,7 @@ public function create(array $data = []): ?AbstractModel
             $watchProviders = new GenericCollection();
             foreach ($data['watch/providers']['results'] as $iso31661 => $countryWatchData) {
                 $countryWatchData['iso_3166_1'] = $iso31661;
-                
+
                 foreach (['flatrate', 'rent', 'buy'] as $providerType) {
                     $typeProviders = new GenericCollection();
                     foreach ($countryWatchData[$providerType] ?? [] as $providerData) {
@@ -221,14 +221,14 @@ public function create(array $data = []): ?AbstractModel
                         if (isset($providerData['provider_name'])) {
                             $providerData['name'] = $providerData['provider_name'];
                         }
-                        
+
                         $providerData['iso_3166_1'] = $iso31661;
                         $providerData['type'] = $providerType;
                         $typeProviders->add(null, $this->hydrate(new Watch\Provider(), $providerData));
                     }
                     $countryWatchData[$providerType] = $typeProviders;
                 }
-                
+
                 $watchProviders->add($iso31661, $this->hydrate(new Watch\Providers(), $countryWatchData));
             }
             $movie->setWatchProviders($watchProviders);

lib/Tmdb/Factory/TvEpisodeGroupFactory.php

@@ -0,0 +1,84 @@
+<?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 sheriffmarley
+ * @copyright (c) 2013, Michael Roterman
+ * @version 4.0.0
+ */
+
+namespace Tmdb\Factory;
+
+use Tmdb\Model\Network;
+use Tmdb\Model\AbstractModel;
+use Tmdb\Model\Tv\EpisodeGroup;
+use Tmdb\HttpClient\HttpClient;
+use Tmdb\Model\Common\GenericCollection;
+
+/**
+ * Class TvEpisodeGroupFactory
+ * @package Tmdb\Factory
+ */
+class TvEpisodeGroupFactory extends AbstractFactory
+{
+
+    /**
+     * @var TvEpisodeGroupsFactory
+     */
+    private $tvEpisodeGroupsFactory;
+
+    /**
+     * Constructor
+     *
+     * @param HttpClient $httpClient
+     */
+    public function __construct(HttpClient $httpClient)
+    {
+        $this->tvEpisodeGroupsFactory = new TvEpisodeGroupsFactory($httpClient);
+
+        parent::__construct($httpClient);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createCollection(array $data = [])
+    {
+        $collection = new GenericCollection();
+
+        foreach ($data as $item) {
+            $collection->add(null, $this->create($item));
+        }
+
+        return $collection;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return AbstractModel|null
+     */
+    public function create(array $data = []): ?AbstractModel
+    {
+        if (!$data) {
+            return null;
+        }
+
+        $episodeGroup = new EpisodeGroup();
+
+        if (array_key_exists('network', $data) && !is_null($data['network'])) {
+            $episodeGroup->setNetwork($this->hydrate(new Network(), $data['network']));
+        }
+
+        if (array_key_exists('groups', $data) && $data['groups'] !== null) {
+            $episodeGroup->setGroups($this->tvEpisodeGroupsFactory->createCollection($data['groups']));
+        }
+
+        return $this->hydrate($episodeGroup, $data);
+    }
+}

lib/Tmdb/Factory/TvEpisodeGroupsFactory.php

@@ -0,0 +1,99 @@
+<?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 sheriffmarley
+ * @copyright (c) 2013, Michael Roterman
+ * @version 4.0.0
+ */
+
+namespace Tmdb\Factory;
+
+use Tmdb\Model\AbstractModel;
+use Tmdb\HttpClient\HttpClient;
+use Tmdb\Model\Tv\TvEpisodeGroup;
+use Tmdb\Model\Common\GenericCollection;
+
+/**
+ * Class TvEpisodeGroupsFactory
+ * @package Tmdb\Factory
+ */
+class TvEpisodeGroupsFactory extends AbstractFactory
+{
+
+    /**
+     * @var TvEpisodeFactory
+     */
+    private $tvEpisodeFactory;
+
+    /**
+     * Constructor
+     *
+     * @param HttpClient $httpClient
+     */
+    public function __construct(HttpClient $httpClient)
+    {
+        $this->tvEpisodeFactory = new TvEpisodeFactory($httpClient);
+
+        parent::__construct($httpClient);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createCollection(array $data = [])
+    {
+        $collection = new GenericCollection();
+
+        foreach ($data as $item) {
+            $collection->add(null, $this->create($item));
+        }
+
+        return $collection;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return AbstractModel|null
+     */
+    public function create(array $data = []): ?AbstractModel
+    {
+        if (!$data) {
+            return null;
+        }
+
+        $tvEpisodeGroup = new TvEpisodeGroup();
+
+        /** Episodes */
+        if (array_key_exists('episodes', $data) && $data['episodes'] !== null) {
+            $tvEpisodeGroup->setEpisodes($this->getTvEpisodeFactory()->createCollection($data['episodes']));
+        }
+
+        return $this->hydrate($tvEpisodeGroup, $data);
+    }
+
+    /**
+     * @return TvEpisodeFactory
+     */
+    public function getTvEpisodeFactory()
+    {
+        return $this->tvEpisodeFactory;
+    }
+
+    /**
+     * @param TvEpisodeFactory $tvEpisodeFactory
+     * @return $this
+     */
+    public function setTvEpisodeFactory($tvEpisodeFactory)
+    {
+        $this->tvEpisodeFactory = $tvEpisodeFactory;
+
+        return $this;
+    }
+}

lib/Tmdb/Factory/TvFactory.php

@@ -26,6 +26,7 @@
 use Tmdb\Model\Common\SpokenLanguage;
 use Tmdb\Model\Common\Translation;
 use Tmdb\Model\Company;
+use Tmdb\Model\Network;
 use Tmdb\Model\Person\CastMember;
 use Tmdb\Model\Person\CrewMember;
 use Tmdb\Model\Tv;
@@ -249,7 +250,7 @@ public function create(array $data = []): ?AbstractModel
             $watchProviders = new GenericCollection();
             foreach ($data['watch/providers']['results'] as $iso31661 => $countryWatchData) {
                 $countryWatchData['iso_3166_1'] = $iso31661;
-                
+
                 foreach (['flatrate', 'rent', 'buy'] as $providerType) {
                     $typeProviders = new GenericCollection();
                     foreach ($countryWatchData[$providerType] ?? [] as $providerData) {
@@ -259,14 +260,14 @@ public function create(array $data = []): ?AbstractModel
                         if (isset($providerData['provider_name'])) {
                             $providerData['name'] = $providerData['provider_name'];
                         }
-                        
+
                         $providerData['iso_3166_1'] = $iso31661;
                         $providerData['type'] = $providerType;
                         $typeProviders->add(null, $this->hydrate(new Watch\Provider(), $providerData));
                     }
                     $countryWatchData[$providerType] = $typeProviders;
                 }
-                
+
                 $watchProviders->add($iso31661, $this->hydrate(new Watch\Providers(), $countryWatchData));
             }
             $tvShow->setWatchProviders($watchProviders);
@@ -343,6 +344,19 @@ public function create(array $data = []): ?AbstractModel
             );
         }
 
+        if (array_key_exists('episode_groups', $data) && array_key_exists('results', $data['episode_groups'])) {
+            $episodeGroupCollection = new GenericCollection();
+
+            foreach ($data['episode_groups']['results'] as $episodeGroup) {
+                if (!is_null($episodeGroup['network'])) {
+                    $episodeGroup['network'] = $this->hydrate(new Network(), $episodeGroup['network']);
+                }
+
+                $episodeGroupCollection->add(null, $this->hydrate(new Tv\EpisodeGroups(), $episodeGroup));
+            }
+            $tvShow->setEpisodeGroups($episodeGroupCollection);
+        }
+
         return $this->hydrate($tvShow, $data);
     }