Torrent::needsMetaData() - Code Metrics - Inspection of "Update usage and changelog." - irazasyed/php-transmission-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( bd10da...d5e00b )

by Irfaq

created 2018-08-01 01:08 UTC

Torrent::needsMetaData() A

↳ Parent: Torrent

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Transmission\Models;

use Transmission\Client;

/**
 * Torrent
 *
 * @method mixed getUploadRatio(bool $castingEnabled = false) Get Upload Ratio Value.
 * @method mixed getLeftUntilDone(bool $castingEnabled = false) Get Left Until Done Value.
 * @method mixed getHaveValid(bool $castingEnabled = false) Get Have Valid Value.
 * @method mixed getHaveUnchecked(bool $castingEnabled = false) Get Have Unchecked Value.
 */
class Torrent extends AbstractModel
{
    /**
     * Statuses.
     *
     * Field: status
     */
    const STATUS_STOPPED = 0;
    const STATUS_CHECK_WAIT = 1;
    const STATUS_CHECK = 2;
    const STATUS_DOWNLOAD_WAIT = 3;
    const STATUS_DOWNLOAD = 4;
    const STATUS_SEED_WAIT = 5;
    const STATUS_SEED = 6;
    const STATUS_ISOLATED = 7;

    /**
     * Seed Ratio Modes.
     *
     * Field: seedRatioMode
     */
    const RATIO_USE_GLOBAL = 0;
    const RATIO_USE_LOCAL = 1;
    const RATIO_UNLIMITED = 2;

    /**
     * Errors.
     *
     * Field: error
     */
    const ERROR_NONE = 0;
    const ERROR_TRACKER_WARNING = 1;
    const ERROR_TRACKER_ERROR = 2;
    const ERROR_LOCAL_ERROR = 3;

    /**
     * Tracker Stats.
     *
     * Field: trackerStats->announceState
     */
    const TRACKER_INACTIVE = 0;
    const TRACKER_WAITING = 1;
    const TRACKER_QUEUED = 2;
    const TRACKER_ACTIVE = 3;

    /**
     * Common Fields.
     *
     * @var array
     */
    public static $fields = [
        'default'    => [
            'id',
            'eta',
            'name',
            'status',
            'isFinished',
            'files',
            'hashString',
            'downloadDir',
            'percentDone',
            'haveValid',
            'haveUnchecked',
            'totalSize',
            'leftUntilDone',
            'addedDate',
            'doneDate',
            'activityDate',
        ],
        'stats'      => [
            'error',
            'errorString',
            'eta',
            'isFinished',
            'isStalled',
            'leftUntilDone',
            'metadataPercentComplete',
            'peersConnected',
            'peersGettingFromUs',
            'peersSendingToUs',
            'percentDone',
            'queuePosition',
            'rateDownload',
            'rateUpload',
            'recheckProgress',
            'seedRatioMode',
            'seedRatioLimit',
            'sizeWhenDone',
            'status',
            'trackers',
            'downloadDir',
            'uploadedEver',
            'uploadRatio',
            'webseedsSendingToUs',
        ],
        'statsExtra' => [
            'activityDate',
            'corruptEver',
            'desiredAvailable',
            'downloadedEver',
            'fileStats',
            'haveUnchecked',
            'haveValid',
            'peers',
            'startDate',
            'trackerStats',
        ],
        'infoExtra'  => [
            'comment',
            'creator',
            'dateCreated',
            'files',
            'hashString',
            'isPrivate',
            'pieceCount',
            'pieceSize',
        ],
    ];

    /**
     * The attributes that should be cast to native and other supported types.
     *
     * Casts only when formatting is enabled.
     *
     * @var array
     */
    protected $casts = [
        'doneDate'      => 'datetime',
        'startDate'     => 'datetime',
        'activityDate'  => 'datetime',
        'addedDate'     => 'datetime',
        'dateCreated'   => 'datetime',
        'eta'           => 'interval',
        'haveValid'     => 'size',
        'haveUnchecked' => 'size',
        'totalDone'     => 'size', // Custom
        'leftUntilDone' => 'size',
        'totalSize'     => 'size',
        'sizeWhenDone'  => 'size',
        'uploadedEver'  => 'size',
        'rateDownload'  => 'datarate',
        'rateUpload'    => 'datarate',
    ];

