MovingImage24 / VMProApiClient

lib/ApiClient/AbstractCoreApiClient.php

Doc Comments +3 added lines, -2 removed lines

@@ -137,7 +137,7 @@ 
     /**
      * Deserialize a response into an instance of it's associated class.
      *
-     * @return object
+     * @return \Doctrine\Common\Collections\ArrayCollection
      */
     protected function deserialize(string $data, string $serialisationClass)
     {
@@ -191,6 +191,7 @@ 
 
     /**
      * Checks if the request may be cached.
+     * @param ResponseInterface $response
      */
     private function isCacheable(string $method, string $uri, array $options, $response): bool
     {
@@ -220,7 +221,7 @@ 
      * Serializes the provided response to a string, suitable for caching.
      * The type of the $response argument varies depending on the guzzle version.
      *
-     * @param mixed $response
+     * @param ResponseInterface $response
      *
      * @return string
      */

lib/Factory/Guzzle6ApiClientFactory.php

Doc Comments +1 added lines

@@ -37,6 +37,7 @@
 
     /**
      * Method to instantiate a HTTP client.
+     * @param TokenMiddleware[] $middlewares
      */
     public function createHttpClient(string $baseUri, ?array $middlewares, ?array $options = []): ClientInterface
     {

lib/Interfaces/ApiClientInterface.php

Doc Comments +20 added lines

@@ -38,6 +38,7 @@ 
 
     /**
      * Get a specific channel.
+     * @return Channel|null
      */
     public function getChannel(int $videoManagerId, int $channelId): ?Channel;
 
@@ -73,6 +74,7 @@ 
 
     /**
      * Update a video with new values.
+     * @return void
      */
     public function updateVideo(
         int $videoManagerId,
@@ -84,16 +86,19 @@ 
 
     /**
      * Add a video to a channel.
+     * @return void
      */
     public function addVideoToChannel(int $videoManagerId, string $videoId, int $channelId): void;
 
     /**
      * Remove a video from a channel.
+     * @return void
      */
     public function removeVideoFromChannel(int $videoManagerId, string $videoId, int $channelId): void;
 
     /**
      * Add/remove/update custom metadata fields to a video.
+     * @return void
      */
     public function setCustomMetaData(int $videoManagerId, string $videoId, array $metadata): void;
 
@@ -109,6 +114,7 @@ 
 
     /**
      * Delete a video.
+     * @return void
      */
     public function deleteVideo(int $videoManagerId, string $videoId): void;
 
@@ -137,11 +143,13 @@ 
 
     /**
      * Update video keywords.
+     * @return void
      */
     public function updateKeywords(int $videoManagerId, string $videoId, array $keywords): void;
 
     /**
      * Delete keyword from video by keyword id.
+     * @return void
      */
     public function deleteKeyword(int $videoManagerId, string $videoId, int $keywordId): void;
 
@@ -184,14 +192,23 @@ 
      */
     public function getVideoDownloadUrls(int $videoManagerId, string $videoId): ArrayCollection;
 
+    /**
+     * @return \MovingImage\Client\VMPro\Entity\Thumbnail|null
+     */
     public function createThumbnailByTimestamp(
         int $videoManagerId,
         string $videoId,
         int $timestamp
     ): ?ThumbnailInterface;
 
+    /**
+     * @return \MovingImage\Client\VMPro\Entity\Thumbnail|null
+     */
     public function getThumbnail(int $videoManagerId, string $videoId, int $thumbnailId): ?ThumbnailInterface;
 
+    /**
+     * @return void
+     */
     public function updateThumbnail(int $videoManagerId, string $videoId, int $thumbnailId, bool $active): void;
 
     public function getUserInfo(string $token): UserInfo;
@@ -206,6 +223,9 @@ 
 
     public function getCorporateTubeMetadata(int $videoManagerId, string $videoId): CorporateTubeMetaData;
 
+    /**
+     * @return void
+     */
     public function updateCorporateTubeMetadata(
         int $videoManagerId,
         string $videoId,