Association.php

<?php
/*
 *  $Id$
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.phpdoctrine.com>.
 */
Doctrine::autoload('Doctrine_Relation');
/**
 * Doctrine_Relation_Association    this class takes care of association mapping
 *                         (= many-to-many relationships, where the relationship is handled with an additional relational table
 *                         which holds 2 foreign keys)
 *
 *
 * @package     Doctrine
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @category    Object Relational Mapping
 * @link        www.phpdoctrine.com
 * @since       1.0
 * @version     $Revision$
 * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
 */
class Doctrine_Relation_Association extends Doctrine_Relation
{
    /**
     * @var Doctrine_Table $associationTable
     */
    protected $associationTable;
    /**
     * the constructor
     * @param Doctrine_Table $table                 foreign factory object
     * @param Doctrine_Table $associationTable      factory which handles the association
     * @param string $local                         local field name
     * @param string $foreign                       foreign field name
     * @param integer $type                         type of relation
     * @see Doctrine_Table constants
     */
    public function __construct(Doctrine_Table $table, Doctrine_Table $associationTable, $local, $foreign, $type, $alias)
    {
        parent::__construct($table, $local, $foreign, $type, $alias);
        $this->associationTable = $associationTable;
    }
    /**
     * @return Doctrine_Table
     */
    public function getAssociationFactory()
    {
        return $this->associationTable;
    }
    /**
     * processDiff
     *
     * @param Doctrine_Record
     */
    public function processDiff(Doctrine_Record $record)
    {
        $asf     = $this->getAssociationFactory();
        $alias   = $this->getAlias();

        if ($record->hasReference($alias)) {
            $new = $record->obtainReference($alias);

            if ( ! $record->obtainOriginals($alias)) {
                $record->loadReference($alias);
            }
            $operations = Doctrine_Relation::getDeleteOperations($record->obtainOriginals($alias), $new);

            foreach ($operations as $r) {
                $query = 'DELETE FROM ' . $asf->getTableName()
                       . ' WHERE '      . $this->getForeign() . ' = ?'
                       . ' AND '        . $this->getLocal()   . ' = ?';

                $this->getTable()->getConnection()->execute($query, array($r->getIncremented(),$record->getIncremented()));
            }

            $operations = Doctrine_Relation::getInsertOperations($record->obtainOriginals($alias),$new);

            foreach ($operations as $r) {
                $reldao = $asf->create();
                $reldao->set($this->getForeign(), $r);
                $reldao->set($this->getLocal(), $record);
                $reldao->save();
            }

            $record->assignOriginals($alias, clone $record->get($alias));
        }
    }
    /**
     * getRelationDql
     *
     * @param integer $count
     * @return string
     */
    public function getRelationDql($count, $context = 'record')
    {
        switch ($context) {
            case "record":
                $sub    = 'SQL:SELECT ' . $this->foreign.
                          ' FROM '  . $this->associationTable->getTableName().
                          ' WHERE ' . $this->local.
                          ' IN ('   . substr(str_repeat("?, ", $count),0,-2) .
                          ')';

                $dql  = "FROM ".$this->table->getComponentName();
                $dql .= ".".$this->associationTable->getComponentName();
                $dql .= " WHERE ".$this->table->getComponentName().".".$this->table->getIdentifier()." IN ($sub)";
                break;
            case "collection":
                $sub  = substr(str_repeat("?, ", $count),0,-2);
                $dql  = "FROM ".$this->associationTable->getComponentName().".".$this->table->getComponentName();
                $dql .= " WHERE ".$this->associationTable->getComponentName().".".$this->local." IN ($sub)";
        };

        return $dql;
    }
    /**
     * fetchRelatedFor
     *
     * fetches a component related to given record
     *
     * @param Doctrine_Record $record
     * @return Doctrine_Record|Doctrine_Collection
     */
    public function fetchRelatedFor(Doctrine_Record $record)
    {
        $id      = $record->getIncremented();
        if (empty($id)) {
            $coll = new Doctrine_Collection($this->table);
        } else {
            $coll = Doctrine_Query::create()->parseQuery($this->getRelationDql(1))->execute(array($id));
        }
        return $coll;
    }
}