    /**
     * Get Name.
     *
     * @return mixed
     */
    public function getName()
    {
        return $this->get('name', 'Unknown');
    }

    /**
     * Get Percent Done.
     *
     * @param bool $format
     *
     * @return int
     */
    public function getPercentDone($format = false): int
    {
        $percentDone = $this->get('percentDone', 0);

        return $format ? $percentDone * 100 : $percentDone;
    }

    /**
     * Get Percent Done String.
     *
     * @return string
     */
    public function getPercentDoneString(): string
    {
        return $this->getPercentDone(true) . '%';
    }

    /**
     * Get Metadata Percent Complete.
     *
     * @param bool $format
     *
     * @return int
     */
    public function getMetadataPercentComplete($format = false): int
    {
        $percent = $this->get('metadataPercentComplete', 0);

        return $format ? $percent * 100 : $percent;
    }

    /**
     * Get Recheck Progress Percent.
     *
     * @param bool $format
     *
     * @return int
     */
    public function getRecheckProgress($format = false): int
    {
        $percent = $this->get('recheckProgress', 0);

        return $format ? $percent * 100 : $percent;
    }

    /**
     * Get Total Done.
     *
     * @param null|bool $castingEnabled
     *
     * @return mixed
     */
    public function getTotalDone($castingEnabled = null)
    {
        $value = $this->getHaveValid(false) + $this->getHaveUnchecked(false);

        return $this->castAttribute('totalDone', $value, $castingEnabled ?? $this->castingEnabled);
    }

    /**
     * Get Upload Speed.
     *
     * @param null|bool $castingEnabled
     *
     * @return mixed
     */
    public function getUploadSpeed($castingEnabled = null)
    {
        return $this->get('rateUpload', 0, $castingEnabled);
    }

    /**
     * Get Download Speed.
     *
     * @param null|bool $castingEnabled
     *
     * @return mixed
     */
    public function getDownloadSpeed($castingEnabled = null)
    {
        return $this->get('rateDownload', 0, $castingEnabled);
    }

    /**
     * Get File Count.
     *
     * @return mixed
     */
    public function getFileCount()
    {
        return count($this->get('files', 0));
    }

    /**
     * Get a File by ID.
     *
     * @param int $id
     *
     * @return mixed
     */
    public function getFile(int $id)
    {
        return data_get($this->items, "files.$id");
    }

    /**
     * Check if status is stopped.
     *
     * @return bool
     */
    public function isStopped(): bool
    {
        return $this->isStatus(static::STATUS_STOPPED);
    }

    /**
     * Check if status is checking.
     *
     * @return bool
     */
    public function isChecking(): bool
    {
        return $this->isStatus(static::STATUS_CHECK);
    }

    /**
     * Check if status is downloading.
     *
     * @return bool
     */
    public function isDownloading(): bool
    {
        return $this->isStatus(static::STATUS_DOWNLOAD);
    }

    /**
     * Check if status is queued.
     *
     * @return bool
     */
    public function isQueued(): bool
    {
        return $this->isStatus(static::STATUS_DOWNLOAD_WAIT) || $this->isStatus(static::STATUS_SEED_WAIT);
    }

    /**
     * Check if status is seeding.
     *
     * @return bool
     */
    public function isSeeding(): bool
    {
        return $this->isStatus(static::STATUS_SEED);
    }

    /**
     * Check if done downloading.
     *
     * @return bool
     */
    public function isDone(): bool
    {
        return $this->getLeftUntilDone(false) < 1;
    }

    /**
     * Check if given status matches the current status.
     *
     * @param $status
     *
     * @return bool
     */
    public function isStatus($status): bool
    {
        return $this->get('status') === $status;
    }

    /**
     * Check if meta data needs to be complete.
     *
     * @return bool
     */
    public function needsMetaData(): bool
    {
        return $this->getMetadataPercentComplete() < 1;
    }

    /**
     * Get Status String.
     *
     * @return string
     */
    public function getStatusString()
    {
        switch ($this->get('status')) {
            case static::STATUS_STOPPED:
                return $this->get('isFinished', false) ? 'Seeding complete' : 'Paused';
            case static::STATUS_CHECK_WAIT:
                return 'Queued for verification';
            case static::STATUS_CHECK:
                return 'Verifying local data';
            case static::STATUS_DOWNLOAD_WAIT:
                return 'Queued for download';
            case static::STATUS_DOWNLOAD:
                return 'Downloading';
            case static::STATUS_SEED_WAIT:
                return 'Queued for seeding';
            case static::STATUS_SEED:
                return 'Seeding';
            case null:
                return 'Unknown';
            default:
                return 'Error';

        }
    }

