Song::__toString() - Code Metrics - phanan/koel - Measure and Improve Code Quality continuously with Scrutinizer

Song::__toString() A
last analyzed 2020-03-12 15:39 UTC

↳ Parent: Song

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php

namespace App\Models;

use App\Events\LibraryChanged;
use App\Traits\SupportsDeleteWhereIDsNotIn;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Collection;

/**
 * @property string $path
 * @property string $title
 * @property Album  $album
 * @property Artist $artist
 * @property string[] $s3_params
 * @property float  $length
 * @property string $lyrics
 * @property int    $track
 * @property int    $disc
 * @property int    $album_id
 * @property string $id
 * @property int    $artist_id
 * @property int    $mtime
 *
 * @method static self updateOrCreate(array $where, array $params)
 * @method static Builder select(string $string)
 * @method static Builder inDirectory(string $path)
 * @method static self first()
 * @method static Collection orderBy(...$args)
 */
class Song extends Model
{
    use SupportsDeleteWhereIDsNotIn;

    protected $guarded = [];

    /**
     * Attributes to be hidden from JSON outputs.
     * Here we specify to hide lyrics as well to save some bandwidth (actually, lots of it).
     * Lyrics can then be queried on demand.
     *
     * @var array
     */
    protected $hidden = ['lyrics', 'updated_at', 'path', 'mtime'];

    /**
     * @var array
     */
    protected $casts = [
        'length' => 'float',
        'mtime' => 'int',
        'track' => 'int',
        'disc' => 'int',
    ];

    /**
     * Indicates if the IDs are auto-incrementing.
     *
     * @var bool
     */
    public $incrementing = false;

    public function artist(): BelongsTo
    {
        return $this->belongsTo(Artist::class);
    }

    public function album(): BelongsTo
    {
        return $this->belongsTo(Album::class);
    }

    public function playlists(): BelongsToMany
    {
        return $this->belongsToMany(Playlist::class);
    }

    public function interactions(): HasMany
    {
        return $this->hasMany(Interaction::class);
    }

    /**
     * Update song info.
     *
     * @param string[] $ids
     * @param string[] $data The data array, with these supported fields:
     *                       - title
     *                       - artistName
     *                       - albumName
     *                       - lyrics
     *                       All of these are optional, in which case the info will not be changed
     *                       (except for lyrics, which will be emptied).
     */
    public static function updateInfo(array $ids, array $data): Collection
    {
        /*
         * A collection of the updated songs.
         *
         * @var Collection
         */
        $updatedSongs = collect();

        $ids = (array) $ids;
        // If we're updating only one song, take into account the title, lyrics, and track number.
        $single = count($ids) === 1;

        foreach ($ids as $id) {
            /** @var Song $song */
            $song = self::with('album', 'album.artist')->find($id);

            if (!$song) {
                continue;
            }

            $updatedSongs->push($song->updateSingle(
                $single ? trim($data['title']) : $song->title,
                trim($data['albumName'] ?: $song->album->name),
                trim($data['artistName']) ?: $song->artist->name,
                $single ? trim($data['lyrics']) : $song->lyrics,
                $single ? (int) $data['track'] : $song->track,
                (int) $data['compilationState']
            ));
        }

        // Our library may have been changed. Broadcast an event to tidy it up if need be.
        if ($updatedSongs->count()) {
            event(new LibraryChanged());
        }

        return $updatedSongs;
    }

    public function updateSingle(
        string $title,
        string $albumName,
        string $artistName,
        string $lyrics,
        int $track,
        int $compilationState
    ): self {
        if ($artistName === Artist::VARIOUS_NAME) {
            // If the artist name is "Various Artists", it's a compilation song no matter what.
            $compilationState = 1;
            // and since we can't determine the real contributing artist, it's "Unknown"
            $artistName = Artist::UNKNOWN_NAME;
        }

        $artist = Artist::get($artistName);

        switch ($compilationState) {
            case 1: // ALL, or forcing compilation status to be Yes
                $isCompilation = true;
                break;
            case 2: // Keep current compilation status
                $isCompilation = $this->album->artist_id === Artist::VARIOUS_ID;
                break;
            default:
                $isCompilation = false;
                break;
        }

        $album = Album::get($artist, $albumName, $isCompilation);

        $this->artist_id = $artist->id;
        $this->album_id = $album->id;
        $this->title = $title;
        $this->lyrics = $lyrics;
        $this->track = $track;

        $this->save();

        // Clean up unnecessary data from the object
        unset($this->album);
        unset($this->artist);
        // and make sure the lyrics is shown
        $this->makeVisible('lyrics');

        return $this;
    }

