12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269 |
- <?php
- /*
- * 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 MIT license. For more information, see
- * <http://www.doctrine-project.org>.
- */
- namespace Doctrine\ORM;
- use Exception;
- use InvalidArgumentException;
- use UnexpectedValueException;
- use Doctrine\Common\Collections\ArrayCollection;
- use Doctrine\Common\Collections\Collection;
- use Doctrine\Common\NotifyPropertyChanged;
- use Doctrine\Common\PropertyChangedListener;
- use Doctrine\Common\Persistence\ObjectManagerAware;
- use Doctrine\ORM\Mapping\ClassMetadata;
- use Doctrine\ORM\Proxy\Proxy;
- use Doctrine\ORM\Event\LifecycleEventArgs;
- use Doctrine\ORM\Event\PreUpdateEventArgs;
- use Doctrine\ORM\Event\PreFlushEventArgs;
- use Doctrine\ORM\Event\OnFlushEventArgs;
- use Doctrine\ORM\Event\PostFlushEventArgs;
- use Doctrine\ORM\Event\ListenersInvoker;
- /**
- * The UnitOfWork is responsible for tracking changes to objects during an
- * "object-level" transaction and for writing out changes to the database
- * in the correct order.
- *
- * @since 2.0
- * @author Benjamin Eberlei <kontakt@beberlei.de>
- * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
- * @author Jonathan Wage <jonwage@gmail.com>
- * @author Roman Borschel <roman@code-factory.org>
- * @internal This class contains highly performance-sensitive code.
- */
- class UnitOfWork implements PropertyChangedListener
- {
- /**
- * An entity is in MANAGED state when its persistence is managed by an EntityManager.
- */
- const STATE_MANAGED = 1;
- /**
- * An entity is new if it has just been instantiated (i.e. using the "new" operator)
- * and is not (yet) managed by an EntityManager.
- */
- const STATE_NEW = 2;
- /**
- * A detached entity is an instance with persistent state and identity that is not
- * (or no longer) associated with an EntityManager (and a UnitOfWork).
- */
- const STATE_DETACHED = 3;
- /**
- * A removed entity instance is an instance with a persistent identity,
- * associated with an EntityManager, whose persistent state will be deleted
- * on commit.
- */
- const STATE_REMOVED = 4;
- /**
- * Hint used to collect all primary keys of associated entities during hydration
- * and execute it in a dedicated query afterwards
- * @see https://doctrine-orm.readthedocs.org/en/latest/reference/dql-doctrine-query-language.html?highlight=eager#temporarily-change-fetch-mode-in-dql
- */
- const HINT_DEFEREAGERLOAD = 'deferEagerLoad';
- /**
- * The identity map that holds references to all managed entities that have
- * an identity. The entities are grouped by their class name.
- * Since all classes in a hierarchy must share the same identifier set,
- * we always take the root class name of the hierarchy.
- *
- * @var array
- */
- private $identityMap = array();
- /**
- * Map of all identifiers of managed entities.
- * Keys are object ids (spl_object_hash).
- *
- * @var array
- */
- private $entityIdentifiers = array();
- /**
- * Map of the original entity data of managed entities.
- * Keys are object ids (spl_object_hash). This is used for calculating changesets
- * at commit time.
- *
- * @var array
- * @internal Note that PHPs "copy-on-write" behavior helps a lot with memory usage.
- * A value will only really be copied if the value in the entity is modified
- * by the user.
- */
- private $originalEntityData = array();
- /**
- * Map of entity changes. Keys are object ids (spl_object_hash).
- * Filled at the beginning of a commit of the UnitOfWork and cleaned at the end.
- *
- * @var array
- */
- private $entityChangeSets = array();
- /**
- * The (cached) states of any known entities.
- * Keys are object ids (spl_object_hash).
- *
- * @var array
- */
- private $entityStates = array();
- /**
- * Map of entities that are scheduled for dirty checking at commit time.
- * This is only used for entities with a change tracking policy of DEFERRED_EXPLICIT.
- * Keys are object ids (spl_object_hash).
- *
- * @var array
- * @todo rename: scheduledForSynchronization
- */
- private $scheduledForDirtyCheck = array();
- /**
- * A list of all pending entity insertions.
- *
- * @var array
- */
- private $entityInsertions = array();
- /**
- * A list of all pending entity updates.
- *
- * @var array
- */
- private $entityUpdates = array();
- /**
- * Any pending extra updates that have been scheduled by persisters.
- *
- * @var array
- */
- private $extraUpdates = array();
- /**
- * A list of all pending entity deletions.
- *
- * @var array
- */
- private $entityDeletions = array();
- /**
- * All pending collection deletions.
- *
- * @var array
- */
- private $collectionDeletions = array();
- /**
- * All pending collection updates.
- *
- * @var array
- */
- private $collectionUpdates = array();
- /**
- * List of collections visited during changeset calculation on a commit-phase of a UnitOfWork.
- * At the end of the UnitOfWork all these collections will make new snapshots
- * of their data.
- *
- * @var array
- */
- private $visitedCollections = array();
- /**
- * The EntityManager that "owns" this UnitOfWork instance.
- *
- * @var \Doctrine\ORM\EntityManager
- */
- private $em;
- /**
- * The calculator used to calculate the order in which changes to
- * entities need to be written to the database.
- *
- * @var \Doctrine\ORM\Internal\CommitOrderCalculator
- */
- private $commitOrderCalculator;
- /**
- * The entity persister instances used to persist entity instances.
- *
- * @var array
- */
- private $persisters = array();
- /**
- * The collection persister instances used to persist collections.
- *
- * @var array
- */
- private $collectionPersisters = array();
- /**
- * The EventManager used for dispatching events.
- *
- * @var \Doctrine\Common\EventManager
- */
- private $evm;
- /**
- * The ListenersInvoker used for dispatching events.
- *
- * @var \Doctrine\ORM\Event\ListenersInvoker
- */
- private $listenersInvoker;
- /**
- * Orphaned entities that are scheduled for removal.
- *
- * @var array
- */
- private $orphanRemovals = array();
- /**
- * Read-Only objects are never evaluated
- *
- * @var array
- */
- private $readOnlyObjects = array();
- /**
- * Map of Entity Class-Names and corresponding IDs that should eager loaded when requested.
- *
- * @var array
- */
- private $eagerLoadingEntities = array();
- /**
- * Initializes a new UnitOfWork instance, bound to the given EntityManager.
- *
- * @param \Doctrine\ORM\EntityManager $em
- */
- public function __construct(EntityManager $em)
- {
- $this->em = $em;
- $this->evm = $em->getEventManager();
- $this->listenersInvoker = new ListenersInvoker($em);
- }
- /**
- * Commits the UnitOfWork, executing all operations that have been postponed
- * up to this point. The state of all managed entities will be synchronized with
- * the database.
- *
- * The operations are executed in the following order:
- *
- * 1) All entity insertions
- * 2) All entity updates
- * 3) All collection deletions
- * 4) All collection updates
- * 5) All entity deletions
- *
- * @param null|object|array $entity
- *
- * @return void
- *
- * @throws \Exception
- */
- public function commit($entity = null)
- {
- // Raise preFlush
- if ($this->evm->hasListeners(Events::preFlush)) {
- $this->evm->dispatchEvent(Events::preFlush, new PreFlushEventArgs($this->em));
- }
- // Compute changes done since last commit.
- if ($entity === null) {
- $this->computeChangeSets();
- } elseif (is_object($entity)) {
- $this->computeSingleEntityChangeSet($entity);
- } elseif (is_array($entity)) {
- foreach ($entity as $object) {
- $this->computeSingleEntityChangeSet($object);
- }
- }
- if ( ! ($this->entityInsertions ||
- $this->entityDeletions ||
- $this->entityUpdates ||
- $this->collectionUpdates ||
- $this->collectionDeletions ||
- $this->orphanRemovals)) {
- $this->dispatchOnFlushEvent();
- $this->dispatchPostFlushEvent();
- return; // Nothing to do.
- }
- if ($this->orphanRemovals) {
- foreach ($this->orphanRemovals as $orphan) {
- $this->remove($orphan);
- }
- }
- $this->dispatchOnFlushEvent();
- // Now we need a commit order to maintain referential integrity
- $commitOrder = $this->getCommitOrder();
- $conn = $this->em->getConnection();
- $conn->beginTransaction();
- try {
- if ($this->entityInsertions) {
- foreach ($commitOrder as $class) {
- $this->executeInserts($class);
- }
- }
- if ($this->entityUpdates) {
- foreach ($commitOrder as $class) {
- $this->executeUpdates($class);
- }
- }
- // Extra updates that were requested by persisters.
- if ($this->extraUpdates) {
- $this->executeExtraUpdates();
- }
- // Collection deletions (deletions of complete collections)
- foreach ($this->collectionDeletions as $collectionToDelete) {
- $this->getCollectionPersister($collectionToDelete->getMapping())->delete($collectionToDelete);
- }
- // Collection updates (deleteRows, updateRows, insertRows)
- foreach ($this->collectionUpdates as $collectionToUpdate) {
- $this->getCollectionPersister($collectionToUpdate->getMapping())->update($collectionToUpdate);
- }
- // Entity deletions come last and need to be in reverse commit order
- if ($this->entityDeletions) {
- for ($count = count($commitOrder), $i = $count - 1; $i >= 0; --$i) {
- $this->executeDeletions($commitOrder[$i]);
- }
- }
- $conn->commit();
- } catch (Exception $e) {
- $this->em->close();
- $conn->rollback();
- throw $e;
- }
- // Take new snapshots from visited collections
- foreach ($this->visitedCollections as $coll) {
- $coll->takeSnapshot();
- }
- $this->dispatchPostFlushEvent();
- // Clear up
- $this->entityInsertions =
- $this->entityUpdates =
- $this->entityDeletions =
- $this->extraUpdates =
- $this->entityChangeSets =
- $this->collectionUpdates =
- $this->collectionDeletions =
- $this->visitedCollections =
- $this->scheduledForDirtyCheck =
- $this->orphanRemovals = array();
- }
- /**
- * Computes the changesets of all entities scheduled for insertion.
- *
- * @return void
- */
- private function computeScheduleInsertsChangeSets()
- {
- foreach ($this->entityInsertions as $entity) {
- $class = $this->em->getClassMetadata(get_class($entity));
- $this->computeChangeSet($class, $entity);
- }
- }
- /**
- * Only flushes the given entity according to a ruleset that keeps the UoW consistent.
- *
- * 1. All entities scheduled for insertion, (orphan) removals and changes in collections are processed as well!
- * 2. Read Only entities are skipped.
- * 3. Proxies are skipped.
- * 4. Only if entity is properly managed.
- *
- * @param object $entity
- *
- * @return void
- *
- * @throws \InvalidArgumentException
- */
- private function computeSingleEntityChangeSet($entity)
- {
- $state = $this->getEntityState($entity);
- if ($state !== self::STATE_MANAGED && $state !== self::STATE_REMOVED) {
- throw new \InvalidArgumentException("Entity has to be managed or scheduled for removal for single computation " . self::objToStr($entity));
- }
- $class = $this->em->getClassMetadata(get_class($entity));
- if ($state === self::STATE_MANAGED && $class->isChangeTrackingDeferredImplicit()) {
- $this->persist($entity);
- }
- // Compute changes for INSERTed entities first. This must always happen even in this case.
- $this->computeScheduleInsertsChangeSets();
- if ($class->isReadOnly) {
- return;
- }
- // Ignore uninitialized proxy objects
- if ($entity instanceof Proxy && ! $entity->__isInitialized__) {
- return;
- }
- // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION are processed here.
- $oid = spl_object_hash($entity);
- if ( ! isset($this->entityInsertions[$oid]) && isset($this->entityStates[$oid])) {
- $this->computeChangeSet($class, $entity);
- }
- }
- /**
- * Executes any extra updates that have been scheduled.
- */
- private function executeExtraUpdates()
- {
- foreach ($this->extraUpdates as $oid => $update) {
- list ($entity, $changeset) = $update;
- $this->entityChangeSets[$oid] = $changeset;
- $this->getEntityPersister(get_class($entity))->update($entity);
- }
- }
- /**
- * Gets the changeset for an entity.
- *
- * @param object $entity
- *
- * @return array
- */
- public function getEntityChangeSet($entity)
- {
- $oid = spl_object_hash($entity);
- if (isset($this->entityChangeSets[$oid])) {
- return $this->entityChangeSets[$oid];
- }
- return array();
- }
- /**
- * Computes the changes that happened to a single entity.
- *
- * Modifies/populates the following properties:
- *
- * {@link _originalEntityData}
- * If the entity is NEW or MANAGED but not yet fully persisted (only has an id)
- * then it was not fetched from the database and therefore we have no original
- * entity data yet. All of the current entity data is stored as the original entity data.
- *
- * {@link _entityChangeSets}
- * The changes detected on all properties of the entity are stored there.
- * A change is a tuple array where the first entry is the old value and the second
- * entry is the new value of the property. Changesets are used by persisters
- * to INSERT/UPDATE the persistent entity state.
- *
- * {@link _entityUpdates}
- * If the entity is already fully MANAGED (has been fetched from the database before)
- * and any changes to its properties are detected, then a reference to the entity is stored
- * there to mark it for an update.
- *
- * {@link _collectionDeletions}
- * If a PersistentCollection has been de-referenced in a fully MANAGED entity,
- * then this collection is marked for deletion.
- *
- * @ignore
- *
- * @internal Don't call from the outside.
- *
- * @param ClassMetadata $class The class descriptor of the entity.
- * @param object $entity The entity for which to compute the changes.
- *
- * @return void
- */
- public function computeChangeSet(ClassMetadata $class, $entity)
- {
- $oid = spl_object_hash($entity);
- if (isset($this->readOnlyObjects[$oid])) {
- return;
- }
- if ( ! $class->isInheritanceTypeNone()) {
- $class = $this->em->getClassMetadata(get_class($entity));
- }
- $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::preFlush) & ~ListenersInvoker::INVOKE_MANAGER;
- if ($invoke !== ListenersInvoker::INVOKE_NONE) {
- $this->listenersInvoker->invoke($class, Events::preFlush, $entity, new PreFlushEventArgs($this->em), $invoke);
- }
- $actualData = array();
- foreach ($class->reflFields as $name => $refProp) {
- $value = $refProp->getValue($entity);
- if ($class->isCollectionValuedAssociation($name) && $value !== null) {
- if ($value instanceof PersistentCollection) {
- if ($value->getOwner() === $entity) {
- continue;
- }
- $value = new ArrayCollection($value->getValues());
- }
- // If $value is not a Collection then use an ArrayCollection.
- if ( ! $value instanceof Collection) {
- $value = new ArrayCollection($value);
- }
- $assoc = $class->associationMappings[$name];
- // Inject PersistentCollection
- $value = new PersistentCollection(
- $this->em, $this->em->getClassMetadata($assoc['targetEntity']), $value
- );
- $value->setOwner($entity, $assoc);
- $value->setDirty( ! $value->isEmpty());
- $class->reflFields[$name]->setValue($entity, $value);
- $actualData[$name] = $value;
- continue;
- }
- if (( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity()) && ($name !== $class->versionField)) {
- $actualData[$name] = $value;
- }
- }
- if ( ! isset($this->originalEntityData[$oid])) {
- // Entity is either NEW or MANAGED but not yet fully persisted (only has an id).
- // These result in an INSERT.
- $this->originalEntityData[$oid] = $actualData;
- $changeSet = array();
- foreach ($actualData as $propName => $actualValue) {
- if ( ! isset($class->associationMappings[$propName])) {
- $changeSet[$propName] = array(null, $actualValue);
- continue;
- }
- $assoc = $class->associationMappings[$propName];
- if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
- $changeSet[$propName] = array(null, $actualValue);
- }
- }
- $this->entityChangeSets[$oid] = $changeSet;
- } else {
- // Entity is "fully" MANAGED: it was already fully persisted before
- // and we have a copy of the original data
- $originalData = $this->originalEntityData[$oid];
- $isChangeTrackingNotify = $class->isChangeTrackingNotify();
- $changeSet = ($isChangeTrackingNotify && isset($this->entityChangeSets[$oid]))
- ? $this->entityChangeSets[$oid]
- : array();
- foreach ($actualData as $propName => $actualValue) {
- // skip field, its a partially omitted one!
- if ( ! (isset($originalData[$propName]) || array_key_exists($propName, $originalData))) {
- continue;
- }
- $orgValue = $originalData[$propName];
- // skip if value haven't changed
- if ($orgValue === $actualValue) {
- continue;
- }
- // if regular field
- if ( ! isset($class->associationMappings[$propName])) {
- if ($isChangeTrackingNotify) {
- continue;
- }
- $changeSet[$propName] = array($orgValue, $actualValue);
- continue;
- }
- $assoc = $class->associationMappings[$propName];
- // Persistent collection was exchanged with the "originally"
- // created one. This can only mean it was cloned and replaced
- // on another entity.
- if ($actualValue instanceof PersistentCollection) {
- $owner = $actualValue->getOwner();
- if ($owner === null) { // cloned
- $actualValue->setOwner($entity, $assoc);
- } else if ($owner !== $entity) { // no clone, we have to fix
- if (!$actualValue->isInitialized()) {
- $actualValue->initialize(); // we have to do this otherwise the cols share state
- }
- $newValue = clone $actualValue;
- $newValue->setOwner($entity, $assoc);
- $class->reflFields[$propName]->setValue($entity, $newValue);
- }
- }
- if ($orgValue instanceof PersistentCollection) {
- // A PersistentCollection was de-referenced, so delete it.
- $coid = spl_object_hash($orgValue);
- if (isset($this->collectionDeletions[$coid])) {
- continue;
- }
- $this->collectionDeletions[$coid] = $orgValue;
- $changeSet[$propName] = $orgValue; // Signal changeset, to-many assocs will be ignored.
- continue;
- }
- if ($assoc['type'] & ClassMetadata::TO_ONE) {
- if ($assoc['isOwningSide']) {
- $changeSet[$propName] = array($orgValue, $actualValue);
- }
- if ($orgValue !== null && $assoc['orphanRemoval']) {
- $this->scheduleOrphanRemoval($orgValue);
- }
- }
- }
- if ($changeSet) {
- $this->entityChangeSets[$oid] = $changeSet;
- $this->originalEntityData[$oid] = $actualData;
- $this->entityUpdates[$oid] = $entity;
- }
- }
- // Look for changes in associations of the entity
- foreach ($class->associationMappings as $field => $assoc) {
- if (($val = $class->reflFields[$field]->getValue($entity)) !== null) {
- $this->computeAssociationChanges($assoc, $val);
- if (!isset($this->entityChangeSets[$oid]) &&
- $assoc['isOwningSide'] &&
- $assoc['type'] == ClassMetadata::MANY_TO_MANY &&
- $val instanceof PersistentCollection &&
- $val->isDirty()) {
- $this->entityChangeSets[$oid] = array();
- $this->originalEntityData[$oid] = $actualData;
- $this->entityUpdates[$oid] = $entity;
- }
- }
- }
- }
- /**
- * Computes all the changes that have been done to entities and collections
- * since the last commit and stores these changes in the _entityChangeSet map
- * temporarily for access by the persisters, until the UoW commit is finished.
- *
- * @return void
- */
- public function computeChangeSets()
- {
- // Compute changes for INSERTed entities first. This must always happen.
- $this->computeScheduleInsertsChangeSets();
- // Compute changes for other MANAGED entities. Change tracking policies take effect here.
- foreach ($this->identityMap as $className => $entities) {
- $class = $this->em->getClassMetadata($className);
- // Skip class if instances are read-only
- if ($class->isReadOnly) {
- continue;
- }
- // If change tracking is explicit or happens through notification, then only compute
- // changes on entities of that type that are explicitly marked for synchronization.
- switch (true) {
- case ($class->isChangeTrackingDeferredImplicit()):
- $entitiesToProcess = $entities;
- break;
- case (isset($this->scheduledForDirtyCheck[$className])):
- $entitiesToProcess = $this->scheduledForDirtyCheck[$className];
- break;
- default:
- $entitiesToProcess = array();
- }
- foreach ($entitiesToProcess as $entity) {
- // Ignore uninitialized proxy objects
- if ($entity instanceof Proxy && ! $entity->__isInitialized__) {
- continue;
- }
- // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION are processed here.
- $oid = spl_object_hash($entity);
- if ( ! isset($this->entityInsertions[$oid]) && isset($this->entityStates[$oid])) {
- $this->computeChangeSet($class, $entity);
- }
- }
- }
- }
- /**
- * Computes the changes of an association.
- *
- * @param array $assoc
- * @param mixed $value The value of the association.
- *
- * @throws ORMInvalidArgumentException
- * @throws ORMException
- *
- * @return void
- */
- private function computeAssociationChanges($assoc, $value)
- {
- if ($value instanceof Proxy && ! $value->__isInitialized__) {
- return;
- }
- if ($value instanceof PersistentCollection && $value->isDirty()) {
- $coid = spl_object_hash($value);
- if ($assoc['isOwningSide']) {
- $this->collectionUpdates[$coid] = $value;
- }
- $this->visitedCollections[$coid] = $value;
- }
- // Look through the entities, and in any of their associations,
- // for transient (new) entities, recursively. ("Persistence by reachability")
- // Unwrap. Uninitialized collections will simply be empty.
- $unwrappedValue = ($assoc['type'] & ClassMetadata::TO_ONE) ? array($value) : $value->unwrap();
- $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
- foreach ($unwrappedValue as $key => $entry) {
- $state = $this->getEntityState($entry, self::STATE_NEW);
- if ( ! ($entry instanceof $assoc['targetEntity'])) {
- throw new ORMException(
- sprintf(
- 'Found entity of type %s on association %s#%s, but expecting %s',
- get_class($entry),
- $assoc['sourceEntity'],
- $assoc['fieldName'],
- $targetClass->name
- )
- );
- }
- switch ($state) {
- case self::STATE_NEW:
- if ( ! $assoc['isCascadePersist']) {
- throw ORMInvalidArgumentException::newEntityFoundThroughRelationship($assoc, $entry);
- }
- $this->persistNew($targetClass, $entry);
- $this->computeChangeSet($targetClass, $entry);
- break;
- case self::STATE_REMOVED:
- // Consume the $value as array (it's either an array or an ArrayAccess)
- // and remove the element from Collection.
- if ($assoc['type'] & ClassMetadata::TO_MANY) {
- unset($value[$key]);
- }
- break;
- case self::STATE_DETACHED:
- // Can actually not happen right now as we assume STATE_NEW,
- // so the exception will be raised from the DBAL layer (constraint violation).
- throw ORMInvalidArgumentException::detachedEntityFoundThroughRelationship($assoc, $entry);
- break;
- default:
- // MANAGED associated entities are already taken into account
- // during changeset calculation anyway, since they are in the identity map.
- }
- }
- }
- /**
- * @param \Doctrine\ORM\Mapping\ClassMetadata $class
- * @param object $entity
- *
- * @return void
- */
- private function persistNew($class, $entity)
- {
- $oid = spl_object_hash($entity);
- $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::prePersist);
- if ($invoke !== ListenersInvoker::INVOKE_NONE) {
- $this->listenersInvoker->invoke($class, Events::prePersist, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
- }
- $idGen = $class->idGenerator;
- if ( ! $idGen->isPostInsertGenerator()) {
- $idValue = $idGen->generate($this->em, $entity);
- if ( ! $idGen instanceof \Doctrine\ORM\Id\AssignedGenerator) {
- $idValue = array($class->identifier[0] => $idValue);
- $class->setIdentifierValues($entity, $idValue);
- }
- $this->entityIdentifiers[$oid] = $idValue;
- }
- $this->entityStates[$oid] = self::STATE_MANAGED;
- $this->scheduleForInsert($entity);
- }
- /**
- * INTERNAL:
- * Computes the changeset of an individual entity, independently of the
- * computeChangeSets() routine that is used at the beginning of a UnitOfWork#commit().
- *
- * The passed entity must be a managed entity. If the entity already has a change set
- * because this method is invoked during a commit cycle then the change sets are added.
- * whereby changes detected in this method prevail.
- *
- * @ignore
- *
- * @param ClassMetadata $class The class descriptor of the entity.
- * @param object $entity The entity for which to (re)calculate the change set.
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException If the passed entity is not MANAGED.
- */
- public function recomputeSingleEntityChangeSet(ClassMetadata $class, $entity)
- {
- $oid = spl_object_hash($entity);
- if ( ! isset($this->entityStates[$oid]) || $this->entityStates[$oid] != self::STATE_MANAGED) {
- throw ORMInvalidArgumentException::entityNotManaged($entity);
- }
- // skip if change tracking is "NOTIFY"
- if ($class->isChangeTrackingNotify()) {
- return;
- }
- if ( ! $class->isInheritanceTypeNone()) {
- $class = $this->em->getClassMetadata(get_class($entity));
- }
- $actualData = array();
- foreach ($class->reflFields as $name => $refProp) {
- if (( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity())
- && ($name !== $class->versionField)
- && ! $class->isCollectionValuedAssociation($name)) {
- $actualData[$name] = $refProp->getValue($entity);
- }
- }
- if ( ! isset($this->originalEntityData[$oid])) {
- throw new \RuntimeException('Cannot call recomputeSingleEntityChangeSet before computeChangeSet on an entity.');
- }
- $originalData = $this->originalEntityData[$oid];
- $changeSet = array();
- foreach ($actualData as $propName => $actualValue) {
- $orgValue = isset($originalData[$propName]) ? $originalData[$propName] : null;
- if ($orgValue !== $actualValue) {
- $changeSet[$propName] = array($orgValue, $actualValue);
- }
- }
- if ($changeSet) {
- if (isset($this->entityChangeSets[$oid])) {
- $this->entityChangeSets[$oid] = array_merge($this->entityChangeSets[$oid], $changeSet);
- } else if ( ! isset($this->entityInsertions[$oid])) {
- $this->entityChangeSets[$oid] = $changeSet;
- $this->entityUpdates[$oid] = $entity;
- }
- $this->originalEntityData[$oid] = $actualData;
- }
- }
- /**
- * Executes all entity insertions for entities of the specified type.
- *
- * @param \Doctrine\ORM\Mapping\ClassMetadata $class
- *
- * @return void
- */
- private function executeInserts($class)
- {
- $entities = array();
- $className = $class->name;
- $persister = $this->getEntityPersister($className);
- $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::postPersist);
- foreach ($this->entityInsertions as $oid => $entity) {
- if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
- continue;
- }
- $persister->addInsert($entity);
- unset($this->entityInsertions[$oid]);
- if ($invoke !== ListenersInvoker::INVOKE_NONE) {
- $entities[] = $entity;
- }
- }
- $postInsertIds = $persister->executeInserts();
- if ($postInsertIds) {
- // Persister returned post-insert IDs
- foreach ($postInsertIds as $id => $entity) {
- $oid = spl_object_hash($entity);
- $idField = $class->identifier[0];
- $class->reflFields[$idField]->setValue($entity, $id);
- $this->entityIdentifiers[$oid] = array($idField => $id);
- $this->entityStates[$oid] = self::STATE_MANAGED;
- $this->originalEntityData[$oid][$idField] = $id;
- $this->addToIdentityMap($entity);
- }
- }
- foreach ($entities as $entity) {
- $this->listenersInvoker->invoke($class, Events::postPersist, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
- }
- }
- /**
- * Executes all entity updates for entities of the specified type.
- *
- * @param \Doctrine\ORM\Mapping\ClassMetadata $class
- *
- * @return void
- */
- private function executeUpdates($class)
- {
- $className = $class->name;
- $persister = $this->getEntityPersister($className);
- $preUpdateInvoke = $this->listenersInvoker->getSubscribedSystems($class, Events::preUpdate);
- $postUpdateInvoke = $this->listenersInvoker->getSubscribedSystems($class, Events::postUpdate);
- foreach ($this->entityUpdates as $oid => $entity) {
- if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
- continue;
- }
- if ($preUpdateInvoke != ListenersInvoker::INVOKE_NONE) {
- $this->listenersInvoker->invoke($class, Events::preUpdate, $entity, new PreUpdateEventArgs($entity, $this->em, $this->entityChangeSets[$oid]), $preUpdateInvoke);
- $this->recomputeSingleEntityChangeSet($class, $entity);
- }
- if ( ! empty($this->entityChangeSets[$oid])) {
- $persister->update($entity);
- }
- unset($this->entityUpdates[$oid]);
- if ($postUpdateInvoke != ListenersInvoker::INVOKE_NONE) {
- $this->listenersInvoker->invoke($class, Events::postUpdate, $entity, new LifecycleEventArgs($entity, $this->em), $postUpdateInvoke);
- }
- }
- }
- /**
- * Executes all entity deletions for entities of the specified type.
- *
- * @param \Doctrine\ORM\Mapping\ClassMetadata $class
- *
- * @return void
- */
- private function executeDeletions($class)
- {
- $className = $class->name;
- $persister = $this->getEntityPersister($className);
- $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::postRemove);
- foreach ($this->entityDeletions as $oid => $entity) {
- if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
- continue;
- }
- $persister->delete($entity);
- unset(
- $this->entityDeletions[$oid],
- $this->entityIdentifiers[$oid],
- $this->originalEntityData[$oid],
- $this->entityStates[$oid]
- );
- // Entity with this $oid after deletion treated as NEW, even if the $oid
- // is obtained by a new entity because the old one went out of scope.
- //$this->entityStates[$oid] = self::STATE_NEW;
- if ( ! $class->isIdentifierNatural()) {
- $class->reflFields[$class->identifier[0]]->setValue($entity, null);
- }
- if ($invoke !== ListenersInvoker::INVOKE_NONE) {
- $this->listenersInvoker->invoke($class, Events::postRemove, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
- }
- }
- }
- /**
- * Gets the commit order.
- *
- * @param array|null $entityChangeSet
- *
- * @return array
- */
- private function getCommitOrder(array $entityChangeSet = null)
- {
- if ($entityChangeSet === null) {
- $entityChangeSet = array_merge($this->entityInsertions, $this->entityUpdates, $this->entityDeletions);
- }
- $calc = $this->getCommitOrderCalculator();
- // See if there are any new classes in the changeset, that are not in the
- // commit order graph yet (don't have a node).
- // We have to inspect changeSet to be able to correctly build dependencies.
- // It is not possible to use IdentityMap here because post inserted ids
- // are not yet available.
- $newNodes = array();
- foreach ($entityChangeSet as $entity) {
- $className = $this->em->getClassMetadata(get_class($entity))->name;
- if ($calc->hasClass($className)) {
- continue;
- }
- $class = $this->em->getClassMetadata($className);
- $calc->addClass($class);
- $newNodes[] = $class;
- }
- // Calculate dependencies for new nodes
- while ($class = array_pop($newNodes)) {
- foreach ($class->associationMappings as $assoc) {
- if ( ! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
- continue;
- }
- $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
- if ( ! $calc->hasClass($targetClass->name)) {
- $calc->addClass($targetClass);
- $newNodes[] = $targetClass;
- }
- $calc->addDependency($targetClass, $class);
- // If the target class has mapped subclasses, these share the same dependency.
- if ( ! $targetClass->subClasses) {
- continue;
- }
- foreach ($targetClass->subClasses as $subClassName) {
- $targetSubClass = $this->em->getClassMetadata($subClassName);
- if ( ! $calc->hasClass($subClassName)) {
- $calc->addClass($targetSubClass);
- $newNodes[] = $targetSubClass;
- }
- $calc->addDependency($targetSubClass, $class);
- }
- }
- }
- return $calc->getCommitOrder();
- }
- /**
- * Schedules an entity for insertion into the database.
- * If the entity already has an identifier, it will be added to the identity map.
- *
- * @param object $entity The entity to schedule for insertion.
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException
- * @throws \InvalidArgumentException
- */
- public function scheduleForInsert($entity)
- {
- $oid = spl_object_hash($entity);
- if (isset($this->entityUpdates[$oid])) {
- throw new InvalidArgumentException("Dirty entity can not be scheduled for insertion.");
- }
- if (isset($this->entityDeletions[$oid])) {
- throw ORMInvalidArgumentException::scheduleInsertForRemovedEntity($entity);
- }
- if (isset($this->originalEntityData[$oid]) && ! isset($this->entityInsertions[$oid])) {
- throw ORMInvalidArgumentException::scheduleInsertForManagedEntity($entity);
- }
- if (isset($this->entityInsertions[$oid])) {
- throw ORMInvalidArgumentException::scheduleInsertTwice($entity);
- }
- $this->entityInsertions[$oid] = $entity;
- if (isset($this->entityIdentifiers[$oid])) {
- $this->addToIdentityMap($entity);
- }
- if ($entity instanceof NotifyPropertyChanged) {
- $entity->addPropertyChangedListener($this);
- }
- }
- /**
- * Checks whether an entity is scheduled for insertion.
- *
- * @param object $entity
- *
- * @return boolean
- */
- public function isScheduledForInsert($entity)
- {
- return isset($this->entityInsertions[spl_object_hash($entity)]);
- }
- /**
- * Schedules an entity for being updated.
- *
- * @param object $entity The entity to schedule for being updated.
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException
- */
- public function scheduleForUpdate($entity)
- {
- $oid = spl_object_hash($entity);
- if ( ! isset($this->entityIdentifiers[$oid])) {
- throw ORMInvalidArgumentException::entityHasNoIdentity($entity, "scheduling for update");
- }
- if (isset($this->entityDeletions[$oid])) {
- throw ORMInvalidArgumentException::entityIsRemoved($entity, "schedule for update");
- }
- if ( ! isset($this->entityUpdates[$oid]) && ! isset($this->entityInsertions[$oid])) {
- $this->entityUpdates[$oid] = $entity;
- }
- }
- /**
- * INTERNAL:
- * Schedules an extra update that will be executed immediately after the
- * regular entity updates within the currently running commit cycle.
- *
- * Extra updates for entities are stored as (entity, changeset) tuples.
- *
- * @ignore
- *
- * @param object $entity The entity for which to schedule an extra update.
- * @param array $changeset The changeset of the entity (what to update).
- *
- * @return void
- */
- public function scheduleExtraUpdate($entity, array $changeset)
- {
- $oid = spl_object_hash($entity);
- $extraUpdate = array($entity, $changeset);
- if (isset($this->extraUpdates[$oid])) {
- list($ignored, $changeset2) = $this->extraUpdates[$oid];
- $extraUpdate = array($entity, $changeset + $changeset2);
- }
- $this->extraUpdates[$oid] = $extraUpdate;
- }
- /**
- * Checks whether an entity is registered as dirty in the unit of work.
- * Note: Is not very useful currently as dirty entities are only registered
- * at commit time.
- *
- * @param object $entity
- *
- * @return boolean
- */
- public function isScheduledForUpdate($entity)
- {
- return isset($this->entityUpdates[spl_object_hash($entity)]);
- }
- /**
- * Checks whether an entity is registered to be checked in the unit of work.
- *
- * @param object $entity
- *
- * @return boolean
- */
- public function isScheduledForDirtyCheck($entity)
- {
- $rootEntityName = $this->em->getClassMetadata(get_class($entity))->rootEntityName;
- return isset($this->scheduledForDirtyCheck[$rootEntityName][spl_object_hash($entity)]);
- }
- /**
- * INTERNAL:
- * Schedules an entity for deletion.
- *
- * @param object $entity
- *
- * @return void
- */
- public function scheduleForDelete($entity)
- {
- $oid = spl_object_hash($entity);
- if (isset($this->entityInsertions[$oid])) {
- if ($this->isInIdentityMap($entity)) {
- $this->removeFromIdentityMap($entity);
- }
- unset($this->entityInsertions[$oid], $this->entityStates[$oid]);
- return; // entity has not been persisted yet, so nothing more to do.
- }
- if ( ! $this->isInIdentityMap($entity)) {
- return;
- }
- $this->removeFromIdentityMap($entity);
- if (isset($this->entityUpdates[$oid])) {
- unset($this->entityUpdates[$oid]);
- }
- if ( ! isset($this->entityDeletions[$oid])) {
- $this->entityDeletions[$oid] = $entity;
- $this->entityStates[$oid] = self::STATE_REMOVED;
- }
- }
- /**
- * Checks whether an entity is registered as removed/deleted with the unit
- * of work.
- *
- * @param object $entity
- *
- * @return boolean
- */
- public function isScheduledForDelete($entity)
- {
- return isset($this->entityDeletions[spl_object_hash($entity)]);
- }
- /**
- * Checks whether an entity is scheduled for insertion, update or deletion.
- *
- * @param object $entity
- *
- * @return boolean
- */
- public function isEntityScheduled($entity)
- {
- $oid = spl_object_hash($entity);
- return isset($this->entityInsertions[$oid])
- || isset($this->entityUpdates[$oid])
- || isset($this->entityDeletions[$oid]);
- }
- /**
- * INTERNAL:
- * Registers an entity in the identity map.
- * Note that entities in a hierarchy are registered with the class name of
- * the root entity.
- *
- * @ignore
- *
- * @param object $entity The entity to register.
- *
- * @return boolean TRUE if the registration was successful, FALSE if the identity of
- * the entity in question is already managed.
- *
- * @throws ORMInvalidArgumentException
- */
- public function addToIdentityMap($entity)
- {
- $classMetadata = $this->em->getClassMetadata(get_class($entity));
- $idHash = implode(' ', $this->entityIdentifiers[spl_object_hash($entity)]);
- if ($idHash === '') {
- throw ORMInvalidArgumentException::entityWithoutIdentity($classMetadata->name, $entity);
- }
- $className = $classMetadata->rootEntityName;
- if (isset($this->identityMap[$className][$idHash])) {
- return false;
- }
- $this->identityMap[$className][$idHash] = $entity;
- return true;
- }
- /**
- * Gets the state of an entity with regard to the current unit of work.
- *
- * @param object $entity
- * @param int|null $assume The state to assume if the state is not yet known (not MANAGED or REMOVED).
- * This parameter can be set to improve performance of entity state detection
- * by potentially avoiding a database lookup if the distinction between NEW and DETACHED
- * is either known or does not matter for the caller of the method.
- *
- * @return int The entity state.
- */
- public function getEntityState($entity, $assume = null)
- {
- $oid = spl_object_hash($entity);
- if (isset($this->entityStates[$oid])) {
- return $this->entityStates[$oid];
- }
- if ($assume !== null) {
- return $assume;
- }
- // State can only be NEW or DETACHED, because MANAGED/REMOVED states are known.
- // Note that you can not remember the NEW or DETACHED state in _entityStates since
- // the UoW does not hold references to such objects and the object hash can be reused.
- // More generally because the state may "change" between NEW/DETACHED without the UoW being aware of it.
- $class = $this->em->getClassMetadata(get_class($entity));
- $id = $class->getIdentifierValues($entity);
- if ( ! $id) {
- return self::STATE_NEW;
- }
- if ($class->containsForeignIdentifier) {
- $id = $this->flattenIdentifier($class, $id);
- }
- switch (true) {
- case ($class->isIdentifierNatural());
- // Check for a version field, if available, to avoid a db lookup.
- if ($class->isVersioned) {
- return ($class->getFieldValue($entity, $class->versionField))
- ? self::STATE_DETACHED
- : self::STATE_NEW;
- }
- // Last try before db lookup: check the identity map.
- if ($this->tryGetById($id, $class->rootEntityName)) {
- return self::STATE_DETACHED;
- }
- // db lookup
- if ($this->getEntityPersister($class->name)->exists($entity)) {
- return self::STATE_DETACHED;
- }
- return self::STATE_NEW;
- case ( ! $class->idGenerator->isPostInsertGenerator()):
- // if we have a pre insert generator we can't be sure that having an id
- // really means that the entity exists. We have to verify this through
- // the last resort: a db lookup
- // Last try before db lookup: check the identity map.
- if ($this->tryGetById($id, $class->rootEntityName)) {
- return self::STATE_DETACHED;
- }
- // db lookup
- if ($this->getEntityPersister($class->name)->exists($entity)) {
- return self::STATE_DETACHED;
- }
- return self::STATE_NEW;
- default:
- return self::STATE_DETACHED;
- }
- }
- /**
- * INTERNAL:
- * Removes an entity from the identity map. This effectively detaches the
- * entity from the persistence management of Doctrine.
- *
- * @ignore
- *
- * @param object $entity
- *
- * @return boolean
- *
- * @throws ORMInvalidArgumentException
- */
- public function removeFromIdentityMap($entity)
- {
- $oid = spl_object_hash($entity);
- $classMetadata = $this->em->getClassMetadata(get_class($entity));
- $idHash = implode(' ', $this->entityIdentifiers[$oid]);
- if ($idHash === '') {
- throw ORMInvalidArgumentException::entityHasNoIdentity($entity, "remove from identity map");
- }
- $className = $classMetadata->rootEntityName;
- if (isset($this->identityMap[$className][$idHash])) {
- unset($this->identityMap[$className][$idHash]);
- unset($this->readOnlyObjects[$oid]);
- //$this->entityStates[$oid] = self::STATE_DETACHED;
- return true;
- }
- return false;
- }
- /**
- * INTERNAL:
- * Gets an entity in the identity map by its identifier hash.
- *
- * @ignore
- *
- * @param string $idHash
- * @param string $rootClassName
- *
- * @return object
- */
- public function getByIdHash($idHash, $rootClassName)
- {
- return $this->identityMap[$rootClassName][$idHash];
- }
- /**
- * INTERNAL:
- * Tries to get an entity by its identifier hash. If no entity is found for
- * the given hash, FALSE is returned.
- *
- * @ignore
- *
- * @param string $idHash
- * @param string $rootClassName
- *
- * @return object|bool The found entity or FALSE.
- */
- public function tryGetByIdHash($idHash, $rootClassName)
- {
- if (isset($this->identityMap[$rootClassName][$idHash])) {
- return $this->identityMap[$rootClassName][$idHash];
- }
- return false;
- }
- /**
- * Checks whether an entity is registered in the identity map of this UnitOfWork.
- *
- * @param object $entity
- *
- * @return boolean
- */
- public function isInIdentityMap($entity)
- {
- $oid = spl_object_hash($entity);
- if ( ! isset($this->entityIdentifiers[$oid])) {
- return false;
- }
- $classMetadata = $this->em->getClassMetadata(get_class($entity));
- $idHash = implode(' ', $this->entityIdentifiers[$oid]);
- if ($idHash === '') {
- return false;
- }
- return isset($this->identityMap[$classMetadata->rootEntityName][$idHash]);
- }
- /**
- * INTERNAL:
- * Checks whether an identifier hash exists in the identity map.
- *
- * @ignore
- *
- * @param string $idHash
- * @param string $rootClassName
- *
- * @return boolean
- */
- public function containsIdHash($idHash, $rootClassName)
- {
- return isset($this->identityMap[$rootClassName][$idHash]);
- }
- /**
- * Persists an entity as part of the current unit of work.
- *
- * @param object $entity The entity to persist.
- *
- * @return void
- */
- public function persist($entity)
- {
- $visited = array();
- $this->doPersist($entity, $visited);
- }
- /**
- * Persists an entity as part of the current unit of work.
- *
- * This method is internally called during persist() cascades as it tracks
- * the already visited entities to prevent infinite recursions.
- *
- * @param object $entity The entity to persist.
- * @param array $visited The already visited entities.
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException
- * @throws UnexpectedValueException
- */
- private function doPersist($entity, array &$visited)
- {
- $oid = spl_object_hash($entity);
- if (isset($visited[$oid])) {
- return; // Prevent infinite recursion
- }
- $visited[$oid] = $entity; // Mark visited
- $class = $this->em->getClassMetadata(get_class($entity));
- // We assume NEW, so DETACHED entities result in an exception on flush (constraint violation).
- // If we would detect DETACHED here we would throw an exception anyway with the same
- // consequences (not recoverable/programming error), so just assuming NEW here
- // lets us avoid some database lookups for entities with natural identifiers.
- $entityState = $this->getEntityState($entity, self::STATE_NEW);
- switch ($entityState) {
- case self::STATE_MANAGED:
- // Nothing to do, except if policy is "deferred explicit"
- if ($class->isChangeTrackingDeferredExplicit()) {
- $this->scheduleForDirtyCheck($entity);
- }
- break;
- case self::STATE_NEW:
- $this->persistNew($class, $entity);
- break;
- case self::STATE_REMOVED:
- // Entity becomes managed again
- unset($this->entityDeletions[$oid]);
- $this->addToIdentityMap($entity);
- $this->entityStates[$oid] = self::STATE_MANAGED;
- break;
- case self::STATE_DETACHED:
- // Can actually not happen right now since we assume STATE_NEW.
- throw ORMInvalidArgumentException::detachedEntityCannot($entity, "persisted");
- default:
- throw new UnexpectedValueException("Unexpected entity state: $entityState." . self::objToStr($entity));
- }
- $this->cascadePersist($entity, $visited);
- }
- /**
- * Deletes an entity as part of the current unit of work.
- *
- * @param object $entity The entity to remove.
- *
- * @return void
- */
- public function remove($entity)
- {
- $visited = array();
- $this->doRemove($entity, $visited);
- }
- /**
- * Deletes an entity as part of the current unit of work.
- *
- * This method is internally called during delete() cascades as it tracks
- * the already visited entities to prevent infinite recursions.
- *
- * @param object $entity The entity to delete.
- * @param array $visited The map of the already visited entities.
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException If the instance is a detached entity.
- * @throws UnexpectedValueException
- */
- private function doRemove($entity, array &$visited)
- {
- $oid = spl_object_hash($entity);
- if (isset($visited[$oid])) {
- return; // Prevent infinite recursion
- }
- $visited[$oid] = $entity; // mark visited
- // Cascade first, because scheduleForDelete() removes the entity from the identity map, which
- // can cause problems when a lazy proxy has to be initialized for the cascade operation.
- $this->cascadeRemove($entity, $visited);
- $class = $this->em->getClassMetadata(get_class($entity));
- $entityState = $this->getEntityState($entity);
- switch ($entityState) {
- case self::STATE_NEW:
- case self::STATE_REMOVED:
- // nothing to do
- break;
- case self::STATE_MANAGED:
- $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::preRemove);
- if ($invoke !== ListenersInvoker::INVOKE_NONE) {
- $this->listenersInvoker->invoke($class, Events::preRemove, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
- }
- $this->scheduleForDelete($entity);
- break;
- case self::STATE_DETACHED:
- throw ORMInvalidArgumentException::detachedEntityCannot($entity, "removed");
- default:
- throw new UnexpectedValueException("Unexpected entity state: $entityState." . self::objToStr($entity));
- }
- }
- /**
- * Merges the state of the given detached entity into this UnitOfWork.
- *
- * @param object $entity
- *
- * @return object The managed copy of the entity.
- *
- * @throws OptimisticLockException If the entity uses optimistic locking through a version
- * attribute and the version check against the managed copy fails.
- *
- * @todo Require active transaction!? OptimisticLockException may result in undefined state!?
- */
- public function merge($entity)
- {
- $visited = array();
- return $this->doMerge($entity, $visited);
- }
- /**
- * convert foreign identifiers into scalar foreign key values to avoid object to string conversion failures.
- *
- * @param ClassMetadata $class
- * @param array $id
- * @return array
- */
- private function flattenIdentifier($class, $id)
- {
- $flatId = array();
- foreach ($id as $idField => $idValue) {
- if (isset($class->associationMappings[$idField])) {
- $targetClassMetadata = $this->em->getClassMetadata($class->associationMappings[$idField]['targetEntity']);
- $associatedId = $this->getEntityIdentifier($idValue);
- $flatId[$idField] = $associatedId[$targetClassMetadata->identifier[0]];
- } else {
- $flatId[$idField] = $idValue;
- }
- }
- return $flatId;
- }
- /**
- * Executes a merge operation on an entity.
- *
- * @param object $entity
- * @param array $visited
- * @param object|null $prevManagedCopy
- * @param array|null $assoc
- *
- * @return object The managed copy of the entity.
- *
- * @throws OptimisticLockException If the entity uses optimistic locking through a version
- * attribute and the version check against the managed copy fails.
- * @throws ORMInvalidArgumentException If the entity instance is NEW.
- * @throws EntityNotFoundException
- */
- private function doMerge($entity, array &$visited, $prevManagedCopy = null, $assoc = null)
- {
- $oid = spl_object_hash($entity);
- if (isset($visited[$oid])) {
- return $visited[$oid]; // Prevent infinite recursion
- }
- $visited[$oid] = $entity; // mark visited
- $class = $this->em->getClassMetadata(get_class($entity));
- // First we assume DETACHED, although it can still be NEW but we can avoid
- // an extra db-roundtrip this way. If it is not MANAGED but has an identity,
- // we need to fetch it from the db anyway in order to merge.
- // MANAGED entities are ignored by the merge operation.
- $managedCopy = $entity;
- if ($this->getEntityState($entity, self::STATE_DETACHED) !== self::STATE_MANAGED) {
- if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
- $this->em->getProxyFactory()->resetUninitializedProxy($entity);
- $entity->__load();
- }
- // Try to look the entity up in the identity map.
- $id = $class->getIdentifierValues($entity);
- // If there is no ID, it is actually NEW.
- if ( ! $id) {
- $managedCopy = $this->newInstance($class);
- $this->persistNew($class, $managedCopy);
- } else {
- $flatId = ($class->containsForeignIdentifier)
- ? $this->flattenIdentifier($class, $id)
- : $id;
- $managedCopy = $this->tryGetById($flatId, $class->rootEntityName);
- if ($managedCopy) {
- // We have the entity in-memory already, just make sure its not removed.
- if ($this->getEntityState($managedCopy) == self::STATE_REMOVED) {
- throw ORMInvalidArgumentException::entityIsRemoved($managedCopy, "merge");
- }
- } else {
- // We need to fetch the managed copy in order to merge.
- $managedCopy = $this->em->find($class->name, $flatId);
- }
- if ($managedCopy === null) {
- // If the identifier is ASSIGNED, it is NEW, otherwise an error
- // since the managed entity was not found.
- if ( ! $class->isIdentifierNatural()) {
- throw new EntityNotFoundException;
- }
- $managedCopy = $this->newInstance($class);
- $class->setIdentifierValues($managedCopy, $id);
- $this->persistNew($class, $managedCopy);
- } else {
- if ($managedCopy instanceof Proxy && ! $managedCopy->__isInitialized__) {
- $managedCopy->__load();
- }
- }
- }
- if ($class->isVersioned) {
- $reflField = $class->reflFields[$class->versionField];
- $managedCopyVersion = $reflField->getValue($managedCopy);
- $entityVersion = $reflField->getValue($entity);
- // Throw exception if versions don't match.
- if ($managedCopyVersion != $entityVersion) {
- throw OptimisticLockException::lockFailedVersionMismatch($entity, $entityVersion, $managedCopyVersion);
- }
- }
- // Merge state of $entity into existing (managed) entity
- foreach ($class->reflClass->getProperties() as $prop) {
- $name = $prop->name;
- $prop->setAccessible(true);
- if ( ! isset($class->associationMappings[$name])) {
- if ( ! $class->isIdentifier($name)) {
- $prop->setValue($managedCopy, $prop->getValue($entity));
- }
- } else {
- $assoc2 = $class->associationMappings[$name];
- if ($assoc2['type'] & ClassMetadata::TO_ONE) {
- $other = $prop->getValue($entity);
- if ($other === null) {
- $prop->setValue($managedCopy, null);
- } else if ($other instanceof Proxy && !$other->__isInitialized__) {
- // do not merge fields marked lazy that have not been fetched.
- continue;
- } else if ( ! $assoc2['isCascadeMerge']) {
- if ($this->getEntityState($other) === self::STATE_DETACHED) {
- $targetClass = $this->em->getClassMetadata($assoc2['targetEntity']);
- $relatedId = $targetClass->getIdentifierValues($other);
- if ($targetClass->subClasses) {
- $other = $this->em->find($targetClass->name, $relatedId);
- } else {
- $other = $this->em->getProxyFactory()->getProxy($assoc2['targetEntity'], $relatedId);
- $this->registerManaged($other, $relatedId, array());
- }
- }
- $prop->setValue($managedCopy, $other);
- }
- } else {
- $mergeCol = $prop->getValue($entity);
- if ($mergeCol instanceof PersistentCollection && !$mergeCol->isInitialized()) {
- // do not merge fields marked lazy that have not been fetched.
- // keep the lazy persistent collection of the managed copy.
- continue;
- }
- $managedCol = $prop->getValue($managedCopy);
- if (!$managedCol) {
- $managedCol = new PersistentCollection($this->em,
- $this->em->getClassMetadata($assoc2['targetEntity']),
- new ArrayCollection
- );
- $managedCol->setOwner($managedCopy, $assoc2);
- $prop->setValue($managedCopy, $managedCol);
- $this->originalEntityData[$oid][$name] = $managedCol;
- }
- if ($assoc2['isCascadeMerge']) {
- $managedCol->initialize();
- // clear and set dirty a managed collection if its not also the same collection to merge from.
- if (!$managedCol->isEmpty() && $managedCol !== $mergeCol) {
- $managedCol->unwrap()->clear();
- $managedCol->setDirty(true);
- if ($assoc2['isOwningSide'] && $assoc2['type'] == ClassMetadata::MANY_TO_MANY && $class->isChangeTrackingNotify()) {
- $this->scheduleForDirtyCheck($managedCopy);
- }
- }
- }
- }
- }
- if ($class->isChangeTrackingNotify()) {
- // Just treat all properties as changed, there is no other choice.
- $this->propertyChanged($managedCopy, $name, null, $prop->getValue($managedCopy));
- }
- }
- if ($class->isChangeTrackingDeferredExplicit()) {
- $this->scheduleForDirtyCheck($entity);
- }
- }
- if ($prevManagedCopy !== null) {
- $assocField = $assoc['fieldName'];
- $prevClass = $this->em->getClassMetadata(get_class($prevManagedCopy));
- if ($assoc['type'] & ClassMetadata::TO_ONE) {
- $prevClass->reflFields[$assocField]->setValue($prevManagedCopy, $managedCopy);
- } else {
- $prevClass->reflFields[$assocField]->getValue($prevManagedCopy)->add($managedCopy);
- if ($assoc['type'] == ClassMetadata::ONE_TO_MANY) {
- $class->reflFields[$assoc['mappedBy']]->setValue($managedCopy, $prevManagedCopy);
- }
- }
- }
- // Mark the managed copy visited as well
- $visited[spl_object_hash($managedCopy)] = true;
- $this->cascadeMerge($entity, $managedCopy, $visited);
- return $managedCopy;
- }
- /**
- * Detaches an entity from the persistence management. It's persistence will
- * no longer be managed by Doctrine.
- *
- * @param object $entity The entity to detach.
- *
- * @return void
- */
- public function detach($entity)
- {
- $visited = array();
- $this->doDetach($entity, $visited);
- }
- /**
- * Executes a detach operation on the given entity.
- *
- * @param object $entity
- * @param array $visited
- * @param boolean $noCascade if true, don't cascade detach operation.
- *
- * @return void
- */
- private function doDetach($entity, array &$visited, $noCascade = false)
- {
- $oid = spl_object_hash($entity);
- if (isset($visited[$oid])) {
- return; // Prevent infinite recursion
- }
- $visited[$oid] = $entity; // mark visited
- switch ($this->getEntityState($entity, self::STATE_DETACHED)) {
- case self::STATE_MANAGED:
- if ($this->isInIdentityMap($entity)) {
- $this->removeFromIdentityMap($entity);
- }
- unset(
- $this->entityInsertions[$oid],
- $this->entityUpdates[$oid],
- $this->entityDeletions[$oid],
- $this->entityIdentifiers[$oid],
- $this->entityStates[$oid],
- $this->originalEntityData[$oid]
- );
- break;
- case self::STATE_NEW:
- case self::STATE_DETACHED:
- return;
- }
- if ( ! $noCascade) {
- $this->cascadeDetach($entity, $visited);
- }
- }
- /**
- * Refreshes the state of the given entity from the database, overwriting
- * any local, unpersisted changes.
- *
- * @param object $entity The entity to refresh.
- *
- * @return void
- *
- * @throws InvalidArgumentException If the entity is not MANAGED.
- */
- public function refresh($entity)
- {
- $visited = array();
- $this->doRefresh($entity, $visited);
- }
- /**
- * Executes a refresh operation on an entity.
- *
- * @param object $entity The entity to refresh.
- * @param array $visited The already visited entities during cascades.
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException If the entity is not MANAGED.
- */
- private function doRefresh($entity, array &$visited)
- {
- $oid = spl_object_hash($entity);
- if (isset($visited[$oid])) {
- return; // Prevent infinite recursion
- }
- $visited[$oid] = $entity; // mark visited
- $class = $this->em->getClassMetadata(get_class($entity));
- if ($this->getEntityState($entity) !== self::STATE_MANAGED) {
- throw ORMInvalidArgumentException::entityNotManaged($entity);
- }
- $this->getEntityPersister($class->name)->refresh(
- array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
- $entity
- );
- $this->cascadeRefresh($entity, $visited);
- }
- /**
- * Cascades a refresh operation to associated entities.
- *
- * @param object $entity
- * @param array $visited
- *
- * @return void
- */
- private function cascadeRefresh($entity, array &$visited)
- {
- $class = $this->em->getClassMetadata(get_class($entity));
- $associationMappings = array_filter(
- $class->associationMappings,
- function ($assoc) { return $assoc['isCascadeRefresh']; }
- );
- foreach ($associationMappings as $assoc) {
- $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
- switch (true) {
- case ($relatedEntities instanceof PersistentCollection):
- // Unwrap so that foreach() does not initialize
- $relatedEntities = $relatedEntities->unwrap();
- // break; is commented intentionally!
- case ($relatedEntities instanceof Collection):
- case (is_array($relatedEntities)):
- foreach ($relatedEntities as $relatedEntity) {
- $this->doRefresh($relatedEntity, $visited);
- }
- break;
- case ($relatedEntities !== null):
- $this->doRefresh($relatedEntities, $visited);
- break;
- default:
- // Do nothing
- }
- }
- }
- /**
- * Cascades a detach operation to associated entities.
- *
- * @param object $entity
- * @param array $visited
- *
- * @return void
- */
- private function cascadeDetach($entity, array &$visited)
- {
- $class = $this->em->getClassMetadata(get_class($entity));
- $associationMappings = array_filter(
- $class->associationMappings,
- function ($assoc) { return $assoc['isCascadeDetach']; }
- );
- foreach ($associationMappings as $assoc) {
- $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
- switch (true) {
- case ($relatedEntities instanceof PersistentCollection):
- // Unwrap so that foreach() does not initialize
- $relatedEntities = $relatedEntities->unwrap();
- // break; is commented intentionally!
- case ($relatedEntities instanceof Collection):
- case (is_array($relatedEntities)):
- foreach ($relatedEntities as $relatedEntity) {
- $this->doDetach($relatedEntity, $visited);
- }
- break;
- case ($relatedEntities !== null):
- $this->doDetach($relatedEntities, $visited);
- break;
- default:
- // Do nothing
- }
- }
- }
- /**
- * Cascades a merge operation to associated entities.
- *
- * @param object $entity
- * @param object $managedCopy
- * @param array $visited
- *
- * @return void
- */
- private function cascadeMerge($entity, $managedCopy, array &$visited)
- {
- $class = $this->em->getClassMetadata(get_class($entity));
- $associationMappings = array_filter(
- $class->associationMappings,
- function ($assoc) { return $assoc['isCascadeMerge']; }
- );
- foreach ($associationMappings as $assoc) {
- $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
- if ($relatedEntities instanceof Collection) {
- if ($relatedEntities === $class->reflFields[$assoc['fieldName']]->getValue($managedCopy)) {
- continue;
- }
- if ($relatedEntities instanceof PersistentCollection) {
- // Unwrap so that foreach() does not initialize
- $relatedEntities = $relatedEntities->unwrap();
- }
- foreach ($relatedEntities as $relatedEntity) {
- $this->doMerge($relatedEntity, $visited, $managedCopy, $assoc);
- }
- } else if ($relatedEntities !== null) {
- $this->doMerge($relatedEntities, $visited, $managedCopy, $assoc);
- }
- }
- }
- /**
- * Cascades the save operation to associated entities.
- *
- * @param object $entity
- * @param array $visited
- *
- * @return void
- */
- private function cascadePersist($entity, array &$visited)
- {
- $class = $this->em->getClassMetadata(get_class($entity));
- $associationMappings = array_filter(
- $class->associationMappings,
- function ($assoc) { return $assoc['isCascadePersist']; }
- );
- foreach ($associationMappings as $assoc) {
- $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
- switch (true) {
- case ($relatedEntities instanceof PersistentCollection):
- // Unwrap so that foreach() does not initialize
- $relatedEntities = $relatedEntities->unwrap();
- // break; is commented intentionally!
- case ($relatedEntities instanceof Collection):
- case (is_array($relatedEntities)):
- foreach ($relatedEntities as $relatedEntity) {
- $this->doPersist($relatedEntity, $visited);
- }
- break;
- case ($relatedEntities !== null):
- $this->doPersist($relatedEntities, $visited);
- break;
- default:
- // Do nothing
- }
- }
- }
- /**
- * Cascades the delete operation to associated entities.
- *
- * @param object $entity
- * @param array $visited
- *
- * @return void
- */
- private function cascadeRemove($entity, array &$visited)
- {
- $class = $this->em->getClassMetadata(get_class($entity));
- $associationMappings = array_filter(
- $class->associationMappings,
- function ($assoc) { return $assoc['isCascadeRemove']; }
- );
- $entitiesToCascade = array();
- foreach ($associationMappings as $assoc) {
- if ($entity instanceof Proxy && !$entity->__isInitialized__) {
- $entity->__load();
- }
- $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
- switch (true) {
- case ($relatedEntities instanceof Collection):
- case (is_array($relatedEntities)):
- // If its a PersistentCollection initialization is intended! No unwrap!
- foreach ($relatedEntities as $relatedEntity) {
- $entitiesToCascade[] = $relatedEntity;
- }
- break;
- case ($relatedEntities !== null):
- $entitiesToCascade[] = $relatedEntities;
- break;
- default:
- // Do nothing
- }
- }
- foreach ($entitiesToCascade as $relatedEntity) {
- $this->doRemove($relatedEntity, $visited);
- }
- }
- /**
- * Acquire a lock on the given entity.
- *
- * @param object $entity
- * @param int $lockMode
- * @param int $lockVersion
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException
- * @throws TransactionRequiredException
- * @throws OptimisticLockException
- */
- public function lock($entity, $lockMode, $lockVersion = null)
- {
- if ($entity === null) {
- throw new \InvalidArgumentException("No entity passed to UnitOfWork#lock().");
- }
- if ($this->getEntityState($entity, self::STATE_DETACHED) != self::STATE_MANAGED) {
- throw ORMInvalidArgumentException::entityNotManaged($entity);
- }
- $class = $this->em->getClassMetadata(get_class($entity));
- switch ($lockMode) {
- case \Doctrine\DBAL\LockMode::OPTIMISTIC;
- if ( ! $class->isVersioned) {
- throw OptimisticLockException::notVersioned($class->name);
- }
- if ($lockVersion === null) {
- return;
- }
- if ($entity instanceof Proxy && !$entity->__isInitialized__) {
- $entity->__load();
- }
- $entityVersion = $class->reflFields[$class->versionField]->getValue($entity);
- if ($entityVersion != $lockVersion) {
- throw OptimisticLockException::lockFailedVersionMismatch($entity, $lockVersion, $entityVersion);
- }
- break;
- case \Doctrine\DBAL\LockMode::PESSIMISTIC_READ:
- case \Doctrine\DBAL\LockMode::PESSIMISTIC_WRITE:
- if (!$this->em->getConnection()->isTransactionActive()) {
- throw TransactionRequiredException::transactionRequired();
- }
- $oid = spl_object_hash($entity);
- $this->getEntityPersister($class->name)->lock(
- array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
- $lockMode
- );
- break;
- default:
- // Do nothing
- }
- }
- /**
- * Gets the CommitOrderCalculator used by the UnitOfWork to order commits.
- *
- * @return \Doctrine\ORM\Internal\CommitOrderCalculator
- */
- public function getCommitOrderCalculator()
- {
- if ($this->commitOrderCalculator === null) {
- $this->commitOrderCalculator = new Internal\CommitOrderCalculator;
- }
- return $this->commitOrderCalculator;
- }
- /**
- * Clears the UnitOfWork.
- *
- * @param string|null $entityName if given, only entities of this type will get detached.
- *
- * @return void
- */
- public function clear($entityName = null)
- {
- if ($entityName === null) {
- $this->identityMap =
- $this->entityIdentifiers =
- $this->originalEntityData =
- $this->entityChangeSets =
- $this->entityStates =
- $this->scheduledForDirtyCheck =
- $this->entityInsertions =
- $this->entityUpdates =
- $this->entityDeletions =
- $this->collectionDeletions =
- $this->collectionUpdates =
- $this->extraUpdates =
- $this->readOnlyObjects =
- $this->visitedCollections =
- $this->orphanRemovals = array();
- if ($this->commitOrderCalculator !== null) {
- $this->commitOrderCalculator->clear();
- }
- } else {
- $visited = array();
- foreach ($this->identityMap as $className => $entities) {
- if ($className === $entityName) {
- foreach ($entities as $entity) {
- $this->doDetach($entity, $visited, true);
- }
- }
- }
- }
- if ($this->evm->hasListeners(Events::onClear)) {
- $this->evm->dispatchEvent(Events::onClear, new Event\OnClearEventArgs($this->em, $entityName));
- }
- }
- /**
- * INTERNAL:
- * Schedules an orphaned entity for removal. The remove() operation will be
- * invoked on that entity at the beginning of the next commit of this
- * UnitOfWork.
- *
- * @ignore
- *
- * @param object $entity
- *
- * @return void
- */
- public function scheduleOrphanRemoval($entity)
- {
- $this->orphanRemovals[spl_object_hash($entity)] = $entity;
- }
- /**
- * INTERNAL:
- * Schedules a complete collection for removal when this UnitOfWork commits.
- *
- * @param PersistentCollection $coll
- *
- * @return void
- */
- public function scheduleCollectionDeletion(PersistentCollection $coll)
- {
- $coid = spl_object_hash($coll);
- //TODO: if $coll is already scheduled for recreation ... what to do?
- // Just remove $coll from the scheduled recreations?
- if (isset($this->collectionUpdates[$coid])) {
- unset($this->collectionUpdates[$coid]);
- }
- $this->collectionDeletions[$coid] = $coll;
- }
- /**
- * @param PersistentCollection $coll
- *
- * @return bool
- */
- public function isCollectionScheduledForDeletion(PersistentCollection $coll)
- {
- return isset($this->collectionDeletions[spl_object_hash($coll)]);
- }
- /**
- * @param ClassMetadata $class
- *
- * @return \Doctrine\Common\Persistence\ObjectManagerAware|object
- */
- private function newInstance($class)
- {
- $entity = $class->newInstance();
- if ($entity instanceof \Doctrine\Common\Persistence\ObjectManagerAware) {
- $entity->injectObjectManager($this->em, $class);
- }
- return $entity;
- }
- /**
- * INTERNAL:
- * Creates an entity. Used for reconstitution of persistent entities.
- *
- * @ignore
- *
- * @param string $className The name of the entity class.
- * @param array $data The data for the entity.
- * @param array $hints Any hints to account for during reconstitution/lookup of the entity.
- *
- * @return object The managed entity instance.
- *
- * @internal Highly performance-sensitive method.
- *
- * @todo Rename: getOrCreateEntity
- */
- public function createEntity($className, array $data, &$hints = array())
- {
- $class = $this->em->getClassMetadata($className);
- //$isReadOnly = isset($hints[Query::HINT_READ_ONLY]);
- if ($class->isIdentifierComposite) {
- $id = array();
- foreach ($class->identifier as $fieldName) {
- $id[$fieldName] = isset($class->associationMappings[$fieldName])
- ? $data[$class->associationMappings[$fieldName]['joinColumns'][0]['name']]
- : $data[$fieldName];
- }
- } else {
- $id = isset($class->associationMappings[$class->identifier[0]])
- ? $data[$class->associationMappings[$class->identifier[0]]['joinColumns'][0]['name']]
- : $data[$class->identifier[0]];
- $id = array($class->identifier[0] => $id);
- }
- $idHash = implode(' ', $id);
- if (isset($this->identityMap[$class->rootEntityName][$idHash])) {
- $entity = $this->identityMap[$class->rootEntityName][$idHash];
- $oid = spl_object_hash($entity);
- if (
- isset($hints[Query::HINT_REFRESH])
- && isset($hints[Query::HINT_REFRESH_ENTITY])
- && ($unmanagedProxy = $hints[Query::HINT_REFRESH_ENTITY]) !== $entity
- && $unmanagedProxy instanceof Proxy
- && $this->isIdentifierEquals($unmanagedProxy, $entity)
- ) {
- // DDC-1238 - we have a managed instance, but it isn't the provided one.
- // Therefore we clear its identifier. Also, we must re-fetch metadata since the
- // refreshed object may be anything
- foreach ($class->identifier as $fieldName) {
- $class->reflFields[$fieldName]->setValue($unmanagedProxy, null);
- }
- return $unmanagedProxy;
- }
- if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
- $entity->__setInitialized(true);
- $overrideLocalValues = true;
- if ($entity instanceof NotifyPropertyChanged) {
- $entity->addPropertyChangedListener($this);
- }
- // inject ObjectManager into just loaded proxies.
- if ($overrideLocalValues && $entity instanceof ObjectManagerAware) {
- $entity->injectObjectManager($this->em, $class);
- }
- } else {
- $overrideLocalValues = isset($hints[Query::HINT_REFRESH]);
- // If only a specific entity is set to refresh, check that it's the one
- if(isset($hints[Query::HINT_REFRESH_ENTITY])) {
- $overrideLocalValues = $hints[Query::HINT_REFRESH_ENTITY] === $entity;
- }
- // inject ObjectManager upon refresh.
- if ($overrideLocalValues && $entity instanceof ObjectManagerAware) {
- $entity->injectObjectManager($this->em, $class);
- }
- }
- if ($overrideLocalValues) {
- $this->originalEntityData[$oid] = $data;
- }
- } else {
- $entity = $this->newInstance($class);
- $oid = spl_object_hash($entity);
- $this->entityIdentifiers[$oid] = $id;
- $this->entityStates[$oid] = self::STATE_MANAGED;
- $this->originalEntityData[$oid] = $data;
- $this->identityMap[$class->rootEntityName][$idHash] = $entity;
- if ($entity instanceof NotifyPropertyChanged) {
- $entity->addPropertyChangedListener($this);
- }
- $overrideLocalValues = true;
- }
- if ( ! $overrideLocalValues) {
- return $entity;
- }
- foreach ($data as $field => $value) {
- if (isset($class->fieldMappings[$field])) {
- $class->reflFields[$field]->setValue($entity, $value);
- }
- }
- // Loading the entity right here, if its in the eager loading map get rid of it there.
- unset($this->eagerLoadingEntities[$class->rootEntityName][$idHash]);
- if (isset($this->eagerLoadingEntities[$class->rootEntityName]) && ! $this->eagerLoadingEntities[$class->rootEntityName]) {
- unset($this->eagerLoadingEntities[$class->rootEntityName]);
- }
- // Properly initialize any unfetched associations, if partial objects are not allowed.
- if (isset($hints[Query::HINT_FORCE_PARTIAL_LOAD])) {
- return $entity;
- }
- foreach ($class->associationMappings as $field => $assoc) {
- // Check if the association is not among the fetch-joined associations already.
- if (isset($hints['fetchAlias']) && isset($hints['fetched'][$hints['fetchAlias']][$field])) {
- continue;
- }
- $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
- switch (true) {
- case ($assoc['type'] & ClassMetadata::TO_ONE):
- if ( ! $assoc['isOwningSide']) {
- // Inverse side of x-to-one can never be lazy
- $class->reflFields[$field]->setValue($entity, $this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc, $entity));
- continue 2;
- }
- $associatedId = array();
- // TODO: Is this even computed right in all cases of composite keys?
- foreach ($assoc['targetToSourceKeyColumns'] as $targetColumn => $srcColumn) {
- $joinColumnValue = isset($data[$srcColumn]) ? $data[$srcColumn] : null;
- if ($joinColumnValue !== null) {
- if ($targetClass->containsForeignIdentifier) {
- $associatedId[$targetClass->getFieldForColumn($targetColumn)] = $joinColumnValue;
- } else {
- $associatedId[$targetClass->fieldNames[$targetColumn]] = $joinColumnValue;
- }
- }
- }
- if ( ! $associatedId) {
- // Foreign key is NULL
- $class->reflFields[$field]->setValue($entity, null);
- $this->originalEntityData[$oid][$field] = null;
- continue;
- }
- if ( ! isset($hints['fetchMode'][$class->name][$field])) {
- $hints['fetchMode'][$class->name][$field] = $assoc['fetch'];
- }
- // Foreign key is set
- // Check identity map first
- // FIXME: Can break easily with composite keys if join column values are in
- // wrong order. The correct order is the one in ClassMetadata#identifier.
- $relatedIdHash = implode(' ', $associatedId);
- switch (true) {
- case (isset($this->identityMap[$targetClass->rootEntityName][$relatedIdHash])):
- $newValue = $this->identityMap[$targetClass->rootEntityName][$relatedIdHash];
- // If this is an uninitialized proxy, we are deferring eager loads,
- // this association is marked as eager fetch, and its an uninitialized proxy (wtf!)
- // then we can append this entity for eager loading!
- if ($hints['fetchMode'][$class->name][$field] == ClassMetadata::FETCH_EAGER &&
- isset($hints[self::HINT_DEFEREAGERLOAD]) &&
- !$targetClass->isIdentifierComposite &&
- $newValue instanceof Proxy &&
- $newValue->__isInitialized__ === false) {
- $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($associatedId);
- }
- break;
- case ($targetClass->subClasses):
- // If it might be a subtype, it can not be lazy. There isn't even
- // a way to solve this with deferred eager loading, which means putting
- // an entity with subclasses at a *-to-one location is really bad! (performance-wise)
- $newValue = $this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc, $entity, $associatedId);
- break;
- default:
- switch (true) {
- // We are negating the condition here. Other cases will assume it is valid!
- case ($hints['fetchMode'][$class->name][$field] !== ClassMetadata::FETCH_EAGER):
- $newValue = $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $associatedId);
- break;
- // Deferred eager load only works for single identifier classes
- case (isset($hints[self::HINT_DEFEREAGERLOAD]) && ! $targetClass->isIdentifierComposite):
- // TODO: Is there a faster approach?
- $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($associatedId);
- $newValue = $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $associatedId);
- break;
- default:
- // TODO: This is very imperformant, ignore it?
- $newValue = $this->em->find($assoc['targetEntity'], $associatedId);
- break;
- }
- // PERF: Inlined & optimized code from UnitOfWork#registerManaged()
- $newValueOid = spl_object_hash($newValue);
- $this->entityIdentifiers[$newValueOid] = $associatedId;
- $this->identityMap[$targetClass->rootEntityName][$relatedIdHash] = $newValue;
- if (
- $newValue instanceof NotifyPropertyChanged &&
- ( ! $newValue instanceof Proxy || $newValue->__isInitialized())
- ) {
- $newValue->addPropertyChangedListener($this);
- }
- $this->entityStates[$newValueOid] = self::STATE_MANAGED;
- // make sure that when an proxy is then finally loaded, $this->originalEntityData is set also!
- break;
- }
- $this->originalEntityData[$oid][$field] = $newValue;
- $class->reflFields[$field]->setValue($entity, $newValue);
- if ($assoc['inversedBy'] && $assoc['type'] & ClassMetadata::ONE_TO_ONE) {
- $inverseAssoc = $targetClass->associationMappings[$assoc['inversedBy']];
- $targetClass->reflFields[$inverseAssoc['fieldName']]->setValue($newValue, $entity);
- }
- break;
- default:
- // Inject collection
- $pColl = new PersistentCollection($this->em, $targetClass, new ArrayCollection);
- $pColl->setOwner($entity, $assoc);
- $pColl->setInitialized(false);
- $reflField = $class->reflFields[$field];
- $reflField->setValue($entity, $pColl);
- if ($assoc['fetch'] == ClassMetadata::FETCH_EAGER) {
- $this->loadCollection($pColl);
- $pColl->takeSnapshot();
- }
- $this->originalEntityData[$oid][$field] = $pColl;
- break;
- }
- }
- if ($overrideLocalValues) {
- $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::postLoad);
- if ($invoke !== ListenersInvoker::INVOKE_NONE) {
- $this->listenersInvoker->invoke($class, Events::postLoad, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
- }
- }
- return $entity;
- }
- /**
- * @return void
- */
- public function triggerEagerLoads()
- {
- if ( ! $this->eagerLoadingEntities) {
- return;
- }
- // avoid infinite recursion
- $eagerLoadingEntities = $this->eagerLoadingEntities;
- $this->eagerLoadingEntities = array();
- foreach ($eagerLoadingEntities as $entityName => $ids) {
- if ( ! $ids) {
- continue;
- }
- $class = $this->em->getClassMetadata($entityName);
- $this->getEntityPersister($entityName)->loadAll(
- array_combine($class->identifier, array(array_values($ids)))
- );
- }
- }
- /**
- * Initializes (loads) an uninitialized persistent collection of an entity.
- *
- * @param \Doctrine\ORM\PersistentCollection $collection The collection to initialize.
- *
- * @return void
- *
- * @todo Maybe later move to EntityManager#initialize($proxyOrCollection). See DDC-733.
- */
- public function loadCollection(PersistentCollection $collection)
- {
- $assoc = $collection->getMapping();
- $persister = $this->getEntityPersister($assoc['targetEntity']);
- switch ($assoc['type']) {
- case ClassMetadata::ONE_TO_MANY:
- $persister->loadOneToManyCollection($assoc, $collection->getOwner(), $collection);
- break;
- case ClassMetadata::MANY_TO_MANY:
- $persister->loadManyToManyCollection($assoc, $collection->getOwner(), $collection);
- break;
- }
- $collection->setInitialized(true);
- }
- /**
- * Gets the identity map of the UnitOfWork.
- *
- * @return array
- */
- public function getIdentityMap()
- {
- return $this->identityMap;
- }
- /**
- * Gets the original data of an entity. The original data is the data that was
- * present at the time the entity was reconstituted from the database.
- *
- * @param object $entity
- *
- * @return array
- */
- public function getOriginalEntityData($entity)
- {
- $oid = spl_object_hash($entity);
- if (isset($this->originalEntityData[$oid])) {
- return $this->originalEntityData[$oid];
- }
- return array();
- }
- /**
- * @ignore
- *
- * @param object $entity
- * @param array $data
- *
- * @return void
- */
- public function setOriginalEntityData($entity, array $data)
- {
- $this->originalEntityData[spl_object_hash($entity)] = $data;
- }
- /**
- * INTERNAL:
- * Sets a property value of the original data array of an entity.
- *
- * @ignore
- *
- * @param string $oid
- * @param string $property
- * @param mixed $value
- *
- * @return void
- */
- public function setOriginalEntityProperty($oid, $property, $value)
- {
- $this->originalEntityData[$oid][$property] = $value;
- }
- /**
- * Gets the identifier of an entity.
- * The returned value is always an array of identifier values. If the entity
- * has a composite identifier then the identifier values are in the same
- * order as the identifier field names as returned by ClassMetadata#getIdentifierFieldNames().
- *
- * @param object $entity
- *
- * @return array The identifier values.
- */
- public function getEntityIdentifier($entity)
- {
- return $this->entityIdentifiers[spl_object_hash($entity)];
- }
- /**
- * Processes an entity instance to extract their identifier values.
- *
- * @param object $entity The entity instance.
- *
- * @return mixed A scalar value.
- *
- * @throws \Doctrine\ORM\ORMInvalidArgumentException
- */
- public function getSingleIdentifierValue($entity)
- {
- $class = $this->em->getClassMetadata(get_class($entity));
- if ($class->isIdentifierComposite) {
- throw ORMInvalidArgumentException::invalidCompositeIdentifier();
- }
- $values = $this->isInIdentityMap($entity)
- ? $this->getEntityIdentifier($entity)
- : $class->getIdentifierValues($entity);
- return isset($values[$class->identifier[0]]) ? $values[$class->identifier[0]] : null;
- }
-
- /**
- * Tries to find an entity with the given identifier in the identity map of
- * this UnitOfWork.
- *
- * @param mixed $id The entity identifier to look for.
- * @param string $rootClassName The name of the root class of the mapped entity hierarchy.
- *
- * @return object|bool Returns the entity with the specified identifier if it exists in
- * this UnitOfWork, FALSE otherwise.
- */
- public function tryGetById($id, $rootClassName)
- {
- $idHash = implode(' ', (array) $id);
- if (isset($this->identityMap[$rootClassName][$idHash])) {
- return $this->identityMap[$rootClassName][$idHash];
- }
- return false;
- }
- /**
- * Schedules an entity for dirty-checking at commit-time.
- *
- * @param object $entity The entity to schedule for dirty-checking.
- *
- * @return void
- *
- * @todo Rename: scheduleForSynchronization
- */
- public function scheduleForDirtyCheck($entity)
- {
- $rootClassName = $this->em->getClassMetadata(get_class($entity))->rootEntityName;
- $this->scheduledForDirtyCheck[$rootClassName][spl_object_hash($entity)] = $entity;
- }
- /**
- * Checks whether the UnitOfWork has any pending insertions.
- *
- * @return boolean TRUE if this UnitOfWork has pending insertions, FALSE otherwise.
- */
- public function hasPendingInsertions()
- {
- return ! empty($this->entityInsertions);
- }
- /**
- * Calculates the size of the UnitOfWork. The size of the UnitOfWork is the
- * number of entities in the identity map.
- *
- * @return integer
- */
- public function size()
- {
- $countArray = array_map(function ($item) { return count($item); }, $this->identityMap);
- return array_sum($countArray);
- }
- /**
- * Gets the EntityPersister for an Entity.
- *
- * @param string $entityName The name of the Entity.
- *
- * @return \Doctrine\ORM\Persisters\BasicEntityPersister
- */
- public function getEntityPersister($entityName)
- {
- if (isset($this->persisters[$entityName])) {
- return $this->persisters[$entityName];
- }
- $class = $this->em->getClassMetadata($entityName);
- switch (true) {
- case ($class->isInheritanceTypeNone()):
- $persister = new Persisters\BasicEntityPersister($this->em, $class);
- break;
- case ($class->isInheritanceTypeSingleTable()):
- $persister = new Persisters\SingleTablePersister($this->em, $class);
- break;
- case ($class->isInheritanceTypeJoined()):
- $persister = new Persisters\JoinedSubclassPersister($this->em, $class);
- break;
- default:
- $persister = new Persisters\UnionSubclassPersister($this->em, $class);
- }
- $this->persisters[$entityName] = $persister;
- return $this->persisters[$entityName];
- }
- /**
- * Gets a collection persister for a collection-valued association.
- *
- * @param array $association
- *
- * @return \Doctrine\ORM\Persisters\AbstractCollectionPersister
- */
- public function getCollectionPersister(array $association)
- {
- $type = $association['type'];
- if (isset($this->collectionPersisters[$type])) {
- return $this->collectionPersisters[$type];
- }
- switch ($type) {
- case ClassMetadata::ONE_TO_MANY:
- $persister = new Persisters\OneToManyPersister($this->em);
- break;
- case ClassMetadata::MANY_TO_MANY:
- $persister = new Persisters\ManyToManyPersister($this->em);
- break;
- }
- $this->collectionPersisters[$type] = $persister;
- return $this->collectionPersisters[$type];
- }
- /**
- * INTERNAL:
- * Registers an entity as managed.
- *
- * @param object $entity The entity.
- * @param array $id The identifier values.
- * @param array $data The original entity data.
- *
- * @return void
- */
- public function registerManaged($entity, array $id, array $data)
- {
- $oid = spl_object_hash($entity);
- $this->entityIdentifiers[$oid] = $id;
- $this->entityStates[$oid] = self::STATE_MANAGED;
- $this->originalEntityData[$oid] = $data;
- $this->addToIdentityMap($entity);
- if ($entity instanceof NotifyPropertyChanged && ( ! $entity instanceof Proxy || $entity->__isInitialized())) {
- $entity->addPropertyChangedListener($this);
- }
- }
- /**
- * INTERNAL:
- * Clears the property changeset of the entity with the given OID.
- *
- * @param string $oid The entity's OID.
- *
- * @return void
- */
- public function clearEntityChangeSet($oid)
- {
- $this->entityChangeSets[$oid] = array();
- }
- /* PropertyChangedListener implementation */
- /**
- * Notifies this UnitOfWork of a property change in an entity.
- *
- * @param object $entity The entity that owns the property.
- * @param string $propertyName The name of the property that changed.
- * @param mixed $oldValue The old value of the property.
- * @param mixed $newValue The new value of the property.
- *
- * @return void
- */
- public function propertyChanged($entity, $propertyName, $oldValue, $newValue)
- {
- $oid = spl_object_hash($entity);
- $class = $this->em->getClassMetadata(get_class($entity));
- $isAssocField = isset($class->associationMappings[$propertyName]);
- if ( ! $isAssocField && ! isset($class->fieldMappings[$propertyName])) {
- return; // ignore non-persistent fields
- }
- // Update changeset and mark entity for synchronization
- $this->entityChangeSets[$oid][$propertyName] = array($oldValue, $newValue);
- if ( ! isset($this->scheduledForDirtyCheck[$class->rootEntityName][$oid])) {
- $this->scheduleForDirtyCheck($entity);
- }
- }
- /**
- * Gets the currently scheduled entity insertions in this UnitOfWork.
- *
- * @return array
- */
- public function getScheduledEntityInsertions()
- {
- return $this->entityInsertions;
- }
- /**
- * Gets the currently scheduled entity updates in this UnitOfWork.
- *
- * @return array
- */
- public function getScheduledEntityUpdates()
- {
- return $this->entityUpdates;
- }
- /**
- * Gets the currently scheduled entity deletions in this UnitOfWork.
- *
- * @return array
- */
- public function getScheduledEntityDeletions()
- {
- return $this->entityDeletions;
- }
- /**
- * Gets the currently scheduled complete collection deletions
- *
- * @return array
- */
- public function getScheduledCollectionDeletions()
- {
- return $this->collectionDeletions;
- }
- /**
- * Gets the currently scheduled collection inserts, updates and deletes.
- *
- * @return array
- */
- public function getScheduledCollectionUpdates()
- {
- return $this->collectionUpdates;
- }
- /**
- * Helper method to initialize a lazy loading proxy or persistent collection.
- *
- * @param object $obj
- *
- * @return void
- */
- public function initializeObject($obj)
- {
- if ($obj instanceof Proxy) {
- $obj->__load();
- return;
- }
- if ($obj instanceof PersistentCollection) {
- $obj->initialize();
- }
- }
- /**
- * Helper method to show an object as string.
- *
- * @param object $obj
- *
- * @return string
- */
- private static function objToStr($obj)
- {
- return method_exists($obj, '__toString') ? (string)$obj : get_class($obj).'@'.spl_object_hash($obj);
- }
- /**
- * Marks an entity as read-only so that it will not be considered for updates during UnitOfWork#commit().
- *
- * This operation cannot be undone as some parts of the UnitOfWork now keep gathering information
- * on this object that might be necessary to perform a correct update.
- *
- * @param object $object
- *
- * @return void
- *
- * @throws ORMInvalidArgumentException
- */
- public function markReadOnly($object)
- {
- if ( ! is_object($object) || ! $this->isInIdentityMap($object)) {
- throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
- }
- $this->readOnlyObjects[spl_object_hash($object)] = true;
- }
- /**
- * Is this entity read only?
- *
- * @param object $object
- *
- * @return bool
- *
- * @throws ORMInvalidArgumentException
- */
- public function isReadOnly($object)
- {
- if ( ! is_object($object)) {
- throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
- }
- return isset($this->readOnlyObjects[spl_object_hash($object)]);
- }
- private function dispatchOnFlushEvent()
- {
- if ($this->evm->hasListeners(Events::onFlush)) {
- $this->evm->dispatchEvent(Events::onFlush, new OnFlushEventArgs($this->em));
- }
- }
- private function dispatchPostFlushEvent()
- {
- if ($this->evm->hasListeners(Events::postFlush)) {
- $this->evm->dispatchEvent(Events::postFlush, new PostFlushEventArgs($this->em));
- }
- }
- /**
- * Verifies if two given entities actually are the same based on identifier comparison
- *
- * @param object $entity1
- * @param object $entity2
- *
- * @return bool
- */
- private function isIdentifierEquals($entity1, $entity2)
- {
- if ($entity1 === $entity2) {
- return true;
- }
- $class = $this->em->getClassMetadata(get_class($entity1));
- if ($class !== $this->em->getClassMetadata(get_class($entity2))) {
- return false;
- }
- $oid1 = spl_object_hash($entity1);
- $oid2 = spl_object_hash($entity2);
- $id1 = isset($this->entityIdentifiers[$oid1])
- ? $this->entityIdentifiers[$oid1]
- : $this->flattenIdentifier($class, $class->getIdentifierValues($entity1));
- $id2 = isset($this->entityIdentifiers[$oid2])
- ? $this->entityIdentifiers[$oid2]
- : $this->flattenIdentifier($class, $class->getIdentifierValues($entity2));
- return $id1 === $id2 || implode(' ', $id1) === implode(' ', $id2);
- }
- }
|