eZ\Publish\Core\SignalSlot\LocationService

Complexity

Total Complexity

20

Size/Duplication

Total Lines	355
Duplicated Lines	12.68 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	copySubtree()	0	15	1
A	loadLocation()	0	4	1
A	loadLocationList()	0	4	1
A	loadLocationByRemoteId()	0	4	1
A	loadLocations()	0	4	1
A	loadLocationChildren()	0	4	1
A	loadParentLocationsForDraftContent()	0	4	1
A	getLocationChildCount()	0	4	1
A	createLocation()	0	15	1
A	swapLocation()	0	18	1
A	hideLocation()	16	16	1
A	unhideLocation()	16	16	1
A	moveSubtree()	0	15	1
A	deleteLocation()	13	13	1
A	newLocationCreateStruct()	0	4	1
A	newLocationUpdateStruct()	0	4	1
A	getAllLocationsCount()	0	4	1
A	loadAllLocations()	0	4	1
A	updateLocation()	0	15	1

<?php

/**
 * LocationService class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\SignalSlot;

use eZ\Publish\API\Repository\LocationService as LocationServiceInterface;
use eZ\Publish\API\Repository\Values\Content\Location;
use eZ\Publish\API\Repository\Values\Content\ContentInfo;
use eZ\Publish\API\Repository\Values\Content\LocationCreateStruct;
use eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct;
use eZ\Publish\API\Repository\Values\Content\VersionInfo;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\CopySubtreeSignal;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\CreateLocationSignal;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\UpdateLocationSignal;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\SwapLocationSignal;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\HideLocationSignal;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\UnhideLocationSignal;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\MoveSubtreeSignal;
use eZ\Publish\Core\SignalSlot\Signal\LocationService\DeleteLocationSignal;
use eZ\Publish\API\Repository\Values\ContentType\ContentType;

/**
 * LocationService class.
 */
class LocationService implements LocationServiceInterface
{
    /**
     * Aggregated service.
     *
     * @var \eZ\Publish\API\Repository\LocationService
     */
    protected $service;

    /**
     * SignalDispatcher.
     *
     * @var \eZ\Publish\Core\SignalSlot\SignalDispatcher
     */
    protected $signalDispatcher;

    /**
     * Constructor.
     *
     * Construct service object from aggregated service and signal
     * dispatcher
     *
     * @param \eZ\Publish\API\Repository\LocationService $service
     * @param \eZ\Publish\Core\SignalSlot\SignalDispatcher $signalDispatcher
     */
    public function __construct(LocationServiceInterface $service, SignalDispatcher $signalDispatcher)
    {
        $this->service = $service;
        $this->signalDispatcher = $signalDispatcher;
    }

    /**
     * Copies the subtree starting from $subtree as a new subtree of $targetLocation.
     *
     * Only the items on which the user has read access are copied.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user is not allowed copy the subtree to the given parent location
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user does not have read access to the whole source subtree
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the target location is a sub location of the given location
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $subtree - the subtree denoted by the location to copy
     * @param \eZ\Publish\API\Repository\Values\Content\Location $targetParentLocation - the target parent location for the copy operation
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Location The newly created location of the copied subtree
     */
    public function copySubtree(Location $subtree, Location $targetParentLocation)
    {
        $returnValue = $this->service->copySubtree($subtree, $targetParentLocation);
        $this->signalDispatcher->emit(
            new CopySubtreeSignal(
                array(
                    'subtreeId' => $subtree->id,
                    'targetParentLocationId' => $targetParentLocation->id,
                    'targetNewSubtreeId' => $returnValue->id,
                )
            )
        );

        return $returnValue;
    }

