UserMusicFolder::setPath() - Code Metrics - Inspection of "Subsonic: Refactor and improve error handling" - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/329_Subsonic_API ( a9dee6...9d1353 )

by Pauli

created 2019-09-21 16:44 UTC

UserMusicFolder::setPath() A

↳ Parent: UserMusicFolder

Complexity

Conditions	4
Paths	5

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	11
nc	5
nop	2
dl	0
loc	17
rs	9.9
c	1
b	0
f	0

<?php

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Pauli Järvinen <[email protected]>
 * @copyright Pauli Järvinen 2019
 */

namespace OCA\Music\Utility;

use \OCP\Files\Folder;
filter:
    dependency_paths: ["lib/*"]
use \OCP\Files\IRootFolder;
filter:
    dependency_paths: ["lib/*"]
use \OCP\IConfig;
filter:
    dependency_paths: ["lib/*"]

use \OCA\Music\AppFramework\Core\Logger;

/**
 * Manage the user-specific music folder setting
 */
class UserMusicFolder {

	private $appName;
	private $configManager;
	private $rootFolder;
	private $logger;

	public function __construct(
			$appName,
			IConfig $configManager,
			IRootFolder $rootFolder,
			Logger $logger) {
		$this->appName = $appName;
		$this->configManager = $configManager;
		$this->rootFolder = $rootFolder;
		$this->logger = $logger;
	}

	/**
	 * @param string $userId
	 * @param string $path
	 */
	public function setPath($userId, $path) {
		$success = false;

		$userHome = $this->rootFolder->getUserFolder($userId);
		$element = $userHome->get($path);
		if ($element instanceof \OCP\Files\Folder) {
			if ($path[0] !== '/') {
				$path = '/' . $path;
			}
			if ($path[\strlen($path)-1] !== '/') {
				$path .= '/';
			}
			$this->configManager->setUserValue($userId, $this->appName, 'path', $path);
			$success = true;
		}

		return $success;
	}

	/**
	 * @param string $userId
	 * @return string
	 */
	public function getPath($userId) {
		$path = $this->configManager->getUserValue($userId, $this->appName, 'path');
		return $path ?: '/';
	}

	/**
	 * @param string $userId
	 * @return Folder
	 */
	public function getFolder($userId) {
		$userHome = $this->rootFolder->getUserFolder($userId);
		$path = $this->getPath($userId);
		return Util::getFolderFromRelativePath($userHome, $path);
	}
}


1			<?php
2
3			/**
4			* ownCloud - Music app
5			*
6			* This file is licensed under the Affero General Public License version 3 or
7			* later. See the COPYING file.
8			*
9			* @author Pauli Järvinen <[email protected]>
10			* @copyright Pauli Järvinen 2019
11			*/
12
13			namespace OCA\Music\Utility;
14
15			use \OCP\Files\Folder;
			0 ignored issues – show Bug introduced 2019-09-21 16:59 UTC by Report Bug Copy Issue Report The type `OCP\Files\Folder` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use \OCP\Files\IRootFolder;
			0 ignored issues – show Bug introduced 2019-05-09 18:18 UTC by Report Bug Copy Issue Report The type `OCP\Files\IRootFolder` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17			use \OCP\IConfig;
			0 ignored issues – show Bug introduced 2019-05-09 18:18 UTC by Report Bug Copy Issue Report The type `OCP\IConfig` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18
19			use \OCA\Music\AppFramework\Core\Logger;
20
21			/**
22			* Manage the user-specific music folder setting
23			*/
24			class UserMusicFolder {
25
26			private $appName;
27			private $configManager;
28			private $rootFolder;
29			private $logger;
30
31			public function __construct(
32			$appName,
33			IConfig $configManager,
34			IRootFolder $rootFolder,
35			Logger $logger) {
36			$this->appName = $appName;
37			$this->configManager = $configManager;
38			$this->rootFolder = $rootFolder;
39			$this->logger = $logger;
40			}
41
42			/**
43			* @param string $userId
44			* @param string $path
45			*/
46			public function setPath($userId, $path) {
47			$success = false;
48
49			$userHome = $this->rootFolder->getUserFolder($userId);
50			$element = $userHome->get($path);
51			if ($element instanceof \OCP\Files\Folder) {
52			if ($path[0] !== '/') {
53			$path = '/' . $path;
54			}
55			if ($path[\strlen($path)-1] !== '/') {
56			$path .= '/';
57			}
58			$this->configManager->setUserValue($userId, $this->appName, 'path', $path);
59			$success = true;
60			}
61
62			return $success;
63			}
64
65			/**
66			* @param string $userId
67			* @return string
68			*/
69			public function getPath($userId) {
70			$path = $this->configManager->getUserValue($userId, $this->appName, 'path');
71			return $path ?: '/';
72			}
73
74			/**
75			* @param string $userId
76			* @return Folder
77			*/
78			public function getFolder($userId) {
79			$userHome = $this->rootFolder->getUserFolder($userId);
80			$path = $this->getPath($userId);
81			return Util::getFolderFromRelativePath($userHome, $path);
82			}
83			}
84

owncloud / music

Push — feature/329_Subsonic_API ( a9dee6...9d1353 )

UserMusicFolder::setPath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like