CategoryCollection.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Core\Category\Collection;
 
use ‪TYPO3\CMS\Core\Collection\AbstractRecordCollection;
use ‪TYPO3\CMS\Core\Collection\CollectionInterface;
use ‪TYPO3\CMS\Core\Collection\EditableCollectionInterface;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\QueryBuilder;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪CategoryCollection extends ‪AbstractRecordCollection implements ‪EditableCollectionInterface
{
    protected static ‪$storageTableName = 'sys_category';
 
    protected ‪$relationFieldName = 'categories';
 
    public function ‪__construct($tableName = null, $fieldName = null)
    {
        parent::__construct();
        if (!empty($tableName)) {
            $this->‪setItemTableName($tableName);
        } elseif (empty($this->itemTableName)) {
            throw new \RuntimeException(self::class . ' needs a valid itemTableName.', 1341826168);
        }
        if (!empty($fieldName)) {
            $this->‪setRelationFieldName($fieldName);
        }
    }
 
    public static function ‪create(array $collectionRecord, $fillItems = false)
    {
        $collection = GeneralUtility::makeInstance(
            self::class,
            $collectionRecord['table_name'],
            $collectionRecord['field_name']
        );
        $collection->fromArray($collectionRecord);
        if ($fillItems) {
            $collection->loadContents();
        }
        return $collection;
    }
 
    public static function ‪load($id, $fillItems = false, $tableName = '', $fieldName = '')
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable(static::$storageTableName);
 
        $queryBuilder->getRestrictions()
            ->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
 
        $collectionRecord = $queryBuilder->select('*')
            ->from(static::$storageTableName)
            ->where(
                $queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($id, \PDO::PARAM_INT))
            )
            ->setMaxResults(1)
            ->execute()
            ->fetch();
 
        $collectionRecord['table_name'] = $tableName;
        $collectionRecord['field_name'] = $fieldName;
 
        return ‪self::create($collectionRecord, $fillItems);
    }
 
    protected function ‪getCollectedRecordsQueryBuilder()
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable(static::$storageTableName);
        $queryBuilder->‪getRestrictions()->‪removeAll();
 
        $queryBuilder->select($this->‪getItemTableName() . '.*')
            ->from(static::$storageTableName)
            ->join(
                static::$storageTableName,
                'sys_category_record_mm',
                'sys_category_record_mm',
                $queryBuilder->expr()->eq(
                    'sys_category_record_mm.uid_local',
                    $queryBuilder->quoteIdentifier(static::$storageTableName . '.uid')
                )
            )
            ->join(
                'sys_category_record_mm',
                $this->‪getItemTableName(),
                $this->‪getItemTableName(),
                $queryBuilder->expr()->eq(
                    'sys_category_record_mm.uid_foreign',
                    $queryBuilder->quoteIdentifier($this->getItemTableName() . '.uid')
                )
            )
            ->where(
                $queryBuilder->expr()->eq(
                    static::$storageTableName . '.uid',
                    $queryBuilder->createNamedParameter($this->getIdentifier(), \PDO::PARAM_INT)
                ),
                $queryBuilder->expr()->eq(
                    'sys_category_record_mm.tablenames',
                    $queryBuilder->createNamedParameter($this->getItemTableName(), \PDO::PARAM_STR)
                ),
                $queryBuilder->expr()->eq(
                    'sys_category_record_mm.fieldname',
                    $queryBuilder->createNamedParameter($this->getRelationFieldName(), \PDO::PARAM_STR)
                )
            )
            // @todo: MM TCA ref docs say 'sorting' is a required field for MM relations, but it seems code always
            //        hard codes to field name 'sorting' (RelationHandler) and never uses 'sorting' TCA definition.
            //        Furthermore through implementing auto creation of MM tables from TCA 'sorting' is auto created.
            // Add required sorting field.
            ->orderBy('sys_category_record_mm.sorting', 'ASC')
            // Add foreign uid field to ensure determistic sorting across dbms and dbms versions
            ->addOrderBy('sys_category_record_mm.uid_foreign', 'ASC')
        ;
 
        return $queryBuilder;
    }
 
    protected function ‪getCollectedRecords()
    {
        $relatedRecords = [];
 
        $queryBuilder = $this->‪getCollectedRecordsQueryBuilder();
        $result = $queryBuilder->execute();
 
        while ($record = $result->fetch()) {
            $relatedRecords[] = $record;
        }
 
        return $relatedRecords;
    }
 
    public function ‪loadContents()
    {
        $entries = $this->‪getCollectedRecords();
        $this->‪removeAll();
        foreach ($entries as $entry) {
            $this->‪add($entry);
        }
    }
 
    protected function ‪getPersistableDataArray()
    {
        return [
            'title' => $this->‪getTitle(),
            'description' => $this->‪getDescription(),
            'items' => $this->‪getItemUidList(true)
        ];
    }
 
    public function ‪add($data)
    {
        $this->storage->push($data);
    }
 
    public function ‪addAll(‪CollectionInterface $other)
    {
        foreach ($other as $value) {
            $this->‪add($value);
        }
    }
 
    public function remove($data)
    {
        $offset = 0;
        foreach ($this->storage as $value) {
            if ($value == $data) {
                break;
            }
            $offset++;
        }
        $this->storage->offsetUnset($offset);
    }
 
    public function ‪removeAll()
    {
        $this->storage = new \SplDoublyLinkedList();
    }
 
    public function ‪getItems()
    {
        $itemArray = [];
        foreach ($this->storage as $item) {
            $itemArray[] = $item;
        }
        return $itemArray;
    }
 
    public function ‪setRelationFieldName($field)
    {
        $this->relationFieldName = $field;
    }
 
    public function ‪getRelationFieldName()
    {
        return ‪$this->relationFieldName;
    }
 
    public static function ‪getStorageTableName()
    {
        return ‪self::$storageTableName;
    }
 
    public static function ‪getStorageItemsField()
    {
        return ‪self::$storageItemsField;
    }
}