1
0
mirror of synced 2024-12-13 22:56:04 +03:00
doctrine2/lib/Doctrine/ORM/Mapping/AssociationMapping.php

417 lines
11 KiB
PHP
Raw Normal View History

2008-09-12 13:27:03 +04:00
<?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.doctrine-project.org>.
2008-09-12 13:27:03 +04:00
*/
namespace Doctrine\ORM\Mapping;
2008-09-12 13:27:03 +04:00
/**
* Base class for association mappings.
*
* <b>IMPORTANT NOTE:</b>
*
* The fields of this class are only public for 2 reasons:
* 1) To allow fast, internal READ access.
* 2) To drastically reduce the size of a serialized instance (private/protected members
* get the whole class name, namespace inclusive, prepended to every property in
* the serialized representation).
*
2008-09-12 13:27:03 +04:00
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
*/
abstract class AssociationMapping
2008-09-12 13:27:03 +04:00
{
2009-07-21 19:53:58 +04:00
/**
* Specifies that an association is to be fetched when it is first accessed.
*
* @var integer
*/
2008-09-12 13:27:03 +04:00
const FETCH_LAZY = 2;
2009-07-21 19:53:58 +04:00
/**
* Specifies that an association is to be fetched when the owner of the
* association is fetched.
*
* @var integer
*/
2008-09-12 13:27:03 +04:00
const FETCH_EAGER = 3;
/**
* Cascade types enumeration.
*
* @var array
*/
protected static $_cascadeTypes = array(
'all', 'none', 'save', 'delete', 'refresh', 'merge'
2008-09-12 13:27:03 +04:00
);
public $cascades = array();
public $isCascadeRemove;
public $isCascadePersist;
public $isCascadeRefresh;
public $isCascadeMerge;
public $isCascadeDetach;
2008-09-12 13:27:03 +04:00
/**
* The fetch mode used for the association.
*
* @var integer
*/
2009-07-21 19:53:58 +04:00
public $fetchMode = self::FETCH_LAZY;
2008-09-12 13:27:03 +04:00
/**
* Flag that indicates whether the class that defines this mapping is
* the owning side of the association.
*
* @var boolean
*/
public $isOwningSide = true;
2008-09-12 13:27:03 +04:00
/**
* Whether the association is optional (0..X) or not (1..X).
* By default all associations are optional.
*
* @var boolean
*/
public $isOptional = true;
2008-09-12 13:27:03 +04:00
/**
* The name of the source Entity (the Entity that defines this mapping).
*
* @var string
*/
public $sourceEntityName;
2008-09-12 13:27:03 +04:00
/**
* The name of the target Entity (the Enitity that is the target of the
* association).
*
* @var string
*/
public $targetEntityName;
2008-09-12 13:27:03 +04:00
/**
* Identifies the field on the source class (the class this AssociationMapping
* belongs to) that represents the association and stores the reference to the
* other entity/entities.
*
* @var string
*/
public $sourceFieldName;
2008-09-12 13:27:03 +04:00
/**
* Identifies the field on the owning side that controls the mapping for the
* association. This is only set on the inverse side of an association.
*
* @var string
*/
public $mappedByFieldName;
2008-09-12 13:27:03 +04:00
/**
* The join table definition, if any.
2008-09-12 13:27:03 +04:00
*
* @var array
2008-09-12 13:27:03 +04:00
*/
public $joinTable = array();
//protected $_joinTableInsertSql;
2008-09-12 13:27:03 +04:00
/**
* Initializes a new instance of a class derived from AssociationMapping.
2008-09-12 13:27:03 +04:00
*
* @param array $mapping The mapping definition.
*/
public function __construct(array $mapping)
{
$this->_validateAndCompleteMapping($mapping);
}
/**
* Validates & completes the mapping. Mapping defaults are applied here.
*
* @param array $mapping
*/
protected function _validateAndCompleteMapping(array $mapping)
{
// Mandatory attributes for both sides
if ( ! isset($mapping['fieldName'])) {
throw MappingException::missingFieldName();
2008-09-12 13:27:03 +04:00
}
$this->sourceFieldName = $mapping['fieldName'];
2008-09-12 13:27:03 +04:00
if ( ! isset($mapping['sourceEntity'])) {
throw MappingException::missingSourceEntity($mapping['fieldName']);
2008-09-12 13:27:03 +04:00
}
$this->sourceEntityName = $mapping['sourceEntity'];
2008-09-12 13:27:03 +04:00
if ( ! isset($mapping['targetEntity'])) {
throw MappingException::missingTargetEntity($mapping['fieldName']);
2008-09-12 13:27:03 +04:00
}
$this->targetEntityName = $mapping['targetEntity'];
2008-09-12 13:27:03 +04:00
// Mandatory and optional attributes for either side
if ( ! isset($mapping['mappedBy'])) {
// Optional
if (isset($mapping['joinTable'])) {
if ($mapping['joinTable']['name'][0] == '`') {
$mapping['joinTable']['name'] = trim($mapping['joinTable']['name'], '`');
$mapping['joinTable']['quoted'] = true;
}
$this->joinTable = $mapping['joinTable'];
2008-09-12 13:27:03 +04:00
}
} else {
$this->isOwningSide = false;
$this->mappedByFieldName = $mapping['mappedBy'];
2008-09-12 13:27:03 +04:00
}
// Optional attributes for both sides
$this->isOptional = isset($mapping['optional']) ?
2008-09-12 13:27:03 +04:00
(bool)$mapping['optional'] : true;
$this->cascades = isset($mapping['cascade']) ?
2008-09-12 13:27:03 +04:00
(array)$mapping['cascade'] : array();
$this->isCascadeRemove = in_array('remove', $this->cascades);
$this->isCascadePersist = in_array('persist', $this->cascades);
$this->isCascadeRefresh = in_array('refresh', $this->cascades);
$this->isCascadeMerge = in_array('merge', $this->cascades);
$this->isCascadeDetach = in_array('detach', $this->cascades);
2008-09-12 13:27:03 +04:00
}
/**
* Whether the association cascades delete() operations from the source entity
* to the target entity/entities.
*
* @return boolean
*/
public function isCascadeRemove()
2008-09-12 13:27:03 +04:00
{
return $this->isCascadeRemove;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the association cascades save() operations from the source entity
* to the target entity/entities.
*
* @return boolean
*/
public function isCascadePersist()
2008-09-12 13:27:03 +04:00
{
return $this->isCascadePersist;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the association cascades refresh() operations from the source entity
* to the target entity/entities.
*
* @return boolean
*/
public function isCascadeRefresh()
{
return $this->isCascadeRefresh;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the association cascades merge() operations from the source entity
* to the target entity/entities.
*
* @return boolean
*/
public function isCascadeMerge()
{
return $this->isCascadeMerge;
}
2008-09-12 13:27:03 +04:00
/**
* Whether the association cascades detach() operations from the source entity
* to the target entity/entities.
*
* @return boolean
*/
public function isCascadeDetach()
{
return $this->isCascadeDetach;
}
2008-09-12 13:27:03 +04:00
/**
* Whether the target entity/entities of the association are eagerly fetched.
*
* @return boolean
*/
public function isEagerlyFetched()
{
return $this->fetchMode == self::FETCH_EAGER;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the target entity/entities of the association are lazily fetched.
*
* @return boolean
*/
public function isLazilyFetched()
{
return $this->fetchMode == self::FETCH_LAZY;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the source entity of this association represents the owning side.
*
* @return boolean
*/
public function isOwningSide()
{
return $this->isOwningSide;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the source entity of this association represents the inverse side.
*
* @return boolean
*/
public function isInverseSide()
{
return ! $this->isOwningSide;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the association is optional (0..X), or not (1..X).
*
* @return boolean TRUE if the association is optional, FALSE otherwise.
* @todo Only applicable to OneToOne. Move there.
2008-09-12 13:27:03 +04:00
*/
public function isOptional()
{
return $this->isOptional;
2008-09-12 13:27:03 +04:00
}
/**
* Gets the name of the source entity class.
*
* @return string
*/
public function getSourceEntityName()
{
return $this->sourceEntityName;
2008-09-12 13:27:03 +04:00
}
/**
* Gets the name of the target entity class.
*
* @return string
*/
public function getTargetEntityName()
{
return $this->targetEntityName;
2008-09-12 13:27:03 +04:00
}
/**
* Gets the join table definition, if any.
2008-09-12 13:27:03 +04:00
*
* @return array
2008-09-12 13:27:03 +04:00
*/
public function getJoinTable()
{
return $this->joinTable;
2008-09-12 13:27:03 +04:00
}
/**
* Get the name of the field the association is mapped into.
*
* @return string
*/
public function getSourceFieldName()
{
return $this->sourceFieldName;
2008-09-12 13:27:03 +04:00
}
/**
* Gets the field name of the owning side in a bi-directional association.
* This is only set on the inverse side. When invoked on the owning side,
* NULL is returned.
2008-09-12 13:27:03 +04:00
*
* @return string
*/
public function getMappedByFieldName()
{
return $this->mappedByFieldName;
2008-09-12 13:27:03 +04:00
}
/**
* Whether the association is a one-to-one association.
*
* @return boolean
*/
2008-09-12 13:27:03 +04:00
public function isOneToOne()
{
return false;
}
/**
* Whether the association is a one-to-many association.
*
* @return boolean
*/
2008-09-12 13:27:03 +04:00
public function isOneToMany()
{
return false;
}
/**
* Whether the association is a many-to-many association.
*
* @return boolean
*/
2008-09-12 13:27:03 +04:00
public function isManyToMany()
{
return false;
}
/**
* Whether the association uses a join table for the mapping.
*
* @return boolean
*/
public function usesJoinTable()
{
return (bool) $this->joinTable;
}
/**
* Loads data in $target domain object using this association.
* The data comes from the association navigated from $sourceEntity
* using $em.
*
* @param object $sourceEntity
* @param object $target an entity or a collection
* @param EntityManager $em
* @param array $joinColumnValues foreign keys (significative for this
* association) of $sourceEntity, if needed
*/
abstract public function load($sourceEntity, $target, $em, array $joinColumnValues = array());
/**
*
* @param $platform
* @return unknown_type
*/
public function getQuotedJoinTableName($platform)
{
return isset($this->joinTable['quoted']) ?
$platform->quoteIdentifier($this->joinTable['name']) :
$this->joinTable['name'];
}
}