Refactor class names to Assignment

Signed-off-by: Julius Härtl <jus@bitgrid.net>
2020-11-04 19:39:38 +01:00
parent 082b7c1983
commit 67fe250248
18 changed files with 80 additions and 77 deletions
--- a/lib/Activity/ActivityManager.php
+++ b/lib/Activity/ActivityManager.php
@@ -28,7 +28,7 @@ namespace OCA\Deck\Activity;
 use InvalidArgumentException;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AclMapper;
-use OCA\Deck\Db\AssignedUsers;
+use OCA\Deck\Db\Assignment;
 use OCA\Deck\Db\Attachment;
 use OCA\Deck\Db\AttachmentMapper;
 use OCA\Deck\Db\Board;
@@ -471,7 +471,7 @@ class ActivityManager {
 					break;
 				case Attachment::class:
 				case Label::class:
-				case AssignedUsers::class:
+				case Assignment::class:
 					$objectId = $entity->getCardId();
 					break;
 				case IComment::class:
--- a/lib/AppInfo/Application20.php
+++ b/lib/AppInfo/Application20.php
@@ -33,7 +33,7 @@ use OCA\Deck\Collaboration\Resources\ResourceProviderCard;
 use OCA\Deck\Dashboard\DeckWidget;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AclMapper;
-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Listeners\BeforeTemplateRenderedListener;
@@ -132,7 +132,7 @@ class Application20 extends App implements IBootstrap {
 				$aclMapper->delete($acl);
 			}
 			// delete existing user assignments
-			$assignmentMapper = $container->query(AssignedUsersMapper::class);
+			$assignmentMapper = $container->query(AssignmentMapper::class);
 			$assignments = $assignmentMapper->findByUserId($user->getUID());
 			foreach ($assignments as $assignment) {
 				$assignmentMapper->delete($assignment);
--- a/lib/AppInfo/ApplicationLegacy.php
+++ b/lib/AppInfo/ApplicationLegacy.php
@@ -30,7 +30,7 @@ use OCA\Deck\Collaboration\Resources\ResourceProvider;
 use OCA\Deck\Collaboration\Resources\ResourceProviderCard;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AclMapper;
-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Middleware\DefaultBoardMiddleware;
@@ -113,7 +113,7 @@ class ApplicationLegacy extends App {
 				$aclMapper->delete($acl);
 			}
 			// delete existing user assignments
-			$assignmentMapper = $container->query(AssignedUsersMapper::class);
+			$assignmentMapper = $container->query(AssignmentMapper::class);
 			$assignments = $assignmentMapper->findByUserId($user->getUID());
 			foreach ($assignments as $assignment) {
 				$assignmentMapper->delete($assignment);
--- a/lib/Command/UserExport.php
+++ b/lib/Command/UserExport.php
@@ -23,7 +23,7 @@

 namespace OCA\Deck\Command;

-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\StackMapper;
@@ -48,7 +48,7 @@ class UserExport extends Command {
 								BoardService $boardService,
 								StackMapper $stackMapper,
 								CardMapper $cardMapper,
-								AssignedUsersMapper $assignedUsersMapper,
+								AssignmentMapper $assignedUsersMapper,
 								IUserManager $userManager,
 								IGroupManager $groupManager) {
 		parent::__construct();
--- a/lib/Db/AssignedUsers.php
+++ b/lib/Db/AssignedUsers.php
@@ -25,7 +25,7 @@ namespace OCA\Deck\Db;

 use JsonSerializable;

-class AssignedUsers extends RelationalEntity implements JsonSerializable {
+class Assignment extends RelationalEntity implements JsonSerializable {
 	public $id;
 	protected $participant;
 	protected $cardId;
--- a/lib/Db/AssignedUsersMapper.php
+++ b/lib/Db/AssignedUsersMapper.php
@@ -33,7 +33,7 @@ use OCP\IDBConnection;
 use OCP\IGroupManager;
 use OCP\IUserManager;

-class AssignedUsersMapper extends QBMapper implements IPermissionMapper {
+class AssignmentMapper extends QBMapper implements IPermissionMapper {

 	/** @var CardMapper */
 	private $cardMapper;
@@ -45,7 +45,8 @@ class AssignedUsersMapper extends QBMapper implements IPermissionMapper {
 	private $circleService;

 	public function __construct(IDBConnection $db, CardMapper $cardMapper, IUserManager $userManager, IGroupManager $groupManager, CirclesService $circleService) {
-		parent::__construct($db, 'deck_assigned_users', AssignedUsers::class);
+		parent::__construct($db, 'deck_assigned_users', Assignment::class);
+
 		$this->cardMapper = $cardMapper;
 		$this->userManager = $userManager;
 		$this->groupManager = $groupManager;
@@ -63,7 +64,7 @@ class AssignedUsersMapper extends QBMapper implements IPermissionMapper {
 		$qb->select('*')
 			->from('deck_assigned_users')
 			->where($qb->expr()->eq('card_id', $qb->createNamedParameter($cardId)));
-		/** @var AssignedUsers[] $users */
+		/** @var Assignment[] $users */
 		$users = $this->findEntities($qb);
 		foreach ($users as &$user) {
 			$this->mapParticipant($user);
@@ -76,7 +77,7 @@ class AssignedUsersMapper extends QBMapper implements IPermissionMapper {
 		$qb->select('*')
 			->from('deck_assigned_users')
 			->where($qb->expr()->eq('participant', $qb->createNamedParameter($uid)));
-		/** @var AssignedUsers[] $users */
+		/** @var Assignment[] $users */
 		return $this->findEntities($qb);
 	}

@@ -94,19 +95,21 @@ class AssignedUsersMapper extends QBMapper implements IPermissionMapper {
 	 *
 	 * @param Entity $entity
 	 * @return null|Entity
+	 * @throws NotFoundException
 	 */
 	public function insert(Entity $entity): Entity {
 		$origin = $this->getOrigin($entity);
 		if ($origin === null) {
 			throw new NotFoundException('No origin found for assignment');
 		}
-		/** @var AssignedUsers $assignment */
+
+		/** @var Assignment $assignment */
 		$assignment = parent::insert($entity);
 		$this->mapParticipant($assignment);
 		return $assignment;
 	}

-	public function mapParticipant(AssignedUsers $assignment): void {
+	public function mapParticipant(Assignment $assignment): void {
 		$self = $this;
 		$assignment->resolveRelation('participant', function () use (&$self, &$assignment) {
 			return $self->getOrigin($assignment);
@@ -115,7 +118,7 @@ class AssignedUsersMapper extends QBMapper implements IPermissionMapper {

 	public function isUserAssigned($cardId, $userId): bool {
 		$assignments = $this->find($cardId);
-		/** @var AssignedUsers $assignment */
+		/** @var Assignment $assignment */
 		foreach ($assignments as $assignment) {
 			$origin = $this->getOrigin($assignment);
 			if ($origin instanceof User && $assignment->getParticipant() === $userId) {
@@ -132,12 +135,12 @@ class AssignedUsersMapper extends QBMapper implements IPermissionMapper {
 		return false;
 	}

-	private function getOrigin(AssignedUsers $assignment) {
-		if ($assignment->getType() === AssignedUsers::TYPE_USER) {
+	private function getOrigin(Assignment $assignment) {
+		if ($assignment->getType() === Assignment::TYPE_USER) {
 			$origin = $this->userManager->get($assignment->getParticipant());
 			return $origin ? new User($origin) : null;
 		}
-		if ($assignment->getType() === AssignedUsers::TYPE_GROUP) {
+		if ($assignment->getType() === Assignment::TYPE_GROUP) {
 			$origin = $this->groupManager->get($assignment->getParticipant());
 			return $origin ? new Group($origin) : null;
 		}
--- a/lib/Service/AssignmentService.php
+++ b/lib/Service/AssignmentService.php
@@ -27,8 +27,8 @@ use OCA\Deck\Activity\ActivityManager;
 use OCA\Deck\BadRequestException;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AclMapper;
-use OCA\Deck\Db\AssignedUsers;
-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\Assignment;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\ChangeHelper;
 use OCA\Deck\Event\FTSEvent;
@@ -51,7 +51,7 @@ class AssignmentService {
 	 */
 	private $cardMapper;
 	/**
-	 * @var AssignedUsersMapper
+	 * @var AssignmentMapper
 	 */
 	private $assignedUsersMapper;
 	/**
@@ -78,7 +78,7 @@ class AssignmentService {
 	public function __construct(
 		PermissionService $permissionService,
 		CardMapper $cardMapper,
-		AssignedUsersMapper $assignedUsersMapper,
+		AssignmentMapper $assignedUsersMapper,
 		AclMapper $aclMapper,
 		NotificationHelper $notificationHelper,
 		ActivityManager $activityManager,
@@ -106,7 +106,7 @@ class AssignmentService {
 	 * @throws MultipleObjectsReturnedException
 	 * @throws DoesNotExistException
 	 */
-	public function assignUser($cardId, $userId, int $type = AssignedUsers::TYPE_USER) {
+	public function assignUser($cardId, $userId, int $type = Assignment::TYPE_USER) {
 		if (is_numeric($cardId) === false) {
 			throw new BadRequestException('card id must be a number');
 		}
@@ -115,7 +115,7 @@ class AssignmentService {
 			throw new BadRequestException('user id must be provided');
 		}

-		if ($type !== AssignedUsers::TYPE_USER && $type !== AssignedUsers::TYPE_GROUP) {
+		if ($type !== Assignment::TYPE_USER && $type !== Assignment::TYPE_GROUP) {
 			throw new BadRequestException('Invalid type provided for assignemnt');
 		}

@@ -143,7 +143,7 @@ class AssignmentService {
 			$this->notificationHelper->sendCardAssigned($card, $userId);
 		}

-		$assignment = new AssignedUsers();
+		$assignment = new Assignment();
 		$assignment->setCardId($cardId);
 		$assignment->setParticipant($userId);
 		$assignment->setType($type);
--- a/lib/Service/BoardService.php
+++ b/lib/Service/BoardService.php
@@ -29,7 +29,7 @@ use OCA\Deck\Activity\ChangeSet;
 use OCA\Deck\AppInfo\Application;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AclMapper;
-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\ChangeHelper;
 use OCA\Deck\Db\IPermissionMapper;
 use OCA\Deck\Db\Label;
@@ -80,7 +80,7 @@ class BoardService {
 		AclMapper $aclMapper,
 		PermissionService $permissionService,
 		NotificationHelper $notificationHelper,
-		AssignedUsersMapper $assignedUsersMapper,
+		AssignmentMapper $assignedUsersMapper,
 		IUserManager $userManager,
 		IGroupManager $groupManager,
 		ActivityManager $activityManager,
--- a/lib/Service/CardService.php
+++ b/lib/Service/CardService.php
@@ -28,7 +28,7 @@ namespace OCA\Deck\Service;

 use OCA\Deck\Activity\ActivityManager;
 use OCA\Deck\Activity\ChangeSet;
-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\Card;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\Acl;
@@ -69,7 +69,7 @@ class CardService {
 		PermissionService $permissionService,
 		BoardService $boardService,
 		NotificationHelper $notificationHelper,
-		AssignedUsersMapper $assignedUsersMapper,
+		AssignmentMapper $assignedUsersMapper,
 		AttachmentService $attachmentService,
 		ActivityManager $activityManager,
 		ICommentsManager $commentsManager,
@@ -590,7 +590,7 @@ class CardService {
 	 */
 	public function findAllWithDue($userId) {
 		$cards = $this->cardMapper->findAllWithDue($userId);
-		
+
 		return $cards;
 	}

@@ -602,7 +602,7 @@ class CardService {
 	 */
 	public function findAssignedCards($userId) {
 		$cards = $this->cardMapper->findAssignedCards($userId);
-		
+
 		return $cards;
 	}
 }
--- a/lib/Service/OverviewService.php
+++ b/lib/Service/OverviewService.php
@@ -27,7 +27,7 @@ declare(strict_types=1);

 namespace OCA\Deck\Service;

-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\Card;
 use OCA\Deck\Db\CardMapper;
 use OCP\Comments\ICommentsManager;
@@ -45,7 +45,7 @@ class OverviewService {
 	private $labelMapper;
 	/** @var CardMapper */
 	private $cardMapper;
-	/** @var AssignedUsersMapper */
+	/** @var AssignmentMapper */
 	private $assignedUsersMapper;
 	/** @var IUserManager */
 	private $userManager;
@@ -60,7 +60,7 @@ class OverviewService {
 		BoardMapper $boardMapper,
 		LabelMapper $labelMapper,
 		CardMapper $cardMapper,
-		AssignedUsersMapper $assignedUsersMapper,
+		AssignmentMapper $assignedUsersMapper,
 		IUserManager $userManager,
 		IGroupManager $groupManager,
 		ICommentsManager $commentsManager,
--- a/lib/Service/StackService.php
+++ b/lib/Service/StackService.php
@@ -28,7 +28,7 @@ use OCA\Deck\Activity\ActivityManager;
 use OCA\Deck\Activity\ChangeSet;
 use OCA\Deck\BadRequestException;
 use OCA\Deck\Db\Acl;
-use OCA\Deck\Db\AssignedUsersMapper;
+use OCA\Deck\Db\AssignmentMapper;
 use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\ChangeHelper;
@@ -62,7 +62,7 @@ class StackService {
 		PermissionService $permissionService,
 		BoardService $boardService,
 		CardService $cardService,
-		AssignedUsersMapper $assignedUsersMapper,
+		AssignmentMapper $assignedUsersMapper,
 		AttachmentService $attachmentService,
 		ActivityManager $activityManager,
 		EventDispatcherInterface $eventDispatcher,