phanan / koel

app/Models/Setting.php

Doc Comments +2 added lines, -2 removed lines

@@ -31,9 +31,9 @@
     /**
      * Set a setting (no pun) value.
      *
-     * @param string|array $key   The key of the setting, or an associative array of settings,
+     * @param string $key   The key of the setting, or an associative array of settings,
      *                            in which case $value will be discarded.
-     * @param mixed        $value
+     * @param string        $value
      */
     public static function set($key, $value = null)
     {

app/Services/Lastfm.php

Doc Comments +1 added lines, -1 removed lines

@@ -250,7 +250,7 @@
      * @param string    $artist   Name of the artist
      * @param string    $track    Name of the track
      * @param string    $album    Name of the album
-     * @param int|float $duration Duration of the track, in seconds
+     * @param double $duration Duration of the track, in seconds
      * @param string    $sk       The session key
      *
      * @return bool

app/Services/RESTfulService.php

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
      */
     protected $secret;
 
+    /**
+     * @param string $endpoint
+     */
     public function __construct($key, $secret, $endpoint, Client $client)
     {
         $this->setKey($key);

app/Models/File.php

Doc Comments +2 added lines, -2 removed lines

@@ -189,7 +189,7 @@ 
      * @param array $tags  The (selective) tags to sync (if the song exists)
      * @param bool  $force Whether to force syncing, even if the file is unchanged
      *
-     * @return bool|Song A Song object on success,
+     * @return integer A Song object on success,
      *                   true if file exists but is unmodified,
      *                   or false on an error.
      */
@@ -358,7 +358,7 @@ 
      *
      * @throws \InvalidArgumentException
      *
-     * @return string|false The cover file's full path, or false if none found
+     * @return string The cover file's full path, or false if none found
      */
     private function getCoverFileUnderSameDirectory()
     {

app/Services/Media.php

Doc Comments +1 added lines, -1 removed lines

@@ -214,7 +214,7 @@
     /**
      * Generate a unique hash for a file path.
      *
-     * @param $path
+     * @param string $path
      *
      * @return string
      */

app/Http/Controllers/API/SongController.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
      * @param null|int  $bitRate   The target bit rate to transcode, defaults to OUTPUT_BIT_RATE.
      *                             Only taken into account if $transcode is truthy.
      *
-     * @return RedirectResponse|Redirector
+     * @return RedirectResponse|null
      */
     public function play(Request $request, Song $song, $transcode = null, $bitRate = null)
     {

app/Services/Musixmatch.php

Doc Comments +3 added lines, -3 removed lines

@@ -36,7 +36,7 @@ 
     }
     
     /**
-     * @param App\Models\Song $song
+     * @param Song $song
      * 
      * @return mixed|null
      */
@@ -60,7 +60,7 @@ 
      * @param string $name
      * @param string $artistName
      * 
-     * @return mixed|false
+     * @return false|string
      */
     public function search(string $name, string $artistName = null)
     {
@@ -98,7 +98,7 @@ 
     /**
      * @param JSON $response
      * 
-     * @return string|null
+     * @return string|false
      */
     private function getLyrics($response)
     {

Spacing +5 added lines, -5 removed lines

@@ -42,7 +42,7 @@ 
      */
     public function searchLyricsRelatedToSong(Song $song)
     {
-        if($song->hasLyrics() == false)
+        if ($song->hasLyrics() == false)
         {
             if (!$song->artist->isUnknown() && !$song->artist->isVarious()) {
                 $lyrics = $this->search($song->title, $song->artist->name);
@@ -74,11 +74,11 @@ 
             $this->key
         );
         
-        try{
+        try {
             $response = $this->jsonpDecode($this->get($uri));
             
             return $this->getLyrics($response);
-        }catch(\Exception $e){
+        } catch (\Exception $e) {
             Log::error($e);
 
             return false;
@@ -92,7 +92,7 @@ 
      */
     private function jsonpDecode($response)
     {
-        return json_decode(substr(preg_replace("/[^(]*\((.*)\)/","$1",$response), 0, -1));
+        return json_decode(substr(preg_replace("/[^(]*\((.*)\)/", "$1", $response), 0, -1));
     }
     
     /**
@@ -104,7 +104,7 @@ 
     {
         $lyrics = $response->message->body->lyrics->lyrics_body;
         
-        if(strlen($lyrics))
+        if (strlen($lyrics))
         {
             // Correct Musixmatch spelling mistake (is for are).
             return substr($lyrics, 0, strpos($lyrics, "******* This Lyrics is NOT for Commercial use *******")).