class.t3lib_utility_dependency_element.php

Go to the documentation of this file.

<?php
/***************************************************************
 * Copyright notice
 *
 * (c) 2010-2011 Oliver Hader <oliver@typo3.org>
 * All rights reserved
 *
 * This script is part of the TYPO3 project. The TYPO3 project is
 * free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The GNU General Public License can be found at
 * http://www.gnu.org/copyleft/gpl.html.
 * A copy is found in the textfile GPL.txt and important notices to the license
 * from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 * This script is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * Object to hold information on a dependent database element in abstract.
 */
class t3lib_utility_Dependency_Element {
    const REFERENCES_ChildOf = 'childOf';
    const REFERENCES_ParentOf = 'parentOf';
    const EVENT_Construct = 't3lib_utility_Dependency_Element::construct';
    const EVENT_CreateChildReference = 't3lib_utility_Dependency_Element::createChildReference';
    const EVENT_CreateParentReference = 't3lib_utility_Dependency_Element::createParentReference';
    const RESPONSE_Skip = 't3lib_utility_Dependency_Element->skip';

    /**
     * @var string
     */
    protected $table;

    /**
     * @var integer
     */
    protected $id;

    /**
     * @var array
     */
    protected $data;

    /**
     * @var t3lib_utility_Dependency
     */
    protected $dependency;

    /**
     * @var array
     */
    protected $children;

    /**
     * @var array
     */
    protected $parents;

    /**
     * @var boolean
     */
    protected $traversingParents = FALSE;

    /**
     * @var t3lib_utility_Dependency_Element
     */
    protected $outerMostParent;

    /**
     * @var array
     */
    protected $nestedChildren;

    /**
     * Creates this object.
     *
     * @param string $table
     * @param integer $id
     * @param array $data (optional)
     * @param t3lib_utility_Dependency $dependency
     */
    public function __construct($table, $id, array $data = array(), t3lib_utility_Dependency $dependency) {
        $this->table = $table;
        $this->id = intval($id);
        $this->data = $data;
        $this->dependency = $dependency;

        $this->dependency->executeEventCallback(self::EVENT_Construct, $this);
    }

    /**
     * Gets the table.
     *
     * @return string
     */
    public function getTable() {
        return $this->table;
    }

    /**
     * Gets the id.
     *
     * @return integer
     */
    public function getId() {
        return $this->id;
    }

    /**
     * Gets the data.
     *
     * @return array
     */
    public function getData() {
        return $this->data;
    }

    /**
     * Gets a value for a particular key from the data.
     *
     * @param string $key
     * @return mixed
     */
    public function getDataValue($key) {
        $result = NULL;

        if ($this->hasDataValue($key)) {
            $result = $this->data[$key];
        }

        return $result;
    }

    /**
     * Sets a value for a particular key in the data.
     *
     * @param string $key
     * @param mixed $value
     * @return void
     */
    public function setDataValue($key, $value) {
        $this->data[$key] = $value;
    }

    /**
     * Determines whether a particular key holds data.
     *
     * @param string $key
     * @return
     */
    public function hasDataValue($key) {
        return (isset($this->data[$key]));
    }

    /**
     * Converts this object for string representation.
     *
     * @return string
     */
    public function __toString() {
        return self::getIdentifier($this->table, $this->id);
    }

    /**
     * Gets the parent dependency object.
     *
     * @return t3lib_utility_Dependency
     */
    public function getDependency() {
        return $this->dependency;
    }

    /**
     * Gets all child references.
     *
     * @return array
     */
    public function getChildren() {
        if (!isset($this->children)) {
            $this->children = array();
            $rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
                '*',
                'sys_refindex',
                'tablename=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->table, 'sys_refindex') .
                ' AND recuid=' . $this->id
            );
            if (is_array($rows)) {
                foreach ($rows as $row) {
                    $reference = $this->getDependency()->getFactory()->getReferencedElement(
                        $row['ref_table'], $row['ref_uid'], $row['field'], array(), $this->getDependency()
                    );
                    $callbackResponse = $this->dependency->executeEventCallback(
                        self::EVENT_CreateChildReference,
                        $this, array('reference' => $reference)
                    );
                    if ($callbackResponse !== self::RESPONSE_Skip) {
                        $this->children[] = $reference;
                    }
                }
            }
        }
        return $this->children;
    }

    /**
     * Gets all parent references.
     *
     * @return array
     */
    public function getParents() {
        if (!isset($this->parents)) {
            $this->parents = array();
            $rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
                '*',
                'sys_refindex',
                'ref_table=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->table, 'sys_refindex') .
                ' AND deleted=0 AND ref_uid=' . $this->id
            );
            if (is_array($rows)) {
                foreach ($rows as $row) {
                    $reference = $this->getDependency()->getFactory()->getReferencedElement(
                        $row['tablename'], $row['recuid'], $row['field'], array(), $this->getDependency()
                    );
                    $callbackResponse = $this->dependency->executeEventCallback(
                        self::EVENT_CreateParentReference,
                        $this, array('reference' => $reference)
                    );
                    if ($callbackResponse !== self::RESPONSE_Skip) {
                        $this->parents[] = $reference;
                    }
                }
            }
        }
        return $this->parents;
    }

    /**
     * Determines whether there are child or parent references.
     *
     * @return boolean
     */
    public function hasReferences() {
        return (count($this->getChildren()) > 0 || count($this->getParents()) > 0);
    }

    /**
     * Gets the outermost parent element.
     *
     * @return t3lib_utility_Dependency_Element
     */
    public function getOuterMostParent() {
        if (!isset($this->outerMostParent)) {
            $parents = $this->getParents();
            if (count($parents) === 0) {
                $this->outerMostParent = $this;
            } else {
                $this->outerMostParent = FALSE;
                /** @var $parent t3lib_utility_Dependency_Reference */
                foreach ($parents as $parent) {
                    $outerMostParent = $parent->getElement()->getOuterMostParent();
                    if ($outerMostParent instanceof t3lib_utility_Dependency_Element) {
                        $this->outerMostParent = $outerMostParent;
                        break;
                    } elseif ($outerMostParent === FALSE) {
                        break;
                    }
                }
            }
        }

        return $this->outerMostParent;
    }

    /**
     * Gets nested children accumulated.
     *
     * @return array
     */
    public function getNestedChildren() {
        if (!isset($this->nestedChildren)) {
            $this->nestedChildren = array();
            $children = $this->getChildren();
            /** @var $child t3lib_utility_Dependency_Reference */
            foreach ($children as $child) {
                $this->nestedChildren = array_merge(
                    $this->nestedChildren,
                    array($child->getElement()->__toString() => $child->getElement()),
                    $child->getElement()->getNestedChildren()
                );
            }
        }

        return $this->nestedChildren;
    }

    /**
     * Converts the object for string representation.
     *
     * @param string $table
     * @param integer $id
     * @return string
     */
    public static function getIdentifier($table, $id) {
        return $table . ':' . $id;
    }
}