Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
92.59% |
25 / 27 |
|
80.00% |
4 / 5 |
CRAP | |
0.00% |
0 / 1 |
| InstanceMover | |
92.59% |
25 / 27 |
|
80.00% |
4 / 5 |
14.08 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |||
| withPermissionCopier | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| withPermissionCopiers | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
6 | |||
| transfer | |
100.00% |
10 / 10 |
|
100.00% |
1 / 1 |
4 | |||
| assertInSameRootClass | |
100.00% |
12 / 12 |
|
100.00% |
1 / 1 |
6 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2023 (original work) Open Assessment Technologies SA. |
| 19 | */ |
| 20 | |
| 21 | declare(strict_types=1); |
| 22 | |
| 23 | namespace oat\tao\model\resources\Service; |
| 24 | |
| 25 | use core_kernel_classes_Class; |
| 26 | use core_kernel_classes_Resource; |
| 27 | use InvalidArgumentException; |
| 28 | use oat\generis\model\data\Ontology; |
| 29 | use oat\tao\model\resources\Command\ResourceTransferCommand; |
| 30 | use oat\tao\model\resources\Contract\PermissionCopierInterface; |
| 31 | use oat\tao\model\resources\Contract\ResourceTransferInterface; |
| 32 | use oat\tao\model\resources\Contract\RootClassesListServiceInterface; |
| 33 | use oat\tao\model\resources\ResourceTransferResult; |
| 34 | |
| 35 | class InstanceMover implements ResourceTransferInterface |
| 36 | { |
| 37 | private Ontology $ontology; |
| 38 | private RootClassesListServiceInterface $rootClassesListService; |
| 39 | private PermissionCopierInterface $permissionCopier; |
| 40 | |
| 41 | public function __construct(Ontology $ontology, RootClassesListServiceInterface $rootClassesListService) |
| 42 | { |
| 43 | $this->ontology = $ontology; |
| 44 | $this->rootClassesListService = $rootClassesListService; |
| 45 | } |
| 46 | |
| 47 | public function withPermissionCopier(PermissionCopierInterface $permissionCopier): void |
| 48 | { |
| 49 | $this->permissionCopier = $permissionCopier; |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * This method is to be used with tagged_iterator() from service providers |
| 54 | * (but only the last copier from the iterable is effectively applied). |
| 55 | */ |
| 56 | public function withPermissionCopiers(iterable $permissionCopiers): void |
| 57 | { |
| 58 | foreach ($permissionCopiers as $copier) { |
| 59 | $this->withPermissionCopier($copier); |
| 60 | } |
| 61 | } |
| 62 | |
| 63 | public function transfer(ResourceTransferCommand $command): ResourceTransferResult |
| 64 | { |
| 65 | $from = $this->ontology->getResource($command->getFrom()); |
| 66 | $to = $this->ontology->getClass($command->getTo()); |
| 67 | |
| 68 | $fromClasses = $from->getTypes(); |
| 69 | |
| 70 | $this->assertInSameRootClass($from, current($fromClasses), $to); |
| 71 | |
| 72 | foreach ($fromClasses as $fromClass) { |
| 73 | $from->removeType($fromClass); |
| 74 | } |
| 75 | |
| 76 | $from->setType($to); |
| 77 | |
| 78 | if (isset($this->permissionCopier) && $command->useDestinationAcl()) { |
| 79 | $this->permissionCopier->copy($to, $from); |
| 80 | } |
| 81 | |
| 82 | return new ResourceTransferResult($from->getUri()); |
| 83 | } |
| 84 | |
| 85 | private function assertInSameRootClass( |
| 86 | core_kernel_classes_Resource $fromInstance, |
| 87 | core_kernel_classes_Class $fromClass, |
| 88 | core_kernel_classes_Class $toClass |
| 89 | ): void { |
| 90 | foreach ($this->rootClassesListService->list() as $rootClass) { |
| 91 | if ( |
| 92 | ($fromClass->equals($rootClass) || $fromClass->isSubClassOf($rootClass)) |
| 93 | && !$toClass->equals($rootClass) |
| 94 | && !$toClass->isSubClassOf($rootClass) |
| 95 | ) { |
| 96 | throw new InvalidArgumentException( |
| 97 | sprintf( |
| 98 | 'Selected instance (%s) and destination class (%s) must be in the same root class (%s).', |
| 99 | $fromInstance->getUri(), |
| 100 | $toClass->getUri(), |
| 101 | $rootClass->getUri() |
| 102 | ) |
| 103 | ); |
| 104 | } |
| 105 | } |
| 106 | } |
| 107 | } |