File Core/src/ORM/Inheritance/AssociationCollection.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2017 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\ORM\Inheritance;

use BEdita\Core\ORM\Association\RelatedTo;
use Cake\ORM\Association;
use Cake\ORM\AssociationCollection as CakeAssociationCollection;

/**
 * Class to proxy all association operations to inherited tables.
 *
 * This allows associations to be inherited in a way that, if a new
 * association is added to the parent table, it becomes immediately
 * available for descendants.
 *
 * @since 4.0.0
 */
class AssociationCollection extends CakeAssociationCollection
{

    /**
     * Inner association collection.
     *
     * This represents the association collection of the inherited table.
     *
     * @var \Cake\ORM\AssociationCollection
     */
    protected $innerCollection;

    /**
     * Table instance.
     *
     * @var \BEdita\Core\ORM\Inheritance\Table
     */
    protected $table;

    /**
     * Class constructor.
     *
     * @param \BEdita\Core\ORM\Inheritance\Table $table Original table instance.
     */
    public function __construct(Table $table)
    {
        $this->table = $table;

        // Copy existing associations to the new collection. This is the new collection. Associations are copied here.
        $this->_items = $table->associations()->_items;

        $this->innerCollection = new CakeAssociationCollection();
        if ($table->inheritedTable() !== null) {
            $this->innerCollection = $table->inheritedTable()->associations();
        }
    }

    /**
     * Get the inherited associations collection.
     *
     * The clone of `self::innerCollection` is cleaned by `RelatedTo` associations
     * that involve concrete objects.
     *
     * @return \Cake\ORM\AssociationCollection
     */
    protected function inheritedAssociations()
    {
        $innerCollection = clone $this->innerCollection;
        foreach ($innerCollection as $association) {
            if (!($association instanceof RelatedTo) || $association->isSourceAbstract()) {
                continue;
            }

            $innerCollection->remove($association->getName());
        }

        return $innerCollection;
    }

    /**
     * Helper to adjust configuration for an association that's being inherited.
     *
     * When inheriting an association it is essential to clone the association class,
     * change the source table and ensure binding key and foreign key are "frozen" to avoid
     * conventions being applied against the new table.
     *
     * @param \Cake\ORM\Association|null $association Association being inherited.
     * @return \Cake\ORM\Association
     */
    protected function inheritAssociation(Association $association = null)
    {
        if ($association === null) {
            return $association;
        }

        $inheritedAssociation = clone $association;
        $inheritedAssociation
            ->setSource($this->table)
            ->setBindingKey($association->getBindingKey())
            ->setForeignKey($association->getForeignKey());

        return $inheritedAssociation;
    }

    /**
     * {@inheritDoc}
     */
    public function get($alias)
    {
        $association = parent::get($alias);
        if ($association === null) {
            $association = $this->inheritAssociation($this->inheritedAssociations()->get($alias));
        }

        return $association;
    }

    /**
     * {@inheritDoc}
     */
    public function getByProperty($prop)
    {
        $association = parent::getByProperty($prop);
        if ($association === null) {
            $association = $this->inheritAssociation($this->inheritedAssociations()->getByProperty($prop));
        }

        return $association;
    }

    /**
     * {@inheritDoc}
     */
    public function has($alias)
    {
        return parent::has($alias) || $this->inheritedAssociations()->has($alias);
    }

    /**
     * {@inheritDoc}
     */
    public function keys()
    {
        return array_merge(parent::keys(), $this->inheritedAssociations()->keys());
    }

    /**
     * {@inheritDoc}
     */
    public function getByType($class)
    {
        return array_merge(parent::getByType($class), $this->inheritedAssociations()->getByType($class));
    }

    /**
     * {@inheritDoc}
     *
     * @param bool $cascade Should removal be cascaded to parent table's associations?
     */
    public function remove($alias, $cascade = true)
    {
        parent::remove($alias);
        if ($cascade) {
            $this->innerCollection->remove($alias);
        }
    }

    /**
     * {@inheritDoc}
     */
    public function removeAll()
    {
        parent::removeAll();
        $this->innerCollection->removeAll();
    }

    /**
     * {@inheritDoc}
     */
    protected function _getNoCascadeItems($entity, $options)
    {
        return array_merge(
            parent::_getNoCascadeItems($entity, $options),
            $this->inheritedAssociations()->_getNoCascadeItems($entity, $options)
        );
    }

    /**
     * {@inheritDoc}
     */
    public function getIterator()
    {
        $iterator = new \AppendIterator();
        $iterator->append(new \ArrayIterator($this->_items));
        $iterator->append($this->inheritedAssociations()->getIterator());

        return $iterator;
    }

    /**
     * Object clone hook.
     *
     * Clone the inner association collection.
     *
     * @return void
     */
    public function __clone()
    {
        $this->innerCollection = clone $this->innerCollection;
    }
}

Namespaces

Classes