1
0
mirror of synced 2024-12-13 14:56:01 +03:00
doctrine2/lib/Doctrine/ORM/Mapping/OneToOneMapping.php

210 lines
7.2 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
/**
* A one-to-one mapping describes a uni-directional mapping from one entity
* to another entity.
*
* <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
* @since 2.0
* @author Roman Borschel <roman@code-factory.org>
* @author Giorgio Sironi <piccoloprincipeazzurro@gmail.com>
2008-09-12 13:27:03 +04:00
*/
class OneToOneMapping extends AssociationMapping
2008-09-12 13:27:03 +04:00
{
/**
* Maps the source foreign/primary key columns to the target primary/foreign key columns.
* i.e. source.id (pk) => target.user_id (fk).
* Reverse mapping of _targetToSourceKeyColumns.
*/
public $sourceToTargetKeyColumns = array();
2008-09-12 13:27:03 +04:00
/**
* Maps the target primary/foreign key columns to the source foreign/primary key columns.
* i.e. target.user_id (fk) => source.id (pk).
* Reverse mapping of _sourceToTargetKeyColumns.
*/
public $targetToSourceKeyColumns = array();
2008-09-12 13:27:03 +04:00
/**
* Whether to delete orphaned elements (when nulled out, i.e. $foo->other = null)
*
* @var boolean
*/
public $deleteOrphans = false;
/**
* The join column definitions.
*
* @var array
*/
public $joinColumns = array();
2008-09-12 13:27:03 +04:00
public $joinColumnFieldNames = array();
2008-09-12 13:27:03 +04:00
/**
* Creates a new OneToOneMapping.
*
* @param array $mapping The mapping info.
*/
public function __construct(array $mapping)
{
parent::__construct($mapping);
}
/**
* {@inheritdoc}
2008-09-12 13:27:03 +04:00
*
* @param array $mapping The mapping to validate & complete.
* @return array The validated & completed mapping.
* @override
*/
protected function _validateAndCompleteMapping(array $mapping)
{
parent::_validateAndCompleteMapping($mapping);
if (isset($mapping['joinColumns']) && $mapping['joinColumns']) {
$this->isOwningSide = true;
}
if ($this->isOwningSide) {
2008-09-12 13:27:03 +04:00
if ( ! isset($mapping['joinColumns'])) {
throw MappingException::invalidMapping($this->sourceFieldName);
}
$this->joinColumns = $mapping['joinColumns'];
foreach ($mapping['joinColumns'] as $joinColumn) {
$this->sourceToTargetKeyColumns[$joinColumn['name']] = $joinColumn['referencedColumnName'];
$this->joinColumnFieldNames[$joinColumn['name']] = isset($joinColumn['fieldName'])
? $joinColumn['fieldName'] : $joinColumn['name'];
2008-09-12 13:27:03 +04:00
}
$this->targetToSourceKeyColumns = array_flip($this->sourceToTargetKeyColumns);
2008-09-12 13:27:03 +04:00
}
$this->deleteOrphans = isset($mapping['deleteOrphans']) ?
2008-09-12 13:27:03 +04:00
(bool)$mapping['deleteOrphans'] : false;
return $mapping;
}
/**
* Gets the join column definitions for this mapping.
*
* @return array
*/
public function getJoinColumns()
{
return $this->joinColumns;
}
2008-09-12 13:27:03 +04:00
/**
* Gets the source-to-target key column mapping.
*
* @return array
2008-09-12 13:27:03 +04:00
*/
public function getSourceToTargetKeyColumns()
{
return $this->sourceToTargetKeyColumns;
2008-09-12 13:27:03 +04:00
}
/**
* Gets the target-to-source key column mapping.
*
* @return array
2008-09-12 13:27:03 +04:00
*/
public function getTargetToSourceKeyColumns()
{
return $this->targetToSourceKeyColumns;
2008-09-12 13:27:03 +04:00
}
/**
* {@inheritdoc}
2008-09-12 13:27:03 +04:00
*
* @return boolean
* @override
*/
public function isOneToOne()
{
return true;
}
/**
* {@inheritdoc}
2008-09-12 13:27:03 +04:00
*
* @param object $sourceEntity the entity source of this association
* @param object $targetEntity the entity to load data in
* @param EntityManager $em
* @param array $joinColumnValues values of the join columns of $sourceEntity. There are no fields
* to store this data in $sourceEntity
2008-09-12 13:27:03 +04:00
*/
public function load($sourceEntity, $targetEntity, $em, array $joinColumnValues)
2008-09-12 13:27:03 +04:00
{
$sourceClass = $em->getClassMetadata($this->sourceEntityName);
$targetClass = $em->getClassMetadata($this->targetEntityName);
2008-09-12 13:27:03 +04:00
$conditions = array();
if ($this->isOwningSide) {
foreach ($this->sourceToTargetKeyColumns as $sourceKeyColumn => $targetKeyColumn) {
// getting customer_id
if (isset($sourceClass->reflFields[$sourceKeyColumn])) {
$conditions[$targetKeyColumn] = $this->_getPrivateValue($sourceClass, $sourceEntity, $sourceKeyColumn);
} else {
$conditions[$targetKeyColumn] = $joinColumnValues[$sourceKeyColumn];
}
}
if ($targetClass->hasInverseAssociationMapping($this->sourceFieldName)) {
$targetClass->setFieldValue(
$targetEntity,
$targetClass->inverseMappings[$this->sourceFieldName]->getSourceFieldName(),
$sourceEntity);
}
} else {
$owningAssoc = $em->getClassMetadata($this->targetEntityName)->getAssociationMapping($this->mappedByFieldName);
foreach ($owningAssoc->getTargetToSourceKeyColumns() as $targetKeyColumn => $sourceKeyColumn) {
// getting id
if (isset($sourceClass->reflFields[$targetKeyColumn])) {
$conditions[$sourceKeyColumn] = $this->_getPrivateValue($sourceClass, $sourceEntity, $targetKeyColumn);
} else {
$conditions[$sourceKeyColumn] = $joinColumnValues[$targetKeyColumn];
}
}
$targetClass->setFieldValue($targetEntity, $this->mappedByFieldName, $sourceEntity);
2008-09-12 13:27:03 +04:00
}
$em->getUnitOfWork()->getEntityPersister($this->targetEntityName)->load($conditions, $targetEntity);
2008-09-12 13:27:03 +04:00
}
protected function _getPrivateValue(ClassMetadata $class, $entity, $column)
{
$reflField = $class->getReflectionProperty($class->getFieldName($column));
return $reflField->getValue($entity);
}
2009-07-17 17:41:03 +04:00
}