ElementProviderTrait.php

<?php
declare(strict_types=1);

/**
 * Pimcore
 *
 * This source file is available under two different licenses:
 * - GNU General Public License version 3 (GPLv3)
 * - Pimcore Commercial License (PCL)
 * Full copyright and license information is available in
 * LICENSE.md which is distributed with this source code.
 *
 *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
 *  @license    http://www.pimcore.org/license     GPLv3 and PCL
 */

namespace Pimcore\Bundle\StudioBackendBundle\Util\Trait;

use Pimcore\Bundle\StaticResolverBundle\Models\Element\ServiceResolverInterface;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidElementTypeException;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
use Pimcore\Bundle\StudioBackendBundle\Util\Constant\ElementTypes;
use Pimcore\Model\Asset;
use Pimcore\Model\DataObject;
use Pimcore\Model\DataObject\Concrete;
use Pimcore\Model\Document;
use Pimcore\Model\Element\ElementInterface;
use Pimcore\Model\UserInterface;
use Pimcore\Model\Version;
use function get_class;

/**
 * @internal
 */
trait ElementProviderTrait
{
    /**
     * @throws NotFoundException
     */
    private function getElement(
        ServiceResolverInterface $serviceResolver,
        string $type,
        int $id
    ): ElementInterface {
        $element = $serviceResolver->getElementById($this->getCoreElementType($type), $id);
        if ($element === null) {
            throw new NotFoundException($type, $id);
        }

        return $element;
    }

    /**
     * @throws NotFoundException
     */
    private function getElementByPath(
        ServiceResolverInterface $serviceResolver,
        string $type,
        string $path
    ): ElementInterface {
        $element = $serviceResolver->getElementByPath($this->getCoreElementType($type), $path);
        if ($element === null) {
            throw new NotFoundException($type, $path, 'path');
        }

        return $element;
    }

    private function getLatestVersionForUser(
        ElementInterface $element,
        ?UserInterface $user,
    ): ?Version {
        if (!$element instanceof Asset &&
            !$element instanceof Document\PageSnippet &&
            !$element instanceof Concrete
        ) {
            return null;
        }

        // check for latest version
        return $element->getLatestVersion($user?->getId());
    }

    private function getVersionData(ElementInterface $element, ?Version $version): ElementInterface
    {
        if (!$version) {
            return $element;
        }

        return $version->getData();
    }

    /**
     * @throws InvalidElementTypeException
     */
    private function getElementClass(ElementInterface $element): string
    {
        return match (true) {
            $element instanceof Asset => Asset::class,
            $element instanceof Document => Document::class,
            $element instanceof DataObject => DataObject::class,
            default => throw new InvalidElementTypeException(get_class($element))
        };
    }

    /**
     * @throws InvalidElementTypeException
     */
    private function getElementType(ElementInterface $element, bool $getCoreType = false): string
    {
        return match (true) {
            $element instanceof Asset => ElementTypes::TYPE_ASSET,
            $element instanceof Document => ElementTypes::TYPE_DOCUMENT,
            $element instanceof DataObject =>
                $getCoreType ? ElementTypes::TYPE_OBJECT : ElementTypes::TYPE_DATA_OBJECT,
            default => throw new InvalidElementTypeException($element->getType())
        };
    }

    private function getCoreElementType(string $type): string
    {
        if ($type === ElementTypes::TYPE_DATA_OBJECT) {
            return ElementTypes::TYPE_OBJECT;
        }

        return $type;
    }

    private function getElementFullPath(
        string $parentFullPath,
        string $key
    ): string {
        return str_ends_with($parentFullPath, '/') === true ? $parentFullPath . $key : $parentFullPath . '/' . $key;
    }
}