    /**
     * Get Seed Ratio Limit.
     *
     * @param int|Client $globalSeedRatioLimit Provide the global seed ratio limit if you already have cached. This is
     *                                         to prevent fetching on every request when looping through multiple
     *                                         torrents as it'll be very slow doing so. It's recommended to cache it
     *                                         once and pass to this method, otherwise provide Client instance.
     *
     * @return int|string
     */
    public function seedRatioLimit($globalSeedRatioLimit)
    {
        switch ($this->get('seedRatioMode')) {
            case static::RATIO_USE_GLOBAL:
                return ($globalSeedRatioLimit instanceof Client) ? $globalSeedRatioLimit->seedRatioLimit() : $globalSeedRatioLimit;
            case static::RATIO_USE_LOCAL:
                return $this->get('seedRatioLimit');
            default:
                return -1;
        }
    }

    /**
     * Get Error Message.
     *
     * @return null|string
     */
    public function getErrorMessage()
    {
        $str = $this->get('errorString');
        switch ($this->get('error')) {
            case static::ERROR_TRACKER_WARNING:
                return 'Tracker returned a warning: ' . $str;
            case static::ERROR_TRACKER_ERROR:
                return 'Tracker returned an error: ' . $str;
            case static::ERROR_LOCAL_ERROR:
                return 'Error: ' . $str;
            default:
                return null;
        }
    }
}

