ElementEntity.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Workspaces\Dependency;
 
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪ElementEntity
{
    public const ‪REFERENCES_ChildOf = 'childOf';
    public const ‪REFERENCES_ParentOf = 'parentOf';
    public const ‪EVENT_Construct = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::construct';
    public const ‪EVENT_CreateChildReference = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::createChildReference';
    public const ‪EVENT_CreateParentReference = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity::createParentReference';
    public const ‪RESPONSE_Skip = 'TYPO3\\CMS\\Version\\Dependency\\ElementEntity->skip';
 
    protected bool ‪$invalid = false;
    protected string ‪$table;
    protected int ‪$id;
    protected array ‪$data;
    protected array ‪$record;
    protected ‪DependencyResolver ‪$dependency;
    protected ?array ‪$children;
    protected ?array ‪$parents;
    protected ‪ElementEntity|false|null ‪$outerMostParent;
 
    protected ?array ‪$nestedChildren;
 
    public function ‪__construct(string ‪$table, int ‪$id, array ‪$data, ‪DependencyResolver ‪$dependency)
    {
        $this->table = ‪$table;
        $this->id = ‪$id;
        $this->data = ‪$data;
        $this->dependency = ‪$dependency;
        $this->dependency->‪executeEventCallback(self::EVENT_Construct, $this);
    }
 
    public function ‪setInvalid(bool ‪$invalid): void
    {
        $this->invalid = ‪$invalid;
    }
 
    public function ‪isInvalid(): bool
    {
        return ‪$this->invalid;
    }
 
    public function ‪getTable(): string
    {
        return ‪$this->table;
    }
 
    public function ‪getId(): int
    {
        return ‪$this->id;
    }
 
    public function ‪setId(int ‪$id): void
    {
        $this->id = ‪$id;
    }
 
    public function ‪getData(): array
    {
        return ‪$this->data;
    }
 
    public function ‪getDataValue(string $key): mixed
    {
        $result = null;
        if ($this->‪hasDataValue($key)) {
            $result = $this->data[$key];
        }
        return $result;
    }
 
    public function ‪setDataValue(string $key, mixed $value): void
    {
        $this->data[$key] = $value;
    }
 
    public function ‪hasDataValue(string $key): bool
    {
        return isset($this->data[$key]);
    }
 
    public function ‪__toString(): string
    {
        return ‪self::getIdentifier($this->table, $this->id);
    }
 
    public function ‪getDependency(): ‪DependencyResolver
    {
        return ‪$this->dependency;
    }
 
    public function ‪getChildren(): array
    {
        if (!isset($this->children)) {
            $this->children = [];
 
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getQueryBuilderForTable('sys_refindex');
 
            $result = $queryBuilder
                ->select('*')
                ->from('sys_refindex')
                ->where(
                    $queryBuilder->expr()->eq(
                        'tablename',
                        $queryBuilder->createNamedParameter($this->table)
                    ),
                    $queryBuilder->expr()->eq(
                        'recuid',
                        $queryBuilder->createNamedParameter($this->id, ‪Connection::PARAM_INT)
                    ),
                    $queryBuilder->expr()->eq(
                        'workspace',
                        $queryBuilder->createNamedParameter($this->dependency->getWorkspace(), ‪Connection::PARAM_INT)
                    )
                )
                ->orderBy('sorting')
                ->executeQuery();
 
            while ($row = $result->fetchAssociative()) {
                if ($row['ref_table'] !== '_FILE' && $row['ref_table'] !== '_STRING') {
                    $arguments = [
                        'table' => $row['ref_table'],
                        'id' => $row['ref_uid'],
                        'field' => $row['field'],
                        'scope' => ‪self::REFERENCES_ChildOf,
                    ];
 
                    $callbackResponse = $this->dependency->executeEventCallback(
                        self::EVENT_CreateChildReference,
                        $this,
                        $arguments
                    );
                    if ($callbackResponse !== self::RESPONSE_Skip) {
                        $this->children[] = $this->‪getDependency()->getFactory()->getReferencedElement(
                            $row['ref_table'],
                            $row['ref_uid'],
                            $row['field'],
                            [],
                            $this->‪getDependency()
                        );
                    }
                }
            }
        }
        return ‪$this->children;
    }
 
    public function ‪getParents(): array
    {
        if (!isset($this->parents)) {
            $this->parents = [];
 
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getQueryBuilderForTable('sys_refindex');
 
            $result = $queryBuilder
                ->select('*')
                ->from('sys_refindex')
                ->where(
                    $queryBuilder->expr()->eq(
                        'ref_table',
                        $queryBuilder->createNamedParameter($this->table)
                    ),
                    $queryBuilder->expr()->eq(
                        'ref_uid',
                        $queryBuilder->createNamedParameter($this->id, ‪Connection::PARAM_INT)
                    ),
                    $queryBuilder->expr()->eq(
                        'workspace',
                        $queryBuilder->createNamedParameter($this->dependency->getWorkspace(), ‪Connection::PARAM_INT)
                    )
                )
                ->orderBy('sorting')
                ->executeQuery();
 
            while ($row = $result->fetchAssociative()) {
                $arguments = [
                    'table' => $row['tablename'],
                    'id' => $row['recuid'],
                    'field' => $row['field'],
                    'scope' => ‪self::REFERENCES_ParentOf,
                ];
                $callbackResponse = $this->dependency->executeEventCallback(
                    self::EVENT_CreateParentReference,
                    $this,
                    $arguments
                );
                if ($callbackResponse !== self::RESPONSE_Skip) {
                    $this->parents[] = $this->‪getDependency()->getFactory()->getReferencedElement(
                        $row['tablename'],
                        $row['recuid'],
                        $row['field'],
                        [],
                        $this->‪getDependency()
                    );
                }
            }
        }
        return ‪$this->parents;
    }
 
    public function ‪hasReferences(): bool
    {
        return !empty($this->‪getChildren()) || !empty($this->‪getParents());
    }
 
    public function ‪getOuterMostParent(): false|‪ElementEntity
    {
        if (!isset($this->outerMostParent)) {
            ‪$parents = $this->‪getParents();
            if (empty(‪$parents)) {
                $this->outerMostParent = $this;
            } else {
                $this->outerMostParent = false;
                foreach (‪$parents as $parent) {
                    ‪$outerMostParent = $parent->getElement()->‪getOuterMostParent();
                    if (‪$outerMostParent instanceof ‪ElementEntity) {
                        $this->outerMostParent = ‪$outerMostParent;
                        break;
                    }
                    if (‪$outerMostParent === false) {
                        break;
                    }
                }
            }
        }
        return ‪$this->outerMostParent;
    }
 
    public function ‪getNestedChildren(): array
    {
        if (!isset($this->nestedChildren)) {
            $this->nestedChildren = [];
            ‪$children = $this->‪getChildren();
            foreach ($children as $child) {
                $this->nestedChildren = array_merge($this->nestedChildren, [$child->getElement()->__toString() => $child->getElement()], $child->getElement()->getNestedChildren());
            }
        }
        return ‪$this->nestedChildren;
    }
 
    public static function ‪getIdentifier(string ‪$table, int ‪$id): string
    {
        return ‪$table . ':' . ‪$id;
    }
 
    public function ‪getRecord(): array
    {
        if (empty($this->record['uid']) || (int)$this->record['uid'] !== $this->‪getId()) {
            $this->record = [];
 
            $fieldNames = ['uid', 'pid', 't3ver_wsid', 't3ver_state', 't3ver_oid'];
            if (!empty(‪$GLOBALS['TCA'][$this->‪getTable()]['ctrl']['delete'])) {
                $fieldNames[] = ‪$GLOBALS['TCA'][$this->‪getTable()]['ctrl']['delete'];
            }
 
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getQueryBuilderForTable($this->‪getTable());
            $queryBuilder->getRestrictions()->removeAll();
 
            $row = $queryBuilder
                ->select(...$fieldNames)
                ->from($this->‪getTable())
                ->where(
                    $queryBuilder->expr()->eq(
                        'uid',
                        $queryBuilder->createNamedParameter($this->getId(), ‪Connection::PARAM_INT)
                    )
                )
                ->executeQuery()
                ->fetchAssociative();
 
            if (is_array($row)) {
                $this->record = $row;
            }
        }
 
        return ‪$this->record;
    }
}