AbstractRecordCollection.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Collection;

abstract class AbstractRecordCollection implements \TYPO3\CMS\Core\Collection\RecordCollectionInterface, \TYPO3\CMS\Core\Collection\PersistableCollectionInterface, \TYPO3\CMS\Core\Collection\SortableCollectionInterface {

    static protected $storageTableName = 'sys_collection';

    static protected $storageItemsField = 'items';

    protected $uid = 0;

    protected $title;

    protected $description;

    protected $itemTableName;

    protected $storage;

    public function __construct() {
        $this->storage = new \SplDoublyLinkedList();
    }

    public function current() {
        return $this->storage->current();
    }

    public function next() {
        $this->storage->next();
    }

    public function key() {
        $currentRecord = $this->storage->current();
        return $currentRecord['uid'];
    }

    public function valid() {
        return $this->storage->valid();
    }

    public function rewind() {
        $this->storage->rewind();
    }

    public function serialize() {
        $data = array(
            'uid' => $this->getIdentifier()
        );
        return serialize($data);
    }

    public function unserialize($serialized) {
        $data = unserialize($serialized);
        return self::load($data['uid']);
    }

    public function count() {
        return $this->storage->count();
    }

    public function getTitle() {
        return $this->title;
    }

    public function getUid() {
        return $this->uid;
    }

    public function getDescription() {
        return $this->description;
    }

    public function setTitle($title) {
        $this->title = $title;
    }

    public function setDescription($desc) {
        $this->description = $desc;
    }

    public function getItemTableName() {
        return $this->itemTableName;
    }

    public function setItemTableName($tableName) {
        $this->itemTableName = $tableName;
    }

    public function usort($callbackFunction) {
        // TODO: Implement usort() method with TCEforms in mind
        throw new \RuntimeException('This method is not yet supported.', 1322545589);
    }

    public function moveItemAt($currentPosition, $newPosition = 0) {
        // TODO: Implement usort() method with TCEforms in mind
        throw new \RuntimeException('This method is not yet supported.', 1322545626);
    }

    public function getIdentifier() {
        return $this->uid;
    }

    public function setIdentifier($id) {
        $this->uid = (int)$id;
    }

    static public function load($id, $fillItems = FALSE) {
        $collectionRecord = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow('*', static::$storageTableName, 'uid=' . (int)$id . \TYPO3\CMS\Backend\Utility\BackendUtility::deleteClause(static::$storageTableName));
        return self::create($collectionRecord, $fillItems);
    }

    static public function create(array $collectionRecord, $fillItems = FALSE) {
        $collection = new static();
        $collection->fromArray($collectionRecord);
        if ($fillItems) {
            $collection->loadContents();
        }
        return $collection;
    }

    public function persist() {
        $uid = $this->getIdentifier() == 0 ? 'NEW' . rand(100000, 999999) : $this->getIdentifier();
        $data = array(
            trim(static::$storageTableName) => array(
                $uid => $this->getPersistableDataArray()
            )
        );
        // New records always must have a pid
        if ($this->getIdentifier() == 0) {
            $data[trim(static::$storageTableName)][$uid]['pid'] = 0;
        }
        $tce = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\DataHandling\\DataHandler');
        $tce->stripslashes_values = 0;
        $tce->start($data, array());
        $tce->process_datamap();
    }

    abstract protected function getPersistableDataArray();

    protected function getItemUidList($includeTableName = TRUE) {
        $list = array();
        foreach ($this->storage as $entry) {
            $list[] = ($includeTableName ? $this->getItemTableName() . '_' : '') . $entry['uid'];
        }
        return implode(',', $list);
    }

    public function toArray() {
        $itemArray = array();
        foreach ($this->storage as $item) {
            $itemArray[] = $item;
        }
        return array(
            'uid' => $this->getIdentifier(),
            'title' => $this->getTitle(),
            'description' => $this->getDescription(),
            'table_name' => $this->getItemTableName(),
            'items' => $itemArray
        );
    }

    public function fromArray(array $array) {
        $this->uid = $array['uid'];
        $this->title = $array['title'];
        $this->description = $array['description'];
        $this->itemTableName = $array['table_name'];
    }

}