.scrutinizer.yml000064400000001766144760123070007744 0ustar00build: nodes: analysis: environment: php: version: 7.1 cache: disabled: false directories: - ~/.composer/cache project_setup: override: true tests: override: - php-scrutinizer-run - phpcs-run dependencies: override: - composer install -noa tools: external_code_coverage: timeout: 600 build_failure_conditions: - 'elements.rating(<= C).new.exists' # No new classes/methods with a rating of C or worse allowed - 'issues.label("coding-style").new.exists' # No new coding style issues allowed - 'issues.severity(>= MAJOR).new.exists' # New issues of major or higher severity - 'project.metric_change("scrutinizer.test_coverage", < 0)' # Code Coverage decreased from previous inspection LICENSE000064400000002051144760123070005553 0ustar00Copyright (c) 2006-2015 Doctrine Project Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. README.md000064400000001473144760123070006034 0ustar00# Doctrine Persistence [![Build Status](https://travis-ci.org/doctrine/persistence.svg)](https://travis-ci.org/doctrine/persistence) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/doctrine/persistence/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/doctrine/persistence/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/doctrine/persistence/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/doctrine/persistence/?branch=master) The Doctrine Persistence project is a library that provides common abstractions for object mapper persistence. ## More resources: * [Website](https://www.doctrine-project.org/) * [Documentation](https://www.doctrine-project.org/projects/doctrine-persistence/en/latest/index.html) * [Downloads](https://github.com/doctrine/persistence/releases) composer.json000064400000002657144760123070007304 0ustar00{ "name": "doctrine/persistence", "type": "library", "description": "Doctrine Persistence abstractions.", "keywords": ["persistence"], "homepage": "https://doctrine-project.org/projects/persistence.html", "license": "MIT", "authors": [ {"name": "Guilherme Blanco", "email": "guilhermeblanco@gmail.com"}, {"name": "Roman Borschel", "email": "roman@code-factory.org"}, {"name": "Benjamin Eberlei", "email": "kontakt@beberlei.de"}, {"name": "Jonathan Wage", "email": "jonwage@gmail.com"}, {"name": "Johannes Schmitt", "email": "schmittjoh@gmail.com"}, {"name": "Marco Pivetta", "email": "ocramius@gmail.com"} ], "require": { "php": "^7.1", "doctrine/annotations": "^1.0", "doctrine/cache": "^1.0", "doctrine/collections": "^1.0", "doctrine/event-manager": "^1.0", "doctrine/reflection": "^1.0" }, "require-dev": { "phpstan/phpstan": "^0.8", "doctrine/coding-standard": "^4.0", "phpunit/phpunit": "^7.0" }, "conflict": { "doctrine/common": "<2.9@dev" }, "autoload": { "psr-4": { "Doctrine\\Common\\": "lib/Doctrine/Common" } }, "autoload-dev": { "psr-4": { "Doctrine\\Tests\\": "tests/Doctrine/Tests" } }, "extra": { "branch-alias": { "dev-master": "1.0.x-dev" } } } docs/en/index.rst000064400000001634144760123070007747 0ustar00Persistence Documentation ========================= The Doctrine Persistence documentation is a reference guide to everything you need to know about the project. Getting Help ------------ If this documentation is not helping to answer questions you have about the Doctrine Persistence project, don't panic. You can get help from different sources: - Gitter chat room `#doctrine/persistence `_ - On `Stack Overflow `_ - The `Doctrine Mailing List `_ - Report a bug on `GitHub `_. Getting Started --------------- The best way to get started is with the :doc:`Introduction ` section in the documentation. Use the sidebar to browse other documentation for the Doctrine Persistence project. docs/en/reference/index.rst000064400000026713144760123070011712 0ustar00Introduction ============ The Doctrine Persistence project is a set of shared interfaces and functionality that the different Doctrine object mappers share. You can use these interfaces and abstract classes to build your own mapper if you don't want to use the full data mappers provided by Doctrine. Installation ============ The library can easily be installed with composer. .. code-block:: sh $ composer require doctrine/persistence Overview ======== The interfaces and functionality in this project evolved from building several different implementations of Doctrine object mappers. The first implementation was the ORM_ then came the `MongoDB ODM`_. A set of common interfaces were extracted from both projects and released in the `Doctrine Common`_ project. Over the years, more common functionality was extracted and eventually moved to this standalone project. A Doctrine object mapper looks like this when implemented. .. code-block:: php final class User { /** @var string */ private $username; public function __construct(string $username) { $this->username = $username; } // ... } $objectManager = new ObjectManager(); $userRepository = $objectManager->getRepository(User::class); $newUser = new User('jwage'); $objectManager->persist($newUser); $objectManager->flush(); $user = $objectManager->find(User::class, 1); $objectManager->remove($user); $objectManager->flush(); $users = $userRepository->findAll(); To learn more about the full interfaces and functionality continue reading! Object Manager ============== The main public interface that an end user will use is the ``Doctrine\Common\Persistence\ObjectManager`` interface. .. code-block:: php namespace Doctrine\Common\Persistence; interface ObjectManager { public function find($className, $id); public function persist($object); public function remove($object); public function merge($object); public function clear($objectName = null); public function detach($object); public function refresh($object); public function flush(); public function getRepository($className); public function getClassMetadata($className); public function getMetadataFactory(); public function initializeObject($obj); public function contains($object); } ObjectRepository ================ The object repository is used to retrieve instances of your mapped objects from the mapper. .. code-block:: php namespace Doctrine\Common\Persistence; interface ObjectRepository { public function find($id); public function findAll(); public function findBy(array $criteria, ?array $orderBy = null, $limit = null, $offset = null); public function findOneBy(array $criteria); public function getClassName(); } Mapping ======= In order for Doctrine to be able to persist your objects to a data store, you have to map the classes and class properties so they can be properly stored and retrieved while maintaining a consistent state. ClassMetadata ------------- .. code-block:: php namespace Doctrine\Common\Persistence\Mapping; interface ClassMetadata { public function getName(); public function getIdentifier(); public function getReflectionClass(); public function isIdentifier($fieldName); public function hasField($fieldName); public function hasAssociation($fieldName); public function isSingleValuedAssociation($fieldName); public function isCollectionValuedAssociation($fieldName); public function getFieldNames(); public function getIdentifierFieldNames(); public function getAssociationNames(); public function getTypeOfField($fieldName); public function getAssociationTargetClass($assocName); public function isAssociationInverseSide($assocName); public function getAssociationMappedByTargetField($assocName); public function getIdentifierValues($object); } ClassMetadataFactory -------------------- The ``Doctrine\Common\Persistence\Mapping\ClassMetadataFactory`` class can be used to manage the instances for each of your mapped PHP classes. .. code-block:: php namespace Doctrine\Common\Persistence\Mapping; interface ClassMetadataFactory { public function getAllMetadata(); public function getMetadataFor($className); public function hasMetadataFor($className); public function setMetadataFor($className, $class); public function isTransient($className); } Mapping Driver ============== In order to load ``ClassMetadata`` instances you can use the ``Doctrine\Common\Persistence\Mapping\Driver\MappingDriver`` interface. This is the interface that does the core loading of mapping information from wherever they are stored. That may be in files, annotations, yaml, xml, etc. .. code-block:: php namespace Doctrine\Common\Persistence\Mapping\Driver; use Doctrine\Common\Persistence\Mapping\ClassMetadata; interface MappingDriver { public function loadMetadataForClass($className, ClassMetadata $metadata); public function getAllClassNames(); public function isTransient($className); } The Doctrine Persistence project offers a few base implementations that make it easy to implement your own XML, Annotations or YAML drivers. FileDriver ---------- The file driver operates in a mode where it loads the mapping files of individual classes on demand. This requires the user to adhere to the convention of 1 mapping file per class and the file names of the mapping files must correspond to the full class name, including namespace, with the namespace delimiters '\', replaced by dots '.'. Extend the ``Doctrine\Common\Persistence\Mapping\Driver\FileDriver`` class to implement your own file driver. Here is an example JSON file driver implementation. .. code-block:: php use Doctrine\Common\Persistence\Mapping\Driver\FileDriver; final class JSONFileDriver extends FileDriver { public function loadMetadataForClass($className, ClassMetadata $metadata) { $mappingFileData = $this->getElement($className); // use the array of mapping information from the file to populate the $metadata instance } protected function loadMappingFile($file) { return json_decode($file, true); } } Now you can use it like the following. .. code-block:: php use Doctrine\Common\Persistence\Mapping\Driver\DefaultFileLocator; $fileLocator = new DefaultFileLocator('/path/to/mapping/files', 'json'); $jsonFileDriver = new JSONFileDriver($fileLocator); Now if you have a class named ``App\Model\User`` and you can load the mapping information like this. .. code-block:: php use App\Model\User; use Doctrine\Common\Persistence\Mapping\ClassMetadata; $classMetadata = new ClassMetadata(); // looks for a file at /path/to/mapping/files/App.Model.User.json $jsonFileDriver->loadMetadataForClass(User::class, $classMetadata); AnnotationDriver ---------------- .. note:: This driver requires the ``doctrine/annotations`` project. You can install it with composer. .. code-block:: php composer require doctrine/annotations The AnnotationDriver reads the mapping metadata from docblock annotations. .. code-block:: php final class MyAnnotationDriver extends AnnotationDriver { public function loadMetadataForClass($className, ClassMetadata $metadata) { /** @var ClassMetadata $class */ $reflClass = $class->getReflectionClass(); $classAnnotations = $this->reader->getClassAnnotations($reflClass); // Use the reader to read annotations from your classes to then populate the $metadata instance. } } Now you can use it like the following: .. code-block:: php use App\Model\User; use Doctrine\Common\Annotations\AnnotationReader; use Doctrine\Common\Persistence\Mapping\ClassMetadata; $annotationReader = new AnnotationReader(); $annotationDriver = new AnnotationDriver($annotationReader, '/path/to/classes/with/annotations'); $classMetadata = new ClassMetadata(); // looks for a PHP file at /path/to/classes/with/annotations/App/Model/User.php $annotationDriver->loadMetadataForClass(User::class, $classMetadata); PHPDriver --------- The PHPDriver includes PHP files which just populate ``ClassMetadata`` instances with plain PHP code. .. code-block:: php use Doctrine\Common\Persistence\Mapping\Driver\PHPDriver; $phpDriver = new PHPDriver('/path/to/mapping/files'); Now you can use it like the following: .. code-block:: php use App\Model\User; use Doctrine\Common\Persistence\Mapping\ClassMetadata; $classMetadata = new ClassMetadata(); // looks for a PHP file at /path/to/mapping/files/App.Model.User.php $phpDriver->loadMetadataForClass(User::class, $classMetadata); Inside the ``/path/to/mapping/files/App.Model.User.php`` file you can write raw PHP code to populate a ``ClassMetadata`` instance. You will have access to a variable named ``$metadata`` inside the file that you can use to populate the mapping metadata. .. code-block:: php use App\Model\User; $metadata->name = User::class; // ... StaticPHPDriver -------------- The StaticPHPDriver calls a static ``loadMetadata()`` method on your model classes where you can manually populate the ``ClassMetadata`` instance. .. code-block:: php $staticPHPDriver = new StaticPHPDriver('/path/to/classes'); $classMetadata = new ClassMetadata(); // looks for a PHP file at /path/to/classes/App/Model/User.php $phpDriver->loadMetadataForClass(User::class, $classMetadata); Your class in ``App\Model\User`` would look like the following. .. code-block:: php namespace App\Model; final class User { // ... public static function loadMetadata(ClassMetadata $metadata) { // populate the $metadata instance } } Reflection ========== Doctrine uses reflection to set and get the data inside your objects. The ``Doctrine\Common\Persistence\Mapping\ReflectionService`` is the primary interface needed for a Doctrine mapper. .. code-block:: php namespace Doctrine\Common\Persistence\Mapping; interface ReflectionService { public function getParentClasses($class); public function getClassShortName($class); public function getClassNamespace($class); public function getClass($class); public function getAccessibleProperty($class, $property); public function hasPublicMethod($class, $method); } Doctrine provides an implementation of this interface in the class named ``Doctrine\Common\Persistence\Mapping\RuntimeReflectionService``. Implementations =============== There are several different implementations of the Doctrine Persistence APIs. - ORM_ - The Doctrine Object Relational Mapper is a data mapper for relational databases. - `MongoDB ODM`_ - The Doctrine MongoDB ODM is a data mapper for MongoDB. - `PHPCR ODM`_ - The Doctrine PHPCR ODM a data mapper built on top of the PHPCR API. .. _ORM: https://www.doctrine-project.org/projects/orm.html .. _MongoDB ODM: https://www.doctrine-project.org/projects/mongodb-odm.html .. _PHPCR ODM: https://www.doctrine-project.org/projects/phpcr-odm.html .. _Doctrine Common: https://www.doctrine-project.org/projects/common.html docs/en/sidebar.rst000064400000000060144760123070010241 0ustar00.. toctree:: :depth: 3 reference/index lib/Doctrine/Common/Persistence/AbstractManagerRegistry.php000064400000013007144760123070020102 0ustar00name = $name; $this->connections = $connections; $this->managers = $managers; $this->defaultConnection = $defaultConnection; $this->defaultManager = $defaultManager; $this->proxyInterfaceName = $proxyInterfaceName; } /** * Fetches/creates the given services. * * A service in this context is connection or a manager instance. * * @param string $name The name of the service. * * @return object The instance of the given service. */ abstract protected function getService($name); /** * Resets the given services. * * A service in this context is connection or a manager instance. * * @param string $name The name of the service. * * @return void */ abstract protected function resetService($name); /** * Gets the name of the registry. * * @return string */ public function getName() { return $this->name; } /** * {@inheritdoc} */ public function getConnection($name = null) { if ($name === null) { $name = $this->defaultConnection; } if (! isset($this->connections[$name])) { throw new \InvalidArgumentException(sprintf('Doctrine %s Connection named "%s" does not exist.', $this->name, $name)); } return $this->getService($this->connections[$name]); } /** * {@inheritdoc} */ public function getConnectionNames() { return $this->connections; } /** * {@inheritdoc} */ public function getConnections() { $connections = []; foreach ($this->connections as $name => $id) { $connections[$name] = $this->getService($id); } return $connections; } /** * {@inheritdoc} */ public function getDefaultConnectionName() { return $this->defaultConnection; } /** * {@inheritdoc} */ public function getDefaultManagerName() { return $this->defaultManager; } /** * {@inheritdoc} * * @throws \InvalidArgumentException */ public function getManager($name = null) { if ($name === null) { $name = $this->defaultManager; } if (! isset($this->managers[$name])) { throw new \InvalidArgumentException(sprintf('Doctrine %s Manager named "%s" does not exist.', $this->name, $name)); } return $this->getService($this->managers[$name]); } /** * {@inheritdoc} */ public function getManagerForClass($class) { // Check for namespace alias if (strpos($class, ':') !== false) { list($namespaceAlias, $simpleClassName) = explode(':', $class, 2); $class = $this->getAliasNamespace($namespaceAlias) . '\\' . $simpleClassName; } $proxyClass = new \ReflectionClass($class); if ($proxyClass->implementsInterface($this->proxyInterfaceName)) { $parentClass = $proxyClass->getParentClass(); if (! $parentClass) { return null; } $class = $parentClass->getName(); } foreach ($this->managers as $id) { $manager = $this->getService($id); if (! $manager->getMetadataFactory()->isTransient($class)) { return $manager; } } } /** * {@inheritdoc} */ public function getManagerNames() { return $this->managers; } /** * {@inheritdoc} */ public function getManagers() { $dms = []; foreach ($this->managers as $name => $id) { $dms[$name] = $this->getService($id); } return $dms; } /** * {@inheritdoc} */ public function getRepository($persistentObjectName, $persistentManagerName = null) { return $this->getManager($persistentManagerName)->getRepository($persistentObjectName); } /** * {@inheritdoc} */ public function resetManager($name = null) { if ($name === null) { $name = $this->defaultManager; } if (! isset($this->managers[$name])) { throw new \InvalidArgumentException(sprintf('Doctrine %s Manager named "%s" does not exist.', $this->name, $name)); } // force the creation of a new document manager // if the current one is closed $this->resetService($this->managers[$name]); return $this->getManager($name); } } lib/Doctrine/Common/Persistence/ConnectionRegistry.php000064400000001571144760123070017146 0ustar00object = $object; $this->objectManager = $objectManager; } /** * Retrieves the associated entity. * * @deprecated * * @return object */ public function getEntity() { return $this->object; } /** * Retrieves the associated object. * * @return object */ public function getObject() { return $this->object; } /** * Retrieves the associated ObjectManager. * * @return ObjectManager */ public function getObjectManager() { return $this->objectManager; } } lib/Doctrine/Common/Persistence/Event/LoadClassMetadataEventArgs.php000064400000001754144760123070021527 0ustar00classMetadata = $classMetadata; $this->objectManager = $objectManager; } /** * Retrieves the associated ClassMetadata. * * @return ClassMetadata */ public function getClassMetadata() { return $this->classMetadata; } /** * Retrieves the associated ObjectManager. * * @return ObjectManager */ public function getObjectManager() { return $this->objectManager; } } lib/Doctrine/Common/Persistence/Event/ManagerEventArgs.php000064400000001135144760123070017564 0ustar00objectManager = $objectManager; } /** * Retrieves the associated ObjectManager. * * @return ObjectManager */ public function getObjectManager() { return $this->objectManager; } } lib/Doctrine/Common/Persistence/Event/OnClearEventArgs.php000064400000002377144760123070017546 0ustar00objectManager = $objectManager; $this->entityClass = $entityClass; } /** * Retrieves the associated ObjectManager. * * @return ObjectManager */ public function getObjectManager() { return $this->objectManager; } /** * Returns the name of the entity class that is cleared, or null if all are cleared. * * @return string|null */ public function getEntityClass() { return $this->entityClass; } /** * Returns whether this event clears all entities. * * @return bool */ public function clearsAllEntities() { return $this->entityClass === null; } } lib/Doctrine/Common/Persistence/Event/PreUpdateEventArgs.php000064400000004602144760123070020105 0ustar00entityChangeSet = &$changeSet; } /** * Retrieves the entity changeset. * * @return mixed[][] */ public function getEntityChangeSet() { return $this->entityChangeSet; } /** * Checks if field has a changeset. * * @param string $field * * @return bool */ public function hasChangedField($field) { return isset($this->entityChangeSet[$field]); } /** * Gets the old value of the changeset of the changed field. * * @param string $field * * @return mixed */ public function getOldValue($field) { $this->assertValidField($field); return $this->entityChangeSet[$field][0]; } /** * Gets the new value of the changeset of the changed field. * * @param string $field * * @return mixed */ public function getNewValue($field) { $this->assertValidField($field); return $this->entityChangeSet[$field][1]; } /** * Sets the new value of this field. * * @param string $field * @param mixed $value * * @return void */ public function setNewValue($field, $value) { $this->assertValidField($field); $this->entityChangeSet[$field][1] = $value; } /** * Asserts the field exists in changeset. * * @param string $field * * @return void * * @throws \InvalidArgumentException */ private function assertValidField($field) { if (! isset($this->entityChangeSet[$field])) { throw new \InvalidArgumentException(sprintf( 'Field "%s" is not a valid field of the entity "%s" in PreUpdateEventArgs.', $field, get_class($this->getObject()) )); } } } lib/Doctrine/Common/Persistence/ManagerRegistry.php000064400000005071144760123070016420 0ustar00cacheDriver = $cacheDriver; } /** * Gets the cache driver used by the factory to cache ClassMetadata instances. * * @return Cache|null */ public function getCacheDriver() { return $this->cacheDriver; } /** * Returns an array of all the loaded metadata currently in memory. * * @return ClassMetadata[] */ public function getLoadedMetadata() { return $this->loadedMetadata; } /** * Forces the factory to load the metadata of all classes known to the underlying * mapping driver. * * @return ClassMetadata[] The ClassMetadata instances of all mapped classes. */ public function getAllMetadata() { if (! $this->initialized) { $this->initialize(); } $driver = $this->getDriver(); $metadata = []; foreach ($driver->getAllClassNames() as $className) { $metadata[] = $this->getMetadataFor($className); } return $metadata; } /** * Lazy initialization of this stuff, especially the metadata driver, * since these are not needed at all when a metadata cache is active. * * @return void */ abstract protected function initialize(); /** * Gets the fully qualified class-name from the namespace alias. * * @param string $namespaceAlias * @param string $simpleClassName * * @return string */ abstract protected function getFqcnFromAlias($namespaceAlias, $simpleClassName); /** * Returns the mapping driver implementation. * * @return MappingDriver */ abstract protected function getDriver(); /** * Wakes up reflection after ClassMetadata gets unserialized from cache. * * @return void */ abstract protected function wakeupReflection(ClassMetadata $class, ReflectionService $reflService); /** * Initializes Reflection after ClassMetadata was constructed. * * @return void */ abstract protected function initializeReflection(ClassMetadata $class, ReflectionService $reflService); /** * Checks whether the class metadata is an entity. * * This method should return false for mapped superclasses or embedded classes. * * @return bool */ abstract protected function isEntity(ClassMetadata $class); /** * Gets the class metadata descriptor for a class. * * @param string $className The name of the class. * * @return ClassMetadata * * @throws ReflectionException * @throws MappingException */ public function getMetadataFor($className) { if (isset($this->loadedMetadata[$className])) { return $this->loadedMetadata[$className]; } // Check for namespace alias if (strpos($className, ':') !== false) { list($namespaceAlias, $simpleClassName) = explode(':', $className, 2); $realClassName = $this->getFqcnFromAlias($namespaceAlias, $simpleClassName); } else { $realClassName = $this->getRealClass($className); } if (isset($this->loadedMetadata[$realClassName])) { // We do not have the alias name in the map, include it return $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName]; } $loadingException = null; try { if ($this->cacheDriver) { $cached = $this->cacheDriver->fetch($realClassName . $this->cacheSalt); if ($cached instanceof ClassMetadata) { $this->loadedMetadata[$realClassName] = $cached; $this->wakeupReflection($cached, $this->getReflectionService()); } else { foreach ($this->loadMetadata($realClassName) as $loadedClassName) { $this->cacheDriver->save( $loadedClassName . $this->cacheSalt, $this->loadedMetadata[$loadedClassName], null ); } } } else { $this->loadMetadata($realClassName); } } catch (MappingException $loadingException) { $fallbackMetadataResponse = $this->onNotFoundMetadata($realClassName); if (! $fallbackMetadataResponse) { throw $loadingException; } $this->loadedMetadata[$realClassName] = $fallbackMetadataResponse; } if ($className !== $realClassName) { // We do not have the alias name in the map, include it $this->loadedMetadata[$className] = $this->loadedMetadata[$realClassName]; } return $this->loadedMetadata[$className]; } /** * Checks whether the factory has the metadata for a class loaded already. * * @param string $className * * @return bool TRUE if the metadata of the class in question is already loaded, FALSE otherwise. */ public function hasMetadataFor($className) { return isset($this->loadedMetadata[$className]); } /** * Sets the metadata descriptor for a specific class. * * NOTE: This is only useful in very special cases, like when generating proxy classes. * * @param string $className * @param ClassMetadata $class * * @return void */ public function setMetadataFor($className, $class) { $this->loadedMetadata[$className] = $class; } /** * Gets an array of parent classes for the given entity class. * * @param string $name * * @return string[] */ protected function getParentClasses($name) { // Collect parent classes, ignoring transient (not-mapped) classes. $parentClasses = []; foreach (array_reverse($this->getReflectionService()->getParentClasses($name)) as $parentClass) { if ($this->getDriver()->isTransient($parentClass)) { continue; } $parentClasses[] = $parentClass; } return $parentClasses; } /** * Loads the metadata of the class in question and all it's ancestors whose metadata * is still not loaded. * * Important: The class $name does not necessarily exist at this point here. * Scenarios in a code-generation setup might have access to XML/YAML * Mapping files without the actual PHP code existing here. That is why the * {@see Doctrine\Common\Persistence\Mapping\ReflectionService} interface * should be used for reflection. * * @param string $name The name of the class for which the metadata should get loaded. * * @return string[] */ protected function loadMetadata($name) { if (! $this->initialized) { $this->initialize(); } $loaded = []; $parentClasses = $this->getParentClasses($name); $parentClasses[] = $name; // Move down the hierarchy of parent classes, starting from the topmost class $parent = null; $rootEntityFound = false; $visited = []; $reflService = $this->getReflectionService(); foreach ($parentClasses as $className) { if (isset($this->loadedMetadata[$className])) { $parent = $this->loadedMetadata[$className]; if ($this->isEntity($parent)) { $rootEntityFound = true; array_unshift($visited, $className); } continue; } $class = $this->newClassMetadataInstance($className); $this->initializeReflection($class, $reflService); $this->doLoadMetadata($class, $parent, $rootEntityFound, $visited); $this->loadedMetadata[$className] = $class; $parent = $class; if ($this->isEntity($class)) { $rootEntityFound = true; array_unshift($visited, $className); } $this->wakeupReflection($class, $reflService); $loaded[] = $className; } return $loaded; } /** * Provides a fallback hook for loading metadata when loading failed due to reflection/mapping exceptions * * Override this method to implement a fallback strategy for failed metadata loading * * @param string $className * * @return ClassMetadata|null */ protected function onNotFoundMetadata($className) { return null; } /** * Actually loads the metadata from the underlying metadata. * * @param ClassMetadata $class * @param ClassMetadata|null $parent * @param bool $rootEntityFound * @param string[] $nonSuperclassParents All parent class names * that are not marked as mapped superclasses. * @return void */ abstract protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents); /** * Creates a new ClassMetadata instance for the given class name. * * @param string $className * * @return ClassMetadata */ abstract protected function newClassMetadataInstance($className); /** * {@inheritDoc} */ public function isTransient($class) { if (! $this->initialized) { $this->initialize(); } // Check for namespace alias if (strpos($class, ':') !== false) { list($namespaceAlias, $simpleClassName) = explode(':', $class, 2); $class = $this->getFqcnFromAlias($namespaceAlias, $simpleClassName); } return $this->getDriver()->isTransient($class); } /** * Sets the reflectionService. * * @return void */ public function setReflectionService(ReflectionService $reflectionService) { $this->reflectionService = $reflectionService; } /** * Gets the reflection service associated with this metadata factory. * * @return ReflectionService */ public function getReflectionService() { if ($this->reflectionService === null) { $this->reflectionService = new RuntimeReflectionService(); } return $this->reflectionService; } /** * Gets the real class name of a class name that could be a proxy. */ private function getRealClass(string $class) : string { $pos = strrpos($class, '\\' . Proxy::MARKER . '\\'); if ($pos === false) { return $class; } return substr($class, $pos + Proxy::MARKER_LENGTH + 2); } } lib/Doctrine/Common/Persistence/Mapping/ClassMetadata.php000064400000007163144760123070017422 0ustar00reader = $reader; if (! $paths) { return; } $this->addPaths((array) $paths); } /** * Appends lookup paths to metadata driver. * * @param string[] $paths * * @return void */ public function addPaths(array $paths) { $this->paths = array_unique(array_merge($this->paths, $paths)); } /** * Retrieves the defined metadata lookup paths. * * @return string[] */ public function getPaths() { return $this->paths; } /** * Append exclude lookup paths to metadata driver. * * @param string[] $paths */ public function addExcludePaths(array $paths) { $this->excludePaths = array_unique(array_merge($this->excludePaths, $paths)); } /** * Retrieve the defined metadata lookup exclude paths. * * @return string[] */ public function getExcludePaths() { return $this->excludePaths; } /** * Retrieve the current annotation reader * * @return Reader */ public function getReader() { return $this->reader; } /** * Gets the file extension used to look for mapping files under. * * @return string */ public function getFileExtension() { return $this->fileExtension; } /** * Sets the file extension used to look for mapping files under. * * @param string $fileExtension The file extension to set. * * @return void */ public function setFileExtension($fileExtension) { $this->fileExtension = $fileExtension; } /** * Returns whether the class with the specified name is transient. Only non-transient * classes, that is entities and mapped superclasses, should have their metadata loaded. * * A class is non-transient if it is annotated with an annotation * from the {@see AnnotationDriver::entityAnnotationClasses}. * * @param string $className * * @return bool */ public function isTransient($className) { $classAnnotations = $this->reader->getClassAnnotations(new \ReflectionClass($className)); foreach ($classAnnotations as $annot) { if (isset($this->entityAnnotationClasses[get_class($annot)])) { return false; } } return true; } /** * {@inheritDoc} */ public function getAllClassNames() { if ($this->classNames !== null) { return $this->classNames; } if (! $this->paths) { throw MappingException::pathRequired(); } $classes = []; $includedFiles = []; foreach ($this->paths as $path) { if (! is_dir($path)) { throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path); } $iterator = new \RegexIterator( new \RecursiveIteratorIterator( new \RecursiveDirectoryIterator($path, \FilesystemIterator::SKIP_DOTS), \RecursiveIteratorIterator::LEAVES_ONLY ), '/^.+' . preg_quote($this->fileExtension) . '$/i', \RecursiveRegexIterator::GET_MATCH ); foreach ($iterator as $file) { $sourceFile = $file[0]; if (! preg_match('(^phar:)i', $sourceFile)) { $sourceFile = realpath($sourceFile); } foreach ($this->excludePaths as $excludePath) { $exclude = str_replace('\\', '/', realpath($excludePath)); $current = str_replace('\\', '/', $sourceFile); if (strpos($current, $exclude) !== false) { continue 2; } } require_once $sourceFile; $includedFiles[] = $sourceFile; } } $declared = get_declared_classes(); foreach ($declared as $className) { $rc = new \ReflectionClass($className); $sourceFile = $rc->getFileName(); if (! in_array($sourceFile, $includedFiles) || $this->isTransient($className)) { continue; } $classes[] = $className; } $this->classNames = $classes; return $classes; } } lib/Doctrine/Common/Persistence/Mapping/Driver/DefaultFileLocator.php000064400000010223144760123070021646 0ustar00addPaths((array) $paths); $this->fileExtension = $fileExtension; } /** * Appends lookup paths to metadata driver. * * @param string[] $paths * * @return void */ public function addPaths(array $paths) { $this->paths = array_unique(array_merge($this->paths, $paths)); } /** * Retrieves the defined metadata lookup paths. * * @return string[] */ public function getPaths() { return $this->paths; } /** * Gets the file extension used to look for mapping files under. * * @return string|null */ public function getFileExtension() { return $this->fileExtension; } /** * Sets the file extension used to look for mapping files under. * * @param string|null $fileExtension The file extension to set. * * @return void */ public function setFileExtension($fileExtension) { $this->fileExtension = $fileExtension; } /** * {@inheritDoc} */ public function findMappingFile($className) { $fileName = str_replace('\\', '.', $className) . $this->fileExtension; // Check whether file exists foreach ($this->paths as $path) { if (is_file($path . DIRECTORY_SEPARATOR . $fileName)) { return $path . DIRECTORY_SEPARATOR . $fileName; } } throw MappingException::mappingFileNotFound($className, $fileName); } /** * {@inheritDoc} */ public function getAllClassNames($globalBasename) { $classes = []; if ($this->paths) { foreach ($this->paths as $path) { if (! is_dir($path)) { throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path); } $iterator = new \RecursiveIteratorIterator( new \RecursiveDirectoryIterator($path), \RecursiveIteratorIterator::LEAVES_ONLY ); foreach ($iterator as $file) { $fileName = $file->getBasename($this->fileExtension); if ($fileName === $file->getBasename() || $fileName === $globalBasename) { continue; } // NOTE: All files found here means classes are not transient! $classes[] = str_replace('.', '\\', $fileName); } } } return $classes; } /** * {@inheritDoc} */ public function fileExists($className) { $fileName = str_replace('\\', '.', $className) . $this->fileExtension; // Check whether file exists foreach ((array) $this->paths as $path) { if (is_file($path . DIRECTORY_SEPARATOR . $fileName)) { return true; } } return false; } } lib/Doctrine/Common/Persistence/Mapping/Driver/FileDriver.php000064400000012426144760123070020200 0ustar00locator = $locator; } else { $this->locator = new DefaultFileLocator((array) $locator, $fileExtension); } } /** * Sets the global basename. * * @param string $file * * @return void */ public function setGlobalBasename($file) { $this->globalBasename = $file; } /** * Retrieves the global basename. * * @return string|null */ public function getGlobalBasename() { return $this->globalBasename; } /** * Gets the element of schema meta data for the class from the mapping file. * This will lazily load the mapping file if it is not loaded yet. * * @param string $className * * @return ClassMetadata The element of schema meta data. * * @throws MappingException */ public function getElement($className) { if ($this->classCache === null) { $this->initialize(); } if (isset($this->classCache[$className])) { return $this->classCache[$className]; } $result = $this->loadMappingFile($this->locator->findMappingFile($className)); if (! isset($result[$className])) { throw MappingException::invalidMappingFile($className, str_replace('\\', '.', $className) . $this->locator->getFileExtension()); } $this->classCache[$className] = $result[$className]; return $result[$className]; } /** * {@inheritDoc} */ public function isTransient($className) { if ($this->classCache === null) { $this->initialize(); } if (isset($this->classCache[$className])) { return false; } return ! $this->locator->fileExists($className); } /** * {@inheritDoc} */ public function getAllClassNames() { if ($this->classCache === null) { $this->initialize(); } if (! $this->classCache) { return (array) $this->locator->getAllClassNames($this->globalBasename); } return array_merge( array_keys($this->classCache), (array) $this->locator->getAllClassNames($this->globalBasename) ); } /** * Loads a mapping file with the given name and returns a map * from class/entity names to their corresponding file driver elements. * * @param string $file The mapping file to load. * * @return ClassMetadata[] */ abstract protected function loadMappingFile($file); /** * Initializes the class cache from all the global files. * * Using this feature adds a substantial performance hit to file drivers as * more metadata has to be loaded into memory than might actually be * necessary. This may not be relevant to scenarios where caching of * metadata is in place, however hits very hard in scenarios where no * caching is used. * * @return void */ protected function initialize() { $this->classCache = []; if ($this->globalBasename === null) { return; } foreach ($this->locator->getPaths() as $path) { $file = $path . '/' . $this->globalBasename . $this->locator->getFileExtension(); if (! is_file($file)) { continue; } $this->classCache = array_merge( $this->classCache, $this->loadMappingFile($file) ); } } /** * Retrieves the locator used to discover mapping files by className. * * @return FileLocator */ public function getLocator() { return $this->locator; } /** * Sets the locator used to discover mapping files by className. */ public function setLocator(FileLocator $locator) { $this->locator = $locator; } } lib/Doctrine/Common/Persistence/Mapping/Driver/FileLocator.php000064400000002353144760123070020346 0ustar00defaultDriver; } /** * Set the default driver. * * @return void */ public function setDefaultDriver(MappingDriver $driver) { $this->defaultDriver = $driver; } /** * Adds a nested driver. * * @param string $namespace * * @return void */ public function addDriver(MappingDriver $nestedDriver, $namespace) { $this->drivers[$namespace] = $nestedDriver; } /** * Gets the array of nested drivers. * * @return MappingDriver[] $drivers */ public function getDrivers() { return $this->drivers; } /** * {@inheritDoc} */ public function loadMetadataForClass($className, ClassMetadata $metadata) { /** @var MappingDriver $driver */ foreach ($this->drivers as $namespace => $driver) { if (strpos($className, $namespace) === 0) { $driver->loadMetadataForClass($className, $metadata); return; } } if ($this->defaultDriver !== null) { $this->defaultDriver->loadMetadataForClass($className, $metadata); return; } throw MappingException::classNotFoundInNamespaces($className, array_keys($this->drivers)); } /** * {@inheritDoc} */ public function getAllClassNames() { $classNames = []; $driverClasses = []; /** @var MappingDriver $driver */ foreach ($this->drivers as $namespace => $driver) { $oid = spl_object_hash($driver); if (! isset($driverClasses[$oid])) { $driverClasses[$oid] = $driver->getAllClassNames(); } foreach ($driverClasses[$oid] as $className) { if (strpos($className, $namespace) !== 0) { continue; } $classNames[$className] = true; } } if ($this->defaultDriver !== null) { foreach ($this->defaultDriver->getAllClassNames() as $className) { $classNames[$className] = true; } } return array_keys($classNames); } /** * {@inheritDoc} */ public function isTransient($className) { /** @var MappingDriver $driver */ foreach ($this->drivers as $namespace => $driver) { if (strpos($className, $namespace) === 0) { return $driver->isTransient($className); } } if ($this->defaultDriver !== null) { return $this->defaultDriver->isTransient($className); } return true; } } lib/Doctrine/Common/Persistence/Mapping/Driver/PHPDriver.php000064400000001627144760123070017751 0ustar00metadata = $metadata; $this->loadMappingFile($this->locator->findMappingFile($className)); } /** * {@inheritDoc} */ protected function loadMappingFile($file) { $metadata = $this->metadata; include $file; return [$metadata->getName() => $metadata]; } } lib/Doctrine/Common/Persistence/Mapping/Driver/StaticPHPDriver.php000064400000005767144760123070021132 0ustar00addPaths((array) $paths); } /** * Adds paths. * * @param string[] $paths * * @return void */ public function addPaths(array $paths) { $this->paths = array_unique(array_merge($this->paths, $paths)); } /** * {@inheritdoc} */ public function loadMetadataForClass($className, ClassMetadata $metadata) { $className::loadMetadata($metadata); } /** * {@inheritDoc} * @todo Same code exists in AnnotationDriver, should we re-use it somehow or not worry about it? */ public function getAllClassNames() { if ($this->classNames !== null) { return $this->classNames; } if (! $this->paths) { throw MappingException::pathRequired(); } $classes = []; $includedFiles = []; foreach ($this->paths as $path) { if (! is_dir($path)) { throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path); } $iterator = new \RecursiveIteratorIterator( new \RecursiveDirectoryIterator($path), \RecursiveIteratorIterator::LEAVES_ONLY ); foreach ($iterator as $file) { if ($file->getBasename('.php') === $file->getBasename()) { continue; } $sourceFile = realpath($file->getPathName()); require_once $sourceFile; $includedFiles[] = $sourceFile; } } $declared = get_declared_classes(); foreach ($declared as $className) { $rc = new \ReflectionClass($className); $sourceFile = $rc->getFileName(); if (! in_array($sourceFile, $includedFiles) || $this->isTransient($className)) { continue; } $classes[] = $className; } $this->classNames = $classes; return $classes; } /** * {@inheritdoc} */ public function isTransient($className) { return ! method_exists($className, 'loadMetadata'); } } lib/Doctrine/Common/Persistence/Mapping/Driver/SymfonyFileLocator.php000064400000014572144760123070021741 0ustar00addNamespacePrefixes($prefixes); $this->fileExtension = $fileExtension; if (empty($nsSeparator)) { throw new \InvalidArgumentException('Namespace separator should not be empty'); } $this->nsSeparator = (string) $nsSeparator; } /** * Adds Namespace Prefixes. * * @param string[] $prefixes * * @return void */ public function addNamespacePrefixes(array $prefixes) { $this->prefixes = array_merge($this->prefixes, $prefixes); $this->paths = array_merge($this->paths, array_keys($prefixes)); } /** * Gets Namespace Prefixes. * * @return string[] */ public function getNamespacePrefixes() { return $this->prefixes; } /** * {@inheritDoc} */ public function getPaths() { return $this->paths; } /** * {@inheritDoc} */ public function getFileExtension() { return $this->fileExtension; } /** * Sets the file extension used to look for mapping files under. * * @param string $fileExtension The file extension to set. * * @return void */ public function setFileExtension($fileExtension) { $this->fileExtension = $fileExtension; } /** * {@inheritDoc} */ public function fileExists($className) { $defaultFileName = str_replace('\\', $this->nsSeparator, $className) . $this->fileExtension; foreach ($this->paths as $path) { if (! isset($this->prefixes[$path])) { // global namespace class if (is_file($path . DIRECTORY_SEPARATOR . $defaultFileName)) { return true; } continue; } $prefix = $this->prefixes[$path]; if (strpos($className, $prefix . '\\') !== 0) { continue; } $filename = $path . '/' . strtr(substr($className, strlen($prefix) + 1), '\\', $this->nsSeparator) . $this->fileExtension; if (is_file($filename)) { return true; } } return false; } /** * {@inheritDoc} */ public function getAllClassNames($globalBasename = null) { $classes = []; if ($this->paths) { foreach ((array) $this->paths as $path) { if (! is_dir($path)) { throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path); } $iterator = new \RecursiveIteratorIterator( new \RecursiveDirectoryIterator($path), \RecursiveIteratorIterator::LEAVES_ONLY ); foreach ($iterator as $file) { $fileName = $file->getBasename($this->fileExtension); if ($fileName === $file->getBasename() || $fileName === $globalBasename) { continue; } // NOTE: All files found here means classes are not transient! if (isset($this->prefixes[$path])) { // Calculate namespace suffix for given prefix as a relative path from basepath to file path $nsSuffix = strtr( substr(realpath($file->getPath()), strlen(realpath($path))), $this->nsSeparator, '\\' ); $classes[] = $this->prefixes[$path] . str_replace(DIRECTORY_SEPARATOR, '\\', $nsSuffix) . '\\' . str_replace($this->nsSeparator, '\\', $fileName); } else { $classes[] = str_replace($this->nsSeparator, '\\', $fileName); } } } } return $classes; } /** * {@inheritDoc} */ public function findMappingFile($className) { $defaultFileName = str_replace('\\', $this->nsSeparator, $className) . $this->fileExtension; foreach ($this->paths as $path) { if (! isset($this->prefixes[$path])) { if (is_file($path . DIRECTORY_SEPARATOR . $defaultFileName)) { return $path . DIRECTORY_SEPARATOR . $defaultFileName; } continue; } $prefix = $this->prefixes[$path]; if (strpos($className, $prefix . '\\') !== 0) { continue; } $filename = $path . '/' . strtr(substr($className, strlen($prefix) + 1), '\\', $this->nsSeparator) . $this->fileExtension; if (is_file($filename)) { return $filename; } } throw MappingException::mappingFileNotFound($className, substr($className, strrpos($className, '\\') + 1) . $this->fileExtension); } } lib/Doctrine/Common/Persistence/Mapping/MappingException.php000064400000004301144760123070020155 0ustar00getShortName(); } /** * {@inheritDoc} */ public function getClassNamespace($class) { $reflectionClass = new ReflectionClass($class); return $reflectionClass->getNamespaceName(); } /** * {@inheritDoc} */ public function getClass($class) { return new ReflectionClass($class); } /** * {@inheritDoc} */ public function getAccessibleProperty($class, $property) { $reflectionProperty = new ReflectionProperty($class, $property); if ($reflectionProperty->isPublic()) { $reflectionProperty = new RuntimePublicReflectionProperty($class, $property); } $reflectionProperty->setAccessible(true); return $reflectionProperty; } /** * {@inheritDoc} */ public function hasPublicMethod($class, $method) { try { $reflectionMethod = new ReflectionMethod($class, $method); } catch (ReflectionException $e) { return false; } return $reflectionMethod->isPublic(); } } lib/Doctrine/Common/Persistence/Mapping/StaticReflectionService.php000064400000002422144760123070021470 0ustar00find($id). * * @param string $className The class name of the object to find. * @param mixed $id The identity of the object to find. * * @return object|null The found object. */ public function find($className, $id); /** * Tells the ObjectManager to make an instance managed and persistent. * * The object will be entered into the database as a result of the flush operation. * * NOTE: The persist operation always considers objects that are not yet known to * this ObjectManager as NEW. Do not pass detached objects to the persist operation. * * @param object $object The instance to make managed and persistent. * * @return void */ public function persist($object); /** * Removes an object instance. * * A removed object will be removed from the database as a result of the flush operation. * * @param object $object The object instance to remove. * * @return void */ public function remove($object); /** * Merges the state of a detached object into the persistence context * of this ObjectManager and returns the managed copy of the object. * The object passed to merge will not become associated/managed with this ObjectManager. * * @param object $object * * @return object */ public function merge($object); /** * Clears the ObjectManager. All objects that are currently managed * by this ObjectManager become detached. * * @param string|null $objectName if given, only objects of this type will get detached. * * @return void */ public function clear($objectName = null); /** * Detaches an object from the ObjectManager, causing a managed object to * become detached. Unflushed changes made to the object if any * (including removal of the object), will not be synchronized to the database. * Objects which previously referenced the detached object will continue to * reference it. * * @param object $object The object to detach. * * @return void */ public function detach($object); /** * Refreshes the persistent state of an object from the database, * overriding any local changes that have not yet been persisted. * * @param object $object The object to refresh. * * @return void */ public function refresh($object); /** * Flushes all changes to objects that have been queued up to now to the database. * This effectively synchronizes the in-memory state of managed objects with the * database. * * @return void */ public function flush(); /** * Gets the repository for a class. * * @param string $className * * @return ObjectRepository */ public function getRepository($className); /** * Returns the ClassMetadata descriptor for a class. * * The class name must be the fully-qualified class name without a leading backslash * (as it is returned by get_class($obj)). * * @param string $className * * @return ClassMetadata */ public function getClassMetadata($className); /** * Gets the metadata factory used to gather the metadata of classes. * * @return ClassMetadataFactory */ public function getMetadataFactory(); /** * Helper method to initialize a lazy loading proxy or persistent collection. * * This method is a no-op for other objects. * * @param object $obj * * @return void */ public function initializeObject($obj); /** * Checks if the object is part of the current UnitOfWork and therefore managed. * * @param object $object * * @return bool */ public function contains($object); } lib/Doctrine/Common/Persistence/ObjectManagerAware.php000064400000002013144760123070016767 0ustar00wrapped->find($className, $id); } /** * {@inheritdoc} */ public function persist($object) { $this->wrapped->persist($object); } /** * {@inheritdoc} */ public function remove($object) { $this->wrapped->remove($object); } /** * {@inheritdoc} */ public function merge($object) { return $this->wrapped->merge($object); } /** * {@inheritdoc} */ public function clear($objectName = null) { $this->wrapped->clear($objectName); } /** * {@inheritdoc} */ public function detach($object) { $this->wrapped->detach($object); } /** * {@inheritdoc} */ public function refresh($object) { $this->wrapped->refresh($object); } /** * {@inheritdoc} */ public function flush() { $this->wrapped->flush(); } /** * {@inheritdoc} */ public function getRepository($className) { return $this->wrapped->getRepository($className); } /** * {@inheritdoc} */ public function getClassMetadata($className) { return $this->wrapped->getClassMetadata($className); } /** * {@inheritdoc} */ public function getMetadataFactory() { return $this->wrapped->getMetadataFactory(); } /** * {@inheritdoc} */ public function initializeObject($obj) { $this->wrapped->initializeObject($obj); } /** * {@inheritdoc} */ public function contains($object) { return $this->wrapped->contains($object); } } lib/Doctrine/Common/Persistence/ObjectRepository.php000064400000002714144760123070016624 0ustar00getId(); // method exists through __call */ abstract class PersistentObject implements ObjectManagerAware { /** @var ObjectManager|null */ private static $objectManager = null; /** @var ClassMetadata|null */ private $cm = null; /** * Sets the object manager responsible for all persistent object base classes. * * @return void */ public static function setObjectManager(?ObjectManager $objectManager = null) { self::$objectManager = $objectManager; } /** * @return ObjectManager|null */ public static function getObjectManager() { return self::$objectManager; } /** * Injects the Doctrine Object Manager. * * @return void * * @throws \RuntimeException */ public function injectObjectManager(ObjectManager $objectManager, ClassMetadata $classMetadata) { if ($objectManager !== self::$objectManager) { throw new \RuntimeException('Trying to use PersistentObject with different ObjectManager instances. ' . 'Was PersistentObject::setObjectManager() called?'); } $this->cm = $classMetadata; } /** * Sets a persistent fields value. * * @param string $field * @param mixed[] $args * * @return void * * @throws \BadMethodCallException When no persistent field exists by that name. * @throws \InvalidArgumentException When the wrong target object type is passed to an association. */ private function set($field, $args) { if ($this->cm->hasField($field) && ! $this->cm->isIdentifier($field)) { $this->$field = $args[0]; } elseif ($this->cm->hasAssociation($field) && $this->cm->isSingleValuedAssociation($field)) { $targetClass = $this->cm->getAssociationTargetClass($field); if (! ($args[0] instanceof $targetClass) && $args[0] !== null) { throw new \InvalidArgumentException("Expected persistent object of type '" . $targetClass . "'"); } $this->$field = $args[0]; $this->completeOwningSide($field, $targetClass, $args[0]); } else { throw new \BadMethodCallException("no field with name '" . $field . "' exists on '" . $this->cm->getName() . "'"); } } /** * Gets a persistent field value. * * @param string $field * * @return mixed * * @throws \BadMethodCallException When no persistent field exists by that name. */ private function get($field) { if ($this->cm->hasField($field) || $this->cm->hasAssociation($field)) { return $this->$field; } throw new \BadMethodCallException("no field with name '" . $field . "' exists on '" . $this->cm->getName() . "'"); } /** * If this is an inverse side association, completes the owning side. * * @param string $field * @param ClassMetadata $targetClass * @param object $targetObject * * @return void */ private function completeOwningSide($field, $targetClass, $targetObject) { // add this object on the owning side as well, for obvious infinite recursion // reasons this is only done when called on the inverse side. if (! $this->cm->isAssociationInverseSide($field)) { return; } $mappedByField = $this->cm->getAssociationMappedByTargetField($field); $targetMetadata = self::$objectManager->getClassMetadata($targetClass); $setter = ($targetMetadata->isCollectionValuedAssociation($mappedByField) ? 'add' : 'set') . $mappedByField; $targetObject->$setter($this); } /** * Adds an object to a collection. * * @param string $field * @param mixed[] $args * * @return void * * @throws \BadMethodCallException * @throws \InvalidArgumentException */ private function add($field, $args) { if (! $this->cm->hasAssociation($field) || ! $this->cm->isCollectionValuedAssociation($field)) { throw new \BadMethodCallException('There is no method add' . $field . '() on ' . $this->cm->getName()); } $targetClass = $this->cm->getAssociationTargetClass($field); if (! ($args[0] instanceof $targetClass)) { throw new \InvalidArgumentException("Expected persistent object of type '" . $targetClass . "'"); } if (! ($this->$field instanceof Collection)) { $this->$field = new ArrayCollection($this->$field ?: []); } $this->$field->add($args[0]); $this->completeOwningSide($field, $targetClass, $args[0]); } /** * Initializes Doctrine Metadata for this class. * * @return void * * @throws \RuntimeException */ private function initializeDoctrine() { if ($this->cm !== null) { return; } if (! self::$objectManager) { throw new \RuntimeException('No runtime object manager set. Call PersistentObject#setObjectManager().'); } $this->cm = self::$objectManager->getClassMetadata(get_class($this)); } /** * Magic methods. * * @param string $method * @param mixed[] $args * * @return mixed * * @throws \BadMethodCallException */ public function __call($method, $args) { $this->initializeDoctrine(); $command = substr($method, 0, 3); $field = lcfirst(substr($method, 3)); if ($command === 'set') { $this->set($field, $args); } elseif ($command === 'get') { return $this->get($field); } elseif ($command === 'add') { $this->add($field, $args); } else { throw new \BadMethodCallException('There is no method ' . $method . ' on ' . $this->cm->getName()); } } } lib/Doctrine/Common/Persistence/Proxy.php000064400000001227144760123070014435 0ustar00