OCA\Music\Db\Artist

Complexity

Total Complexity

12

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

26.32%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getNameString()	0	10	3
A	toCollection()	0	5	1
A	coverToAPI()	0	7	2
A	__construct()	0	2	1
A	toAPI()	0	7	1
A	getIndexingChar()	0	14	3
A	getUri()	0	4	1

<?php

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Pauli Järvinen <pauli.jarvinen@gmail.com>
 * @copyright Morris Jobke 2013, 2014
 * @copyright Pauli Järvinen 2017 - 2020
 */

namespace OCA\Music\Db;

use OCP\IL10N;

The type OCP\IL10N was not found. Maybe you did not declare it correctly or list all dependencies?

use \OCP\IURLGenerator;

The type OCP\IURLGenerator was not found. Maybe you did not declare it correctly or list all dependencies?

use \OCP\AppFramework\Db\Entity;

The type OCP\AppFramework\Db\Entity was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * @method string getName()
 * @method void setName(string $name)
 * @method int getCoverFileId()
 * @method void setCoverFileId(int $coverFileId)
 * @method string getUserId()
 * @method void setUserId(string $userId)
 * @method string getMbid()
 * @method void setMbid(string $mbid)
 * @method string getHash()
 * @method void setHash(string $hash)
 * @method string getStarred()
 * @method void setStarred(string $timestamp)
 */
class Artist extends Entity {
	public $name;
	public $coverFileId;
	public $userId;
	public $mbid;
	public $hash;
	public $starred;

	public function __construct() {
		$this->addType('coverFileId', 'int');
	}

	public function getUri(IURLGenerator $urlGenerator) {
		return $urlGenerator->linkToRoute(
			'music.api.artist',
			['artistIdOrSlug' => $this->id]
		);
	}

	public function getNameString(IL10N $l10n) {
		$name = $this->getName();
		if ($name === null) {

The condition $name === null is always false.

			$name = $l10n->t('Unknown artist');
			if (!\is_string($name)) {
				/** @var \OC_L10N_String $name */
				$name = $name->__toString();
			}
		}
		return $name;
	}

	/**
	 * Get initial character of the artist name in upper case.
	 * This is intended to be used as index in a list of aritsts.
	 */
	public function getIndexingChar() {
		// For unknown artists, use '?'
		$char = '?';
		$name = $this->getName();

		if (!empty($name)) {
			$char = \mb_convert_case(\mb_substr($name, 0, 1), MB_CASE_UPPER);
		}
		// Bundle all numeric characters together
		if (\is_numeric($char)) {
			$char = '#';
		}

		return $char;
	}

	/**
	 * Return the cover URL to be used in the Shiva API
	 * @param IURLGenerator $urlGenerator
	 * @return string|null
	 */
	public function coverToAPI(IURLGenerator $urlGenerator) {
		$coverUrl = null;
		if ($this->getCoverFileId() > 0) {
			$coverUrl = $urlGenerator->linkToRoute('music.api.artistCover',
					['artistIdOrSlug' => $this->getId()]);
		}
		return $coverUrl;
	}

	/**
	 * @param IL10N $l10n
	 * @param array $albums in the "toCollection" format
	 * @return array
	 */
	public function toCollection(IL10N $l10n, $albums) {
		return [
			'id' => $this->getId(),
			'name' => $this->getNameString($l10n),
			'albums' => $albums
		];
	}

	public function toAPI(IURLGenerator $urlGenerator, $l10n) {
		return [
			'id' => $this->getId(),
			'name' => $this->getNameString($l10n),
			'image' => $this->coverToAPI($urlGenerator),
			'slug' => $this->getId() . '-' . $this->slugify('name'),
			'uri' => $this->getUri($urlGenerator)
		];
	}
}