    /**
     * Scope a query to only include songs in a given directory.
     */
    public function scopeInDirectory(Builder $query, string $path): Builder
    {
        // Make sure the path ends with a directory separator.
        $path = rtrim(trim($path), DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;

        return $query->where('path', 'LIKE', "$path%");
    }

    /**
     * Sometimes the tags extracted from getID3 are HTML entity encoded.
     * This makes sure they are always sane.
     */
    public function setTitleAttribute(string $value): void
    {
        $this->attributes['title'] = html_entity_decode($value);
    }

    /**
     * Some songs don't have a title.
     * Fall back to the file name (without extension) for such.
     */
    public function getTitleAttribute(?string $value): string
    {
        return $value ?: pathinfo($this->path, PATHINFO_FILENAME);
    }

    /**
     * Prepare the lyrics for displaying.
     */
    public function getLyricsAttribute(string $value): string
    {
        // We don't use nl2br() here, because the function actually preserves line breaks -
        // it just _appends_ a "<br />" after each of them. This would cause our client
        // implementation of br2nl to fail with duplicated line breaks.
        return str_replace(["\r\n", "\r", "\n"], '<br />', $value);
    }

    /**
     * Get the bucket and key name of an S3 object.
     *
     * @return string[]|null
     */
    public function getS3ParamsAttribute(): ?array
    {
        if (!preg_match('/^s3:\\/\\/(.*)/', $this->path, $matches)) {
            return null;
        }

        list($bucket, $key) = explode('/', $matches[1], 2);

        return compact('bucket', 'key');
    }

    /**
     * Return the ID of the song when it's converted to string.
     */
    public function __toString()
    {
        return $this->id;
    }
}


1		<?php
2
3		namespace App\Models;
4
5		use App\Events\LibraryChanged;
6		use App\Traits\SupportsDeleteWhereIDsNotIn;
7		use Illuminate\Database\Eloquent\Builder;
8		use Illuminate\Database\Eloquent\Model;
9		use Illuminate\Database\Eloquent\Relations\BelongsTo;
10		use Illuminate\Database\Eloquent\Relations\BelongsToMany;
11		use Illuminate\Database\Eloquent\Relations\HasMany;
12		use Illuminate\Support\Collection;
13
14		/**
15		* @property string $path
16		* @property string $title
17		* @property Album $album
18		* @property Artist $artist
19		* @property string[] $s3_params
20		* @property float $length
21		* @property string $lyrics
22		* @property int $track
23		* @property int $disc
24		* @property int $album_id
25		* @property string $id
26		* @property int $artist_id
27		* @property int $mtime
28		*
29		* @method static self updateOrCreate(array $where, array $params)
30		* @method static Builder select(string $string)
31		* @method static Builder inDirectory(string $path)
32		* @method static self first()
33		* @method static Collection orderBy(...$args)
34		*/
35		class Song extends Model
36		{
37		use SupportsDeleteWhereIDsNotIn;
38
39		protected $guarded = [];
40
41		/**
42		* Attributes to be hidden from JSON outputs.
43		* Here we specify to hide lyrics as well to save some bandwidth (actually, lots of it).
44		* Lyrics can then be queried on demand.
45		*
46		* @var array
47		*/
48		protected $hidden = ['lyrics', 'updated_at', 'path', 'mtime'];
49
50		/**
51		* @var array
52		*/
53		protected $casts = [
54		'length' => 'float',
55		'mtime' => 'int',
56		'track' => 'int',
57		'disc' => 'int',
58		];
59
60		/**
61		* Indicates if the IDs are auto-incrementing.
62		*
63		* @var bool
64		*/
65		public $incrementing = false;
66
67	6	public function artist(): BelongsTo
68		{
69	6	return $this->belongsTo(Artist::class);
70		}
71
72	12	public function album(): BelongsTo
73		{
74	12	return $this->belongsTo(Album::class);
75		}
76
77		public function playlists(): BelongsToMany
78		{
79		return $this->belongsToMany(Playlist::class);
80		}
81
82		public function interactions(): HasMany
83		{
84		return $this->hasMany(Interaction::class);
85		}
86
87		/**
88		* Update song info.
89		*
90		* @param string[] $ids
91		* @param string[] $data The data array, with these supported fields:
92		* - title
93		* - artistName
94		* - albumName
95		* - lyrics
96		* All of these are optional, in which case the info will not be changed
97		* (except for lyrics, which will be emptied).
98		*/
99	5	public static function updateInfo(array $ids, array $data): Collection
100		{
101		/*
102		* A collection of the updated songs.
103		*
104		* @var Collection
105		*/
106	5	$updatedSongs = collect();
107
108	5	$ids = (array) $ids;
109		// If we're updating only one song, take into account the title, lyrics, and track number.
110	5	$single = count($ids) === 1;
111
112	5	foreach ($ids as $id) {
113		/** @var Song $song */
114	5	$song = self::with('album', 'album.artist')->find($id);
115
116	5	if (!$song) {
117		continue;
118		}
119
120	5	$updatedSongs->push($song->updateSingle(
121	5	$single ? trim($data['title']) : $song->title,
122	5	trim($data['albumName'] ?: $song->album->name),
123	5	trim($data['artistName']) ?: $song->artist->name,
124	5	$single ? trim($data['lyrics']) : $song->lyrics,
125	5	$single ? (int) $data['track'] : $song->track,
126	5	(int) $data['compilationState']
127		));
128		}
129
130		// Our library may have been changed. Broadcast an event to tidy it up if need be.
131	5	if ($updatedSongs->count()) {
132	5	event(new LibraryChanged());
133		}
134
135	5	return $updatedSongs;
136		}
137
138	5	public function updateSingle(
139		string $title,
140		string $albumName,
141		string $artistName,
142		string $lyrics,
143		int $track,
144		int $compilationState
145		): self {
146	5	if ($artistName === Artist::VARIOUS_NAME) {
147		// If the artist name is "Various Artists", it's a compilation song no matter what.
148		$compilationState = 1;
149		// and since we can't determine the real contributing artist, it's "Unknown"
150		$artistName = Artist::UNKNOWN_NAME;
151		}
152
153	5	$artist = Artist::get($artistName);
154
155		switch ($compilationState) {
156	5	case 1: // ALL, or forcing compilation status to be Yes
157	1	$isCompilation = true;
158	1	break;
159	5	case 2: // Keep current compilation status
160	1	$isCompilation = $this->album->artist_id === Artist::VARIOUS_ID;
161	1	break;
162		default:
163	5	$isCompilation = false;
164	5	break;
165		}
166
167	5	$album = Album::get($artist, $albumName, $isCompilation);
168
169	5	$this->artist_id = $artist->id;
170	5	$this->album_id = $album->id;
171	5	$this->title = $title;
172	5	$this->lyrics = $lyrics;
173	5	$this->track = $track;
174
175	5	$this->save();
176
177		// Clean up unnecessary data from the object
178	5	unset($this->album);
179	5	unset($this->artist);
180		// and make sure the lyrics is shown
181	5	$this->makeVisible('lyrics');
182
183	5	return $this;
184		}
185
186		/**
187		* Scope a query to only include songs in a given directory.
188		*/
189	1	public function scopeInDirectory(Builder $query, string $path): Builder
190		{
191		// Make sure the path ends with a directory separator.
192	1	$path = rtrim(trim($path), DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
193
194	1	return $query->where('path', 'LIKE', "$path%");
195		}
196
197		/**
198		* Sometimes the tags extracted from getID3 are HTML entity encoded.
199		* This makes sure they are always sane.
200		*/
201	51	public function setTitleAttribute(string $value): void
202		{
203	51	$this->attributes['title'] = html_entity_decode($value);
204	51	}
205
206		/**
207		* Some songs don't have a title.
208		* Fall back to the file name (without extension) for such.
209		*/
210	15	public function getTitleAttribute(?string $value): string
211		{
212	15	return $value ?: pathinfo($this->path, PATHINFO_FILENAME);
213		}
214
215		/**
216		* Prepare the lyrics for displaying.
217		*/
218	8	public function getLyricsAttribute(string $value): string
219		{
220		// We don't use nl2br() here, because the function actually preserves line breaks -
221		// it just _appends_ a "<br />" after each of them. This would cause our client
222		// implementation of br2nl to fail with duplicated line breaks.
223	8	return str_replace(["\r\n", "\r", "\n"], '<br />', $value);
224		}
225
226		/**
227		* Get the bucket and key name of an S3 object.
228		*
229		* @return string[]\|null
230		*/
231	9	public function getS3ParamsAttribute(): ?array
232		{
233	9	if (!preg_match('/^s3:\\/\\/(.*)/', $this->path, $matches)) {
234	7	return null;
235		}
236
237	2	list($bucket, $key) = explode('/', $matches[1], 2);
238
239	2	return compact('bucket', 'key');
240		}
241
242		/**
243		* Return the ID of the song when it's converted to string.
244		*/
245	2	public function __toString()
246		{
247	2	return $this->id;
248		}
249		}
250

phanan / koel

Song::__toString() A last analyzed 2020-03-12 15:39 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Song::__toString() A
last analyzed 2020-03-12 15:39 UTC