AssignedUsersMapper::insert() - Code Metrics - nextcloud/deck - Measure and Improve Code Quality continuously with Scrutinizer

AssignedUsersMapper::insert() A
last analyzed 2020-03-02 02:31 UTC

↳ Parent: AssignedUsersMapper

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	10
rs	9.9332
cc	2
nc	2
nop	1

<?php
/**
 * @copyright Copyright (c) 2017 Julius Härtl <[email protected]>
 *
 * @author Julius Härtl <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */


namespace OCA\Deck\Db;

use OCP\AppFramework\Db\Entity;
use OCP\IDBConnection;
use OCP\IUserManager;


class AssignedUsersMapper extends DeckMapper implements IPermissionMapper {

	private $cardMapper;
	private $userManager;

	public function __construct(IDBConnection $db, CardMapper $cardMapper, IUserManager $userManager) {
		parent::__construct($db, 'deck_assigned_users', AssignedUsers::class);

		$this->cardMapper = $cardMapper;
		$this->userManager = $userManager;
	}

	/**
	 * FIXME: rename this since it returns multiple entities otherwise the naming is confusing with Entity::find
	 *
	 * @param $cardId
	 * @return array|Entity
	 */
	public function find($cardId) {
		$sql = 'SELECT * FROM `*PREFIX*deck_assigned_users` ' .
			'WHERE `card_id` = ?';
		$users = $this->findEntities($sql, [$cardId]);

		foreach ($users as &$user) {
			$this->mapParticipant($user);
		}
		return $users;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	public function findByUserId($uid) {
		$sql = 'SELECT * FROM `*PREFIX*deck_assigned_users` ' .
			'WHERE `participant` = ?';
		return $this->findEntities($sql, [$uid]);

	}


	public function isOwner($userId, $cardId) {
		return $this->cardMapper->isOwner($userId, $cardId);
	}

	public function findBoardId($cardId) {
		return $this->cardMapper->findBoardId($cardId);
	}

	/**
	 * Check if user exists before assigning it to a card
	 *
	 * @param Entity $entity
	 * @return null|Entity
	 */
	public function insert(Entity $entity) {
		$user = $this->userManager->get($entity->getParticipant());
		if ($user !== null) {
			/** @var AssignedUsers $assignment */
			$assignment = parent::insert($entity);

			$this->mapParticipant($assignment);
			return $assignment;
		}
		return null;
	}

	public function mapParticipant(AssignedUsers &$assignment) {

		$userManager = $this->userManager;
		$assignment->resolveRelation('participant', function() use (&$userManager, &$assignment) {
			$user = $userManager->get($assignment->getParticipant());
			if ($user !== null) {
				return new User($user);
			}
			return null;
		});
	}


}

1		<?php
2		/**
3		* @copyright Copyright (c) 2017 Julius Härtl <[email protected]>
4		*
5		* @author Julius Härtl <[email protected]>
6		*
7		* @license GNU AGPL version 3 or any later version
8		*
9		* This program is free software: you can redistribute it and/or modify
10		* it under the terms of the GNU Affero General Public License as
11		* published by the Free Software Foundation, either version 3 of the
12		* License, or (at your option) any later version.
13		*
14		* This program is distributed in the hope that it will be useful,
15		* but WITHOUT ANY WARRANTY; without even the implied warranty of
16		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17		* GNU Affero General Public License for more details.
18		*
19		* You should have received a copy of the GNU Affero General Public License
20		* along with this program. If not, see <http://www.gnu.org/licenses/>.
21		*
22		*/
23
24
25		namespace OCA\Deck\Db;
26
27		use OCP\AppFramework\Db\Entity;
28		use OCP\IDBConnection;
29		use OCP\IUserManager;
30
31
32		class AssignedUsersMapper extends DeckMapper implements IPermissionMapper {
33
34		private $cardMapper;
35		private $userManager;
36
37		public function __construct(IDBConnection $db, CardMapper $cardMapper, IUserManager $userManager) {
38		parent::__construct($db, 'deck_assigned_users', AssignedUsers::class);
		0 ignored issues – show Deprecated Code introduced 2018-09-24 01:16 UTC by Report Bug Copy Issue Report The method `OCP\AppFramework\Db\Mapper::__construct()` has been deprecated with message: 14.0.0 Move over to QBMapper This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
39		$this->cardMapper = $cardMapper;
40		$this->userManager = $userManager;
41		}
42
43		/**
44		* FIXME: rename this since it returns multiple entities otherwise the naming is confusing with Entity::find
45		*
46		* @param $cardId
47		* @return array\|Entity
48		*/
49		public function find($cardId) {
50		$sql = 'SELECT * FROM `PREFIXdeck_assigned_users` ' .
51		'WHERE `card_id` = ?';
52		$users = $this->findEntities($sql, [$cardId]);
		0 ignored issues – show Deprecated Code introduced 2018-09-24 01:16 UTC by Report Bug Copy Issue Report The method `OCP\AppFramework\Db\Mapper::findEntities()` has been deprecated with message: 14.0.0 Move over to QBMapper This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
53		foreach ($users as &$user) {
54		$this->mapParticipant($user);
55		}
56		return $users;
		0 ignored issues – show Bug Best Practice introduced 2018-03-02 16:59 UTC by Report Bug Copy Issue Report The return type of `return $users;` (`array`) is incompatible with the return type of the parent method `OCA\Deck\Db\DeckMapper::find` of type `OCP\AppFramework\Db\Entity`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
57		}
58
59		public function findByUserId($uid) {
60		$sql = 'SELECT * FROM `PREFIXdeck_assigned_users` ' .
61		'WHERE `participant` = ?';
62		return $this->findEntities($sql, [$uid]);
		0 ignored issues – show Deprecated Code introduced 2018-09-24 01:16 UTC by Report Bug Copy Issue Report The method `OCP\AppFramework\Db\Mapper::findEntities()` has been deprecated with message: 14.0.0 Move over to QBMapper This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
63		}
64
65
66		public function isOwner($userId, $cardId) {
67		return $this->cardMapper->isOwner($userId, $cardId);
68		}
69
70		public function findBoardId($cardId) {
71		return $this->cardMapper->findBoardId($cardId);
72		}
73
74		/**
75		* Check if user exists before assigning it to a card
76		*
77		* @param Entity $entity
78		* @return null\|Entity
79		*/
80		public function insert(Entity $entity) {
81		$user = $this->userManager->get($entity->getParticipant());
82		if ($user !== null) {
83		/** @var AssignedUsers $assignment */
84		$assignment = parent::insert($entity);
		0 ignored issues – show Deprecated Code introduced 2018-09-24 01:16 UTC by Report Bug Copy Issue Report The method `OCP\AppFramework\Db\Mapper::insert()` has been deprecated with message: 14.0.0 Move over to QBMapper This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
85		$this->mapParticipant($assignment);
86		return $assignment;
87		}
88		return null;
89		}
90
91	View Code Duplication	public function mapParticipant(AssignedUsers &$assignment) {
		0 ignored issues – show Duplication introduced 2017-10-01 14:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92		$userManager = $this->userManager;
93		$assignment->resolveRelation('participant', function() use (&$userManager, &$assignment) {
94		$user = $userManager->get($assignment->getParticipant());
95		if ($user !== null) {
96		return new User($user);
97		}
98		return null;
99		});
100		}
101
102
103		}

nextcloud / deck

AssignedUsersMapper::insert() A last analyzed 2020-03-02 02:31 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AssignedUsersMapper::insert() A
last analyzed 2020-03-02 02:31 UTC