1			<?php
2
3			namespace Transmission\Models;
4
5			use Transmission\Client;
6
7			/**
8			* Torrent
9			*
10			* @method mixed getUploadRatio(bool $castingEnabled = false) Get Upload Ratio Value.
11			* @method mixed getLeftUntilDone(bool $castingEnabled = false) Get Left Until Done Value.
12			* @method mixed getHaveValid(bool $castingEnabled = false) Get Have Valid Value.
13			* @method mixed getHaveUnchecked(bool $castingEnabled = false) Get Have Unchecked Value.
14			*/
15			class Torrent extends AbstractModel
16			{
17			/**
18			* Statuses.
19			*
20			* Field: status
21			*/
22			const STATUS_STOPPED = 0;
23			const STATUS_CHECK_WAIT = 1;
24			const STATUS_CHECK = 2;
25			const STATUS_DOWNLOAD_WAIT = 3;
26			const STATUS_DOWNLOAD = 4;
27			const STATUS_SEED_WAIT = 5;
28			const STATUS_SEED = 6;
29			const STATUS_ISOLATED = 7;
30
31			/**
32			* Seed Ratio Modes.
33			*
34			* Field: seedRatioMode
35			*/
36			const RATIO_USE_GLOBAL = 0;
37			const RATIO_USE_LOCAL = 1;
38			const RATIO_UNLIMITED = 2;
39
40			/**
41			* Errors.
42			*
43			* Field: error
44			*/
45			const ERROR_NONE = 0;
46			const ERROR_TRACKER_WARNING = 1;
47			const ERROR_TRACKER_ERROR = 2;
48			const ERROR_LOCAL_ERROR = 3;
49
50			/**
51			* Tracker Stats.
52			*
53			* Field: trackerStats->announceState
54			*/
55			const TRACKER_INACTIVE = 0;
56			const TRACKER_WAITING = 1;
57			const TRACKER_QUEUED = 2;
58			const TRACKER_ACTIVE = 3;
59
60			/**
61			* Common Fields.
62			*
63			* @var array
64			*/
65			public static $fields = [
66			'default' => [
67			'id',
68			'eta',
69			'name',
70			'status',
71			'isFinished',
72			'files',
73			'hashString',
74			'downloadDir',
75			'percentDone',
76			'haveValid',
77			'haveUnchecked',
78			'totalSize',
79			'leftUntilDone',
80			'addedDate',
81			'doneDate',
82			'activityDate',
83			],
84			'stats' => [
85			'error',
86			'errorString',
87			'eta',
88			'isFinished',
89			'isStalled',
90			'leftUntilDone',
91			'metadataPercentComplete',
92			'peersConnected',
93			'peersGettingFromUs',
94			'peersSendingToUs',
95			'percentDone',
96			'queuePosition',
97			'rateDownload',
98			'rateUpload',
99			'recheckProgress',
100			'seedRatioMode',
101			'seedRatioLimit',
102			'sizeWhenDone',
103			'status',
104			'trackers',
105			'downloadDir',
106			'uploadedEver',
107			'uploadRatio',
108			'webseedsSendingToUs',
109			],
110			'statsExtra' => [
111			'activityDate',
112			'corruptEver',
113			'desiredAvailable',
114			'downloadedEver',
115			'fileStats',
116			'haveUnchecked',
117			'haveValid',
118			'peers',
119			'startDate',
120			'trackerStats',
121			],
122			'infoExtra' => [
123			'comment',
124			'creator',
125			'dateCreated',
126			'files',
127			'hashString',
128			'isPrivate',
129			'pieceCount',
130			'pieceSize',
131			],
132			];
133
134			/**
135			* The attributes that should be cast to native and other supported types.
136			*
137			* Casts only when formatting is enabled.
138			*
139			* @var array
140			*/
141			protected $casts = [
142			'doneDate' => 'datetime',
143			'startDate' => 'datetime',
144			'activityDate' => 'datetime',
145			'addedDate' => 'datetime',
146			'dateCreated' => 'datetime',
147			'eta' => 'interval',
148			'haveValid' => 'size',
149			'haveUnchecked' => 'size',
150			'totalDone' => 'size', // Custom
151			'leftUntilDone' => 'size',
152			'totalSize' => 'size',
153			'sizeWhenDone' => 'size',
154			'uploadedEver' => 'size',
155			'rateDownload' => 'datarate',
156			'rateUpload' => 'datarate',
157			];
158
159			/**
160			* Get Name.
161			*
162			* @return mixed
163			*/
164			public function getName()
165			{
166			return $this->get('name', 'Unknown');
167			}
168
169			/**
170			* Get Percent Done.
171			*
172			* @param bool $format
173			*
174			* @return int
175			*/
176			public function getPercentDone($format = false): int
177			{
178			$percentDone = $this->get('percentDone', 0);
179
180			return $format ? $percentDone * 100 : $percentDone;
181			}
182
183			/**
184			* Get Percent Done String.
185			*
186			* @return string
187			*/
188			public function getPercentDoneString(): string
189			{
190			return $this->getPercentDone(true) . '%';
191			}
192
193			/**
194			* Get Metadata Percent Complete.
195			*
196			* @param bool $format
197			*
198			* @return int
199			*/
200			public function getMetadataPercentComplete($format = false): int
201			{
202			$percent = $this->get('metadataPercentComplete', 0);
203
204			return $format ? $percent * 100 : $percent;
205			}
206
207			/**
208			* Get Recheck Progress Percent.
209			*
210			* @param bool $format
211			*
212			* @return int
213			*/
214			public function getRecheckProgress($format = false): int
215			{
216			$percent = $this->get('recheckProgress', 0);
217
218			return $format ? $percent * 100 : $percent;
219			}
220
221			/**
222			* Get Total Done.
223			*
224			* @param null\|bool $castingEnabled
225			*
226			* @return mixed
227			*/
228			public function getTotalDone($castingEnabled = null)
229			{
230			$value = $this->getHaveValid(false) + $this->getHaveUnchecked(false);
231
232			return $this->castAttribute('totalDone', $value, $castingEnabled ?? $this->castingEnabled);
233			}
234
235			/**
236			* Get Upload Speed.
237			*
238			* @param null\|bool $castingEnabled
239			*
240			* @return mixed
241			*/
242			public function getUploadSpeed($castingEnabled = null)
243			{
244			return $this->get('rateUpload', 0, $castingEnabled);
245			}
246
247			/**
248			* Get Download Speed.
249			*
250			* @param null\|bool $castingEnabled
251			*
252			* @return mixed
253			*/
254			public function getDownloadSpeed($castingEnabled = null)
255			{
256			return $this->get('rateDownload', 0, $castingEnabled);
257			}
258
259			/**
260			* Get File Count.
261			*
262			* @return mixed
263			*/
264			public function getFileCount()
265			{
266			return count($this->get('files', 0));
267			}
268
269			/**
270			* Get a File by ID.
271			*
272			* @param int $id
273			*
274			* @return mixed
275			*/
276			public function getFile(int $id)
277			{
278			return data_get($this->items, "files.$id");
279			}
280
281			/**
282			* Check if status is stopped.
283			*
284			* @return bool
285			*/
286			public function isStopped(): bool
287			{
288			return $this->isStatus(static::STATUS_STOPPED);
289			}
290
291			/**
292			* Check if status is checking.
293			*
294			* @return bool
295			*/
296			public function isChecking(): bool
297			{
298			return $this->isStatus(static::STATUS_CHECK);
299			}
300
301			/**
302			* Check if status is downloading.
303			*
304			* @return bool
305			*/
306			public function isDownloading(): bool
307			{
308			return $this->isStatus(static::STATUS_DOWNLOAD);
309			}
310
311			/**
312			* Check if status is queued.
313			*
314			* @return bool
315			*/
316			public function isQueued(): bool
317			{
318			return $this->isStatus(static::STATUS_DOWNLOAD_WAIT) \|\| $this->isStatus(static::STATUS_SEED_WAIT);
319			}
320
321			/**
322			* Check if status is seeding.
323			*
324			* @return bool
325			*/
326			public function isSeeding(): bool
327			{
328			return $this->isStatus(static::STATUS_SEED);
329			}
330
331			/**
332			* Check if done downloading.
333			*
334			* @return bool
335			*/
336			public function isDone(): bool
337			{
338			return $this->getLeftUntilDone(false) < 1;
339			}
340
341			/**
342			* Check if given status matches the current status.
343			*
344			* @param $status
345			*
346			* @return bool
347			*/
348			public function isStatus($status): bool
349			{
350			return $this->get('status') === $status;
351			}
352
353			/**
354			* Check if meta data needs to be complete.
355			*
356			* @return bool
357			*/
358			public function needsMetaData(): bool
359			{
360			return $this->getMetadataPercentComplete() < 1;
361			}
362
363			/**
364			* Get Status String.
365			*
366			* @return string
367			*/
368			public function getStatusString()
369			{
370			switch ($this->get('status')) {
371			case static::STATUS_STOPPED:
372			return $this->get('isFinished', false) ? 'Seeding complete' : 'Paused';
373			case static::STATUS_CHECK_WAIT:
374			return 'Queued for verification';
375			case static::STATUS_CHECK:
376			return 'Verifying local data';
377			case static::STATUS_DOWNLOAD_WAIT:
378			return 'Queued for download';
379			case static::STATUS_DOWNLOAD:
380			return 'Downloading';
381			case static::STATUS_SEED_WAIT:
382			return 'Queued for seeding';
383			case static::STATUS_SEED:
384			return 'Seeding';
385			case null:
386			return 'Unknown';
387			default:
388			return 'Error';
389
390			}
391			}
392
393			/**
394			* Get Seed Ratio Limit.
395			*
396			* @param int\|Client $globalSeedRatioLimit Provide the global seed ratio limit if you already have cached. This is
397			* to prevent fetching on every request when looping through multiple
398			* torrents as it'll be very slow doing so. It's recommended to cache it
399			* once and pass to this method, otherwise provide Client instance.
400			*
401			* @return int\|string
402			*/
403			public function seedRatioLimit($globalSeedRatioLimit)
404			{
405			switch ($this->get('seedRatioMode')) {
406			case static::RATIO_USE_GLOBAL:
407			return ($globalSeedRatioLimit instanceof Client) ? $globalSeedRatioLimit->seedRatioLimit() : $globalSeedRatioLimit;
408			case static::RATIO_USE_LOCAL:
409			return $this->get('seedRatioLimit');
410			default:
411			return -1;
412			}
413			}
414
415			/**
416			* Get Error Message.
417			*
418			* @return null\|string
419			*/
420			public function getErrorMessage()
421			{
422			$str = $this->get('errorString');
423			switch ($this->get('error')) {
424			case static::ERROR_TRACKER_WARNING:
425			return 'Tracker returned a warning: ' . $str;
426			case static::ERROR_TRACKER_ERROR:
427			return 'Tracker returned an error: ' . $str;
428			case static::ERROR_LOCAL_ERROR:
429			return 'Error: ' . $str;
430			default:
431			return null;
432			}
433			}
434			}

irazasyed / php-transmission-sdk

Push — master ( bd10da...d5e00b )

Torrent::needsMetaData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like