    /**
     * {@inheritdoc}
     */
    public function loadLocation($locationId, array $prioritizedLanguages = null, bool $useAlwaysAvailable = null)
    {
        return $this->service->loadLocation($locationId, $prioritizedLanguages, $useAlwaysAvailable);

It seems like $prioritizedLanguages defined by parameter $prioritizedLanguages on line 94 can also be of type array; however, eZ\Publish\API\Repository\LocationService::loadLocation() does only seem to accept null|array<integer,string>, maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function loadLocationList(array $locationIds, array $prioritizedLanguages = null, bool $useAlwaysAvailable = null): iterable
    {
        return $this->service->loadLocationList($locationIds, $prioritizedLanguages, $useAlwaysAvailable);

It seems like $prioritizedLanguages defined by parameter $prioritizedLanguages on line 102 can also be of type array; however, eZ\Publish\API\Repository\LocationService::loadLocationList() does only seem to accept null|array<integer,string>, maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function loadLocationByRemoteId($remoteId, array $prioritizedLanguages = null, bool $useAlwaysAvailable = null)
    {
        return $this->service->loadLocationByRemoteId($remoteId, $prioritizedLanguages, $useAlwaysAvailable);

It seems like $prioritizedLanguages defined by parameter $prioritizedLanguages on line 110 can also be of type array; however, eZ\Publish\API\Repository\LocationService::loadLocationByRemoteId() does only seem to accept null|array<integer,string>, maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function loadLocations(ContentInfo $contentInfo, Location $rootLocation = null, array $prioritizedLanguages = null)
    {
        return $this->service->loadLocations($contentInfo, $rootLocation, $prioritizedLanguages);

It seems like $prioritizedLanguages defined by parameter $prioritizedLanguages on line 118 can also be of type array; however, eZ\Publish\API\Repository\LocationService::loadLocations() does only seem to accept null|array<integer,string>, maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function loadLocationChildren(Location $location, $offset = 0, $limit = 25, array $prioritizedLanguages = null)
    {
        return $this->service->loadLocationChildren($location, $offset, $limit, $prioritizedLanguages);

It seems like $prioritizedLanguages defined by parameter $prioritizedLanguages on line 126 can also be of type array; however, eZ\Publish\API\Repository\LocationService::loadLocationChildren() does only seem to accept null|array<integer,string>, maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function loadParentLocationsForDraftContent(VersionInfo $versionInfo, array $prioritizedLanguages = null)
    {
        return $this->service->loadParentLocationsForDraftContent($versionInfo, $prioritizedLanguages);

It seems like $prioritizedLanguages defined by parameter $prioritizedLanguages on line 134 can also be of type array; however, eZ\Publish\API\Repository\LocationService::loadParentLocationsForDraftContent() does only seem to accept null|array<integer,string>, maybe add an additional type check?

    }

    /**
     * Returns the number of children which are readable by the current user of a location object.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     *
     * @return int
     */
    public function getLocationChildCount(Location $location)
    {
        return $this->service->getLocationChildCount($location);
    }

    /**
     * Creates the new $location in the content repository for the given content.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user is not allowed to create this location
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the content is already below the specified parent
     *                                        or the parent is a sub location of the location of the content
     *                                        or if set the remoteId exists already
     *
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
     * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $locationCreateStruct
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Location the newly created Location
     */
    public function createLocation(ContentInfo $contentInfo, LocationCreateStruct $locationCreateStruct)
    {
        $returnValue = $this->service->createLocation($contentInfo, $locationCreateStruct);
        $this->signalDispatcher->emit(
            new CreateLocationSignal(
                array(
                    'contentId' => $contentInfo->id,
                    'locationId' => $returnValue->id,
                    'parentLocationId' => $returnValue->parentLocationId,
                )
            )
        );

        return $returnValue;
    }

    /**
     * Updates $location in the content repository.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user is not allowed to update this location
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException   if if set the remoteId exists already
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     * @param \eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct $locationUpdateStruct
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Location the updated Location
     */
    public function updateLocation(Location $location, LocationUpdateStruct $locationUpdateStruct)
    {
        $returnValue = $this->service->updateLocation($location, $locationUpdateStruct);
        $this->signalDispatcher->emit(
            new UpdateLocationSignal(
                array(
                    'contentId' => $location->contentId,
                    'locationId' => $location->id,
                    'parentLocationId' => $location->parentLocationId,
                )
            )
        );

        return $returnValue;
    }

    /**
     * Swaps the contents held by $location1 and $location2.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user is not allowed to swap content
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location1
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location2
     */
    public function swapLocation(Location $location1, Location $location2)
    {
        $returnValue = $this->service->swapLocation($location1, $location2);
        $this->signalDispatcher->emit(
            new SwapLocationSignal(
                array(
                    'location1Id' => $location1->id,
                    'content1Id' => $location1->contentId,
                    'parentLocation1Id' => $location1->parentLocationId,
                    'location2Id' => $location2->id,
                    'content2Id' => $location2->contentId,
                    'parentLocation2Id' => $location2->parentLocationId,
                )
            )
        );

        return $returnValue;
    }

    /**
     * Hides the $location and marks invisible all descendants of $location.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user is not allowed to hide this location
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Location $location, with updated hidden value
     */
    public function hideLocation(Location $location)
    {
        $returnValue = $this->service->hideLocation($location);
        $this->signalDispatcher->emit(
            new HideLocationSignal(
                array(
                    'locationId' => $location->id,
                    'contentId' => $location->contentId,
                    'currentVersionNo' => $returnValue->getContentInfo()->currentVersionNo,
                    'parentLocationId' => $returnValue->parentLocationId,
                )
            )
        );

        return $returnValue;
    }

    /**
     * Unhides the $location.
     *
     * This method and marks visible all descendants of $locations
     * until a hidden location is found.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user is not allowed to unhide this location
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Location $location, with updated hidden value
     */
    public function unhideLocation(Location $location)
    {
        $returnValue = $this->service->unhideLocation($location);
        $this->signalDispatcher->emit(
            new UnhideLocationSignal(
                array(
                    'locationId' => $location->id,
                    'contentId' => $location->contentId,
                    'currentVersionNo' => $returnValue->getContentInfo()->currentVersionNo,
                    'parentLocationId' => $returnValue->parentLocationId,
                )
            )
        );

        return $returnValue;
    }

    /**
     * Moves the subtree to $newParentLocation.
     *
     * If a user has the permission to move the location to a target location
     * he can do it regardless of an existing descendant on which the user has no permission.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user user is not allowed to move this location to the target
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     * @param \eZ\Publish\API\Repository\Values\Content\Location $newParentLocation
     */
    public function moveSubtree(Location $location, Location $newParentLocation)
    {
        $returnValue = $this->service->moveSubtree($location, $newParentLocation);
        $this->signalDispatcher->emit(
            new MoveSubtreeSignal(
                array(
                    'locationId' => $location->id,
                    'newParentLocationId' => $newParentLocation->id,
                    'oldParentLocationId' => $location->parentLocationId,
                )
            )
        );

        return $returnValue;
    }

    /**
     * Deletes $location and all its descendants.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the current user is not allowed to delete this location or a descendant
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     */
    public function deleteLocation(Location $location)
    {
        $this->service->deleteLocation($location);
        $this->signalDispatcher->emit(
            new DeleteLocationSignal(
                array(
                    'contentId' => $location->contentId,
                    'locationId' => $location->id,
                    'parentLocationId' => $location->parentLocationId,
                )
            )
        );
    }

    /**
     * Instantiates a new location create class.
     *
     * @param mixed $parentLocationId the parent under which the new location should be created
     * @param eZ\Publish\API\Repository\Values\ContentType\ContentType|null $contentType
     *
     * @return \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct
     */
    public function newLocationCreateStruct($parentLocationId, ContentType $contentType = null)
    {
        return $this->service->newLocationCreateStruct($parentLocationId, $contentType);
    }

    /**
     * Instantiates a new location update class.
     *
     * @return \eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct
     */
    public function newLocationUpdateStruct()
    {
        return $this->service->newLocationUpdateStruct();
    }

    /**
     * Get the total number of all existing Locations. Can be combined with loadAllLocations.
     *
     * @see loadAllLocations
     *
     * @return int Total number of Locations
     */
    public function getAllLocationsCount(): int
    {
        return $this->service->getAllLocationsCount();
    }

    /**
     * Bulk-load all existing Locations, constrained by $limit and $offset to paginate results.
     *
     * @param int $limit
     * @param int $offset
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Location[]
     */
    public function loadAllLocations(int $offset = 0, int $limit = 25): array
    {
        return $this->service->loadAllLocations($offset, $limit);
    }
}