diff --git a/lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php b/lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php index c8d7fdcfd..1254bacb4 100644 --- a/lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php +++ b/lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php @@ -127,7 +127,7 @@ abstract class AbstractHydrator * @param object $resultSetMapping * @param array $hints * - * @return mixed + * @return array */ public function hydrateAll($stmt, $resultSetMapping, array $hints = array()) { diff --git a/lib/Doctrine/ORM/Persisters/AbstractCollectionPersister.php b/lib/Doctrine/ORM/Persisters/AbstractCollectionPersister.php index f6c004e5d..26147261e 100644 --- a/lib/Doctrine/ORM/Persisters/AbstractCollectionPersister.php +++ b/lib/Doctrine/ORM/Persisters/AbstractCollectionPersister.php @@ -77,6 +77,8 @@ abstract class AbstractCollectionPersister * Deletes the persistent state represented by the given collection. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return void */ public function delete(PersistentCollection $coll) { @@ -95,6 +97,8 @@ abstract class AbstractCollectionPersister * Gets the SQL statement for deleting the given collection. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return void */ abstract protected function getDeleteSQL(PersistentCollection $coll); @@ -103,6 +107,8 @@ abstract class AbstractCollectionPersister * the given collection. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return void */ abstract protected function getDeleteSQLParameters(PersistentCollection $coll); @@ -111,6 +117,8 @@ abstract class AbstractCollectionPersister * by inserting, updating and deleting individual elements. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return void */ public function update(PersistentCollection $coll) { @@ -125,9 +133,11 @@ abstract class AbstractCollectionPersister } /** - * Delete rows + * Deletes rows. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return void */ public function deleteRows(PersistentCollection $coll) { @@ -140,9 +150,11 @@ abstract class AbstractCollectionPersister } /** - * Insert rows + * Inserts rows. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return void */ public function insertRows(PersistentCollection $coll) { @@ -155,11 +167,13 @@ abstract class AbstractCollectionPersister } /** - * Count the size of this persistent collection + * Counts the size of this persistent collection. * * @param \Doctrine\ORM\PersistentCollection $coll * * @return integer + * + * @throws \BadMethodCallException */ public function count(PersistentCollection $coll) { @@ -167,13 +181,15 @@ abstract class AbstractCollectionPersister } /** - * Slice elements + * Slices elements. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param integer $offset - * @param integer $length + * @param integer $offset + * @param integer $length * * @return array + * + * @throws \BadMethodCallException */ public function slice(PersistentCollection $coll, $offset, $length = null) { @@ -181,12 +197,14 @@ abstract class AbstractCollectionPersister } /** - * Check for existance of an element + * Checks for existence of an element. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element + * @param object $element * * @return boolean + * + * @throws \BadMethodCallException */ public function contains(PersistentCollection $coll, $element) { @@ -194,12 +212,14 @@ abstract class AbstractCollectionPersister } /** - * Check for existance of a key + * Checks for existence of a key. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param mixed $key + * @param mixed $key * * @return boolean + * + * @throws \BadMethodCallException */ public function containsKey(PersistentCollection $coll, $key) { @@ -207,12 +227,14 @@ abstract class AbstractCollectionPersister } /** - * Remove an element + * Removes an element. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element + * @param object $element * * @return mixed + * + * @throws \BadMethodCallException */ public function removeElement(PersistentCollection $coll, $element) { @@ -220,11 +242,14 @@ abstract class AbstractCollectionPersister } /** - * Remove an element by key + * Removes an element by key. * * @param \Doctrine\ORM\PersistentCollection $coll - * - * @param mixed $key + * @param mixed $key + * + * @return void + * + * @throws \BadMethodCallException */ public function removeKey(PersistentCollection $coll, $key) { @@ -232,12 +257,14 @@ abstract class AbstractCollectionPersister } /** - * Get an element by key + * Gets an element by key. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param mixed $index + * @param mixed $index * * @return mixed + * + * @throws \BadMethodCallException */ public function get(PersistentCollection $coll, $index) { @@ -248,6 +275,8 @@ abstract class AbstractCollectionPersister * Gets the SQL statement used for deleting a row from the collection. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return string */ abstract protected function getDeleteRowSQL(PersistentCollection $coll); @@ -256,7 +285,9 @@ abstract class AbstractCollectionPersister * element from the given collection. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param mixed $element + * @param mixed $element + * + * @return array */ abstract protected function getDeleteRowSQLParameters(PersistentCollection $coll, $element); @@ -264,6 +295,8 @@ abstract class AbstractCollectionPersister * Gets the SQL statement used for updating a row in the collection. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return string */ abstract protected function getUpdateRowSQL(PersistentCollection $coll); @@ -271,6 +304,8 @@ abstract class AbstractCollectionPersister * Gets the SQL statement used for inserting a row in the collection. * * @param \Doctrine\ORM\PersistentCollection $coll + * + * @return string */ abstract protected function getInsertRowSQL(PersistentCollection $coll); @@ -279,7 +314,9 @@ abstract class AbstractCollectionPersister * element of the given collection into the database. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param mixed $element + * @param mixed $element + * + * @return array */ abstract protected function getInsertRowSQLParameters(PersistentCollection $coll, $element); } diff --git a/lib/Doctrine/ORM/Persisters/AbstractEntityInheritancePersister.php b/lib/Doctrine/ORM/Persisters/AbstractEntityInheritancePersister.php index d0f7151f3..422249579 100644 --- a/lib/Doctrine/ORM/Persisters/AbstractEntityInheritancePersister.php +++ b/lib/Doctrine/ORM/Persisters/AbstractEntityInheritancePersister.php @@ -76,6 +76,13 @@ abstract class AbstractEntityInheritancePersister extends BasicEntityPersister return $sql . ' AS ' . $columnAlias; } + /** + * @param string $tableAlias + * @param string $joinColumnName + * @param string $className + * + * @return string + */ protected function getSelectJoinColumnSQL($tableAlias, $joinColumnName, $className) { $columnAlias = $this->getSQLColumnAlias($joinColumnName); diff --git a/lib/Doctrine/ORM/Persisters/BasicEntityPersister.php b/lib/Doctrine/ORM/Persisters/BasicEntityPersister.php index b33feffb4..c6c2a0165 100644 --- a/lib/Doctrine/ORM/Persisters/BasicEntityPersister.php +++ b/lib/Doctrine/ORM/Persisters/BasicEntityPersister.php @@ -144,6 +144,7 @@ class BasicEntityPersister * when INSERTing or UPDATEing an entity. * * @var array + * * @see prepareInsertData($entity) * @see prepareUpdateData($entity) */ @@ -153,6 +154,7 @@ class BasicEntityPersister * The map of quoted column names. * * @var array + * * @see prepareInsertData($entity) * @see prepareUpdateData($entity) */ @@ -207,7 +209,7 @@ class BasicEntityPersister * Initializes a new BasicEntityPersister that uses the given EntityManager * and persists instances of the class described by the given ClassMetadata descriptor. * - * @param \Doctrine\ORM\EntityManager $em + * @param \Doctrine\ORM\EntityManager $em * @param \Doctrine\ORM\Mapping\ClassMetadata $class */ public function __construct(EntityManager $em, ClassMetadata $class) @@ -232,6 +234,8 @@ class BasicEntityPersister * The entity remains queued until {@link executeInserts} is invoked. * * @param object $entity The entity to queue for insertion. + * + * @return void */ public function addInsert($entity) { @@ -297,7 +301,9 @@ class BasicEntityPersister * entities version field. * * @param object $entity - * @param mixed $id + * @param mixed $id + * + * @return void */ protected function assignDefaultVersionValue($entity, $id) { @@ -307,10 +313,11 @@ class BasicEntityPersister } /** - * Fetch the current version value of a versioned entity. + * Fetches the current version value of a versioned entity. * * @param \Doctrine\ORM\Mapping\ClassMetadata $versionedClass - * @param mixed $id + * @param mixed $id + * * @return mixed */ protected function fetchVersionValue($versionedClass, $id) @@ -343,6 +350,8 @@ class BasicEntityPersister * from {@prepareUpdateData} on the target tables, thereby optionally applying versioning. * * @param object $entity The entity to update. + * + * @return void */ public function update($entity) { @@ -369,10 +378,15 @@ class BasicEntityPersister * Performs an UPDATE statement for an entity on a specific table. * The UPDATE can optionally be versioned, which requires the entity to have a version field. * - * @param object $entity The entity object being updated. - * @param string $quotedTableName The quoted name of the table to apply the UPDATE on. - * @param array $updateData The map of columns to update (column => value). - * @param boolean $versioned Whether the UPDATE should be versioned. + * @param object $entity The entity object being updated. + * @param string $quotedTableName The quoted name of the table to apply the UPDATE on. + * @param array $updateData The map of columns to update (column => value). + * @param boolean $versioned Whether the UPDATE should be versioned. + * + * @return void + * + * @throws \Doctrine\ORM\ORMException + * @throws \Doctrine\ORM\OptimisticLockException */ protected final function updateTable($entity, $quotedTableName, array $updateData, $versioned = false) { @@ -472,7 +486,9 @@ class BasicEntityPersister /** * @todo Add check for platform if it supports foreign keys/cascading. + * * @param array $identifier + * * @return void */ protected function deleteJoinTableRecords($identifier) @@ -538,6 +554,8 @@ class BasicEntityPersister * Subclasses may override this method to customize the semantics of entity deletion. * * @param object $entity The entity to delete. + * + * @return void */ public function delete($entity) { @@ -568,6 +586,7 @@ class BasicEntityPersister * * * @param object $entity The entity for which to prepare the data. + * * @return array The prepared data. */ protected function prepareUpdateData($entity) @@ -658,7 +677,9 @@ class BasicEntityPersister * The default insert data preparation is the same as for updates. * * @param object $entity The entity for which to prepare the data. + * * @return array The prepared data for the tables to update. + * * @see prepareUpdateData */ protected function prepareInsertData($entity) @@ -674,6 +695,7 @@ class BasicEntityPersister * is always persisted to a single table with a BasicEntityPersister. * * @param string $fieldName The field name. + * * @return string The table name. */ public function getOwningTable($fieldName) @@ -684,15 +706,16 @@ class BasicEntityPersister /** * Loads an entity by a list of field criteria. * - * @param array $criteria The criteria by which to load the entity. - * @param object $entity The entity to load the data into. If not specified, - * a new entity is created. - * @param $assoc The association that connects the entity to load to another entity, if any. - * @param array $hints Hints for entity creation. - * @param int $lockMode - * @param int $limit Limit number of results - * @param array $orderBy Criteria to order by + * @param array $criteria The criteria by which to load the entity. + * @param object|null $entity The entity to load the data into. If not specified, a new entity is created. + * @param array|null $assoc The association that connects the entity to load to another entity, if any. + * @param array $hints Hints for entity creation. + * @param int $lockMode + * @param int|null $limit Limit number of results. + * @param array|null $orderBy Criteria to order by. + * * @return object The loaded and managed entity instance or NULL if the entity can not be found. + * * @todo Check identity map? loadById method? Try to guess whether $criteria is the id? */ public function load(array $criteria, $entity = null, $assoc = null, array $hints = array(), $lockMode = 0, $limit = null, array $orderBy = null) @@ -716,12 +739,15 @@ class BasicEntityPersister * Loads an entity of this persister's mapped class as part of a single-valued * association from another entity. * - * @param array $assoc The association to load. + * @param array $assoc The association to load. * @param object $sourceEntity The entity that owns the association (not necessarily the "owning side"). - * @param array $identifier The identifier of the entity to load. Must be provided if - * the association to load represents the owning side, otherwise - * the identifier is derived from the $sourceEntity. + * @param array $identifier The identifier of the entity to load. Must be provided if + * the association to load represents the owning side, otherwise + * the identifier is derived from the $sourceEntity. + * * @return object The loaded and managed entity instance or NULL if the entity can not be found. + * + * @throws \Doctrine\ORM\Mapping\MappingException */ public function loadOneToOneEntity(array $assoc, $sourceEntity, array $identifier = array()) { @@ -789,9 +815,12 @@ class BasicEntityPersister /** * Refreshes a managed entity. * - * @param array $id The identifier of the entity as an associative array from - * column or field names to values. - * @param object $entity The entity to refresh. + * @param array $id The identifier of the entity as an associative array from + * column or field names to values. + * @param object $entity The entity to refresh. + * @param int $lockMode + * + * @return void */ public function refresh(array $id, $entity, $lockMode = 0) { @@ -804,7 +833,7 @@ class BasicEntityPersister } /** - * Load Entities matching the given Criteria object + * Loads Entities matching the given Criteria object. * * @param \Doctrine\Common\Collections\Criteria $criteria * @@ -826,7 +855,7 @@ class BasicEntityPersister } /** - * Expand Criteria Parameters by walking the expressions and grabbing all + * Expands Criteria Parameters by walking the expressions and grabbing all * parameters and types from it. * * @param \Doctrine\Common\Collections\Criteria $criteria @@ -864,10 +893,11 @@ class BasicEntityPersister /** * Loads a list of entities by a list of field criteria. * - * @param array $criteria - * @param array $orderBy - * @param int $limit - * @param int $offset + * @param array $criteria + * @param array|null $orderBy + * @param int|null $limit + * @param int|null $offset + * * @return array */ public function loadAll(array $criteria = array(), array $orderBy = null, $limit = null, $offset = null) @@ -882,12 +912,13 @@ class BasicEntityPersister } /** - * Get (sliced or full) elements of the given collection. + * Gets (sliced or full) elements of the given collection. * - * @param array $assoc - * @param object $sourceEntity + * @param array $assoc + * @param object $sourceEntity * @param int|null $offset * @param int|null $limit + * * @return array */ public function getManyToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null) @@ -898,9 +929,9 @@ class BasicEntityPersister } /** - * Load an array of entities from a given dbal statement. + * Loads an array of entities from a given DBAL statement. * - * @param array $assoc + * @param array $assoc * @param \Doctrine\DBAL\Statement $stmt * * @return array @@ -919,11 +950,11 @@ class BasicEntityPersister } /** - * Hydrate a collection from a given dbal statement. + * Hydrates a collection from a given DBAL statement. * - * @param array $assoc + * @param array $assoc * @param \Doctrine\DBAL\Statement $stmt - * @param PersistentCollection $coll + * @param PersistentCollection $coll * * @return array */ @@ -946,11 +977,10 @@ class BasicEntityPersister /** * Loads a collection of entities of a many-to-many association. * - * @param ManyToManyMapping $assoc The association mapping of the association being loaded. - * @param object $sourceEntity The entity that owns the collection. - * @param PersistentCollection $coll The collection to fill. - * @param int|null $offset - * @param int|null $limit + * @param array $assoc The association mapping of the association being loaded. + * @param object $sourceEntity The entity that owns the collection. + * @param PersistentCollection $coll The collection to fill. + * * @return array */ public function loadManyToManyCollection(array $assoc, $sourceEntity, PersistentCollection $coll) @@ -960,6 +990,16 @@ class BasicEntityPersister return $this->loadCollectionFromStatement($assoc, $stmt, $coll); } + /** + * @param array $assoc + * @param object $sourceEntity + * @param int|null $offset + * @param int|null $limit + * + * @return \Doctrine\DBAL\Driver\Statement + * + * @throws \Doctrine\ORM\Mapping\MappingException + */ private function getManyToManyStatement(array $assoc, $sourceEntity, $offset = null, $limit = null) { $sourceClass = $this->em->getClassMetadata($assoc['sourceEntity']); @@ -1021,12 +1061,12 @@ class BasicEntityPersister * Gets the SELECT SQL to select one or more entities by a set of field criteria. * * @param array|\Doctrine\Common\Collections\Criteria $criteria - * @param AssociationMapping $assoc - * @param string $orderBy - * @param int $lockMode - * @param int $limit - * @param int $offset - * @param array $orderBy + * @param array|null $assoc + * @param int $lockMode + * @param int|null $limit + * @param int|null $offset + * @param array|null $orderBy + * * @return string */ protected function getSelectSQL($criteria, $assoc = null, $lockMode = 0, $limit = null, $offset = null, array $orderBy = null) @@ -1089,9 +1129,12 @@ class BasicEntityPersister /** * Gets the ORDER BY SQL snippet for ordered collections. * - * @param array $orderBy + * @param array $orderBy * @param string $baseTableAlias + * * @return string + * + * @throws \Doctrine\ORM\ORMException */ protected final function getOrderBySQL(array $orderBy, $baseTableAlias) { @@ -1235,10 +1278,10 @@ class BasicEntityPersister /** * Gets the SQL join fragment used when selecting entities from an association. * - * @param string $field - * @param array $assoc + * @param string $field + * @param array $assoc * @param ClassMetadata $class - * @param string $alias + * @param string $alias * * @return string */ @@ -1267,7 +1310,8 @@ class BasicEntityPersister * Gets the SQL join fragment used when selecting entities from a * many-to-many association. * - * @param ManyToManyMapping $manyToMany + * @param array $manyToMany + * * @return string */ protected function getSelectManyToManyJoinSQL(array $manyToMany) @@ -1381,10 +1425,12 @@ class BasicEntityPersister /** * Gets the SQL snippet of a qualified column name for the given field name. * - * @param string $field The field name. + * @param string $field The field name. * @param ClassMetadata $class The class that declares this field. The table this class is * mapped to must own the column for the given field. - * @param string $alias + * @param string $alias + * + * @return string */ protected function getSelectColumnSQL($field, ClassMetadata $class, $alias = 'r') { @@ -1408,7 +1454,10 @@ class BasicEntityPersister * Gets the SQL table alias for the given class name. * * @param string $className + * @param string $assocName + * * @return string The SQL table alias. + * * @todo Reconsider. Binding table aliases to class names is not such a good idea. */ protected function getSQLTableAlias($className, $assocName = '') @@ -1429,10 +1478,11 @@ class BasicEntityPersister } /** - * Lock all rows of this entity matching the given criteria with the specified pessimistic lock mode + * Locks all rows of this entity matching the given criteria with the specified pessimistic lock mode. * * @param array $criteria - * @param int $lockMode + * @param int $lockMode + * * @return void */ public function lock(array $criteria, $lockMode) @@ -1464,7 +1514,7 @@ class BasicEntityPersister } /** - * Get the FROM and optionally JOIN conditions to lock the entity managed by this persister. + * Gets the FROM and optionally JOIN conditions to lock the entity managed by this persister. * * @return string */ @@ -1476,9 +1526,10 @@ class BasicEntityPersister } /** - * Get the Select Where Condition from a Criteria object. + * Gets the Select Where Condition from a Criteria object. * * @param \Doctrine\Common\Collections\Criteria $criteria + * * @return string */ protected function getSelectConditionCriteriaSQL(Criteria $criteria) @@ -1495,12 +1546,12 @@ class BasicEntityPersister } /** - * Get the SQL WHERE condition for matching a field with a given value. + * Gets the SQL WHERE condition for matching a field with a given value. * - * @param string $field - * @param mixed $value - * @param array|null $assoc - * @param string $comparison + * @param string $field + * @param mixed $value + * @param array|null $assoc + * @param string|null $comparison * * @return string */ @@ -1529,12 +1580,14 @@ class BasicEntityPersister } /** - * Build the left-hand-side of a where condition statement. + * Builds the left-hand-side of a where condition statement. * - * @param string $field - * @param array $assoc + * @param string $field + * @param array|null $assoc * * @return string + * + * @throws \Doctrine\ORM\ORMException */ protected function getSelectConditionStatementColumnSQL($field, $assoc = null) { @@ -1578,8 +1631,9 @@ class BasicEntityPersister * Subclasses are supposed to override this method if they intend to change * or alter the criteria by which entities are selected. * - * @param array $criteria - * @param AssociationMapping $assoc + * @param array $criteria + * @param array|null $assoc + * * @return string */ protected function getSelectConditionSQL(array $criteria, $assoc = null) @@ -1594,12 +1648,13 @@ class BasicEntityPersister } /** - * Return an array with (sliced or full list) of elements in the specified collection. + * Returns an array with (sliced or full list) of elements in the specified collection. + * + * @param array $assoc + * @param object $sourceEntity + * @param int|null $offset + * @param int|null $limit * - * @param array $assoc - * @param object $sourceEntity - * @param int $offset - * @param int $limit * @return array */ public function getOneToManyCollection(array $assoc, $sourceEntity, $offset = null, $limit = null) @@ -1612,11 +1667,11 @@ class BasicEntityPersister /** * Loads a collection of entities in a one-to-many association. * - * @param array $assoc - * @param object $sourceEntity - * @param PersistentCollection $coll The collection to load/fill. - * @param int|null $offset - * @param int|null $limit + * @param array $assoc + * @param object $sourceEntity + * @param PersistentCollection $coll The collection to load/fill. + * + * @return array */ public function loadOneToManyCollection(array $assoc, $sourceEntity, PersistentCollection $coll) { @@ -1626,12 +1681,13 @@ class BasicEntityPersister } /** - * Build criteria and execute SQL statement to fetch the one to many entities from. + * Builds criteria and execute SQL statement to fetch the one to many entities from. * - * @param array $assoc - * @param object $sourceEntity + * @param array $assoc + * @param object $sourceEntity * @param int|null $offset * @param int|null $limit + * * @return \Doctrine\DBAL\Statement */ private function getOneToManyStatement(array $assoc, $sourceEntity, $offset = null, $limit = null) @@ -1667,9 +1723,10 @@ class BasicEntityPersister } /** - * Expand the parameters from the given criteria and use the correct binding types if found. + * Expands the parameters from the given criteria and use the correct binding types if found. + * + * @param array $criteria * - * @param array $criteria * @return array */ private function expandParameters($criteria) @@ -1690,11 +1747,14 @@ class BasicEntityPersister } /** - * Infer field type to be used by parameter type casting. + * Infers field type to be used by parameter type casting. * * @param string $field - * @param mixed $value + * @param mixed $value + * * @return integer + * + * @throws \Doctrine\ORM\Query\QueryException */ private function getType($field, $value) { @@ -1733,9 +1793,10 @@ class BasicEntityPersister } /** - * Retrieve parameter value + * Retrieves parameter value. * * @param mixed $value + * * @return mixed */ private function getValue($value) @@ -1754,9 +1815,10 @@ class BasicEntityPersister } /** - * Retrieve an individual parameter value + * Retrieves an individual parameter value. * * @param mixed $value + * * @return mixed */ private function getIndividualValue($value) @@ -1781,6 +1843,8 @@ class BasicEntityPersister * Checks whether the given managed entity exists in the database. * * @param object $entity + * @param array $extraConditions + * * @return boolean TRUE if the entity exists in the database, FALSE otherwise. */ public function exists($entity, array $extraConditions = array()) @@ -1814,6 +1878,7 @@ class BasicEntityPersister * Generates the appropriate join SQL for the given join column. * * @param array $joinColumns The join columns definition of an association. + * * @return string LEFT JOIN if one of the columns is nullable, INNER JOIN otherwise. */ protected function getJoinSQLForJoinColumns($joinColumns) @@ -1832,6 +1897,7 @@ class BasicEntityPersister * Gets an SQL column alias for a column name. * * @param string $columnName + * * @return string */ public function getSQLColumnAlias($columnName) @@ -1842,8 +1908,8 @@ class BasicEntityPersister /** * Generates the filter SQL for a given entity and table alias. * - * @param ClassMetadata $targetEntity Metadata of the target entity. - * @param string $targetTableAlias The table alias of the joined/selected table. + * @param ClassMetadata $targetEntity Metadata of the target entity. + * @param string $targetTableAlias The table alias of the joined/selected table. * * @return string The SQL query part to add to a query. */ diff --git a/lib/Doctrine/ORM/Persisters/ElementCollectionPersister.php b/lib/Doctrine/ORM/Persisters/ElementCollectionPersister.php index e30d5fbce..04da1f7df 100644 --- a/lib/Doctrine/ORM/Persisters/ElementCollectionPersister.php +++ b/lib/Doctrine/ORM/Persisters/ElementCollectionPersister.php @@ -26,5 +26,4 @@ namespace Doctrine\ORM\Persisters; */ abstract class ElementCollectionPersister extends AbstractCollectionPersister { - } diff --git a/lib/Doctrine/ORM/Persisters/JoinedSubclassPersister.php b/lib/Doctrine/ORM/Persisters/JoinedSubclassPersister.php index 58aa7df17..4027d40f5 100644 --- a/lib/Doctrine/ORM/Persisters/JoinedSubclassPersister.php +++ b/lib/Doctrine/ORM/Persisters/JoinedSubclassPersister.php @@ -87,7 +87,9 @@ class JoinedSubclassPersister extends AbstractEntityInheritancePersister * Gets the name of the table that owns the column the given field is mapped to. * * @param string $fieldName + * * @return string + * * @override */ public function getOwningTable($fieldName) @@ -408,8 +410,10 @@ class JoinedSubclassPersister extends AbstractEntityInheritancePersister return 'FROM ' . $quotedTableName . ' ' . $baseTableAlias . $joinSql; } - /* + /** * Ensure this method is never called. This persister overrides getSelectEntitiesSQL directly. + * + * @return string */ protected function getSelectColumnsSQL() { @@ -548,5 +552,4 @@ class JoinedSubclassPersister extends AbstractEntityInheritancePersister $value = $this->fetchVersionValue($this->getVersionedClassMetadata(), $id); $this->class->setFieldValue($entity, $this->class->versionField, $value); } - } diff --git a/lib/Doctrine/ORM/Persisters/ManyToManyPersister.php b/lib/Doctrine/ORM/Persisters/ManyToManyPersister.php index 315888676..c1c3cf6c3 100644 --- a/lib/Doctrine/ORM/Persisters/ManyToManyPersister.php +++ b/lib/Doctrine/ORM/Persisters/ManyToManyPersister.php @@ -61,6 +61,7 @@ class ManyToManyPersister extends AbstractCollectionPersister * {@inheritdoc} * * @override + * * @internal Order of the parameters must be the same as the order of the columns in getDeleteRowSql. */ protected function getDeleteRowSQLParameters(PersistentCollection $coll, $element) @@ -70,7 +71,7 @@ class ManyToManyPersister extends AbstractCollectionPersister /** * {@inheritdoc} - * + * * @throws \BadMethodCallException Not used for OneToManyPersister */ protected function getUpdateRowSQL(PersistentCollection $coll) @@ -82,6 +83,7 @@ class ManyToManyPersister extends AbstractCollectionPersister * {@inheritdoc} * * @override + * * @internal Order of the parameters must be the same as the order of the columns in getInsertRowSql. */ protected function getInsertRowSQL(PersistentCollection $coll) @@ -107,6 +109,7 @@ class ManyToManyPersister extends AbstractCollectionPersister * {@inheritdoc} * * @override + * * @internal Order of the parameters must be the same as the order of the columns in getInsertRowSql. */ protected function getInsertRowSQLParameters(PersistentCollection $coll, $element) @@ -119,7 +122,8 @@ class ManyToManyPersister extends AbstractCollectionPersister * of the join table columns as specified in ManyToManyMapping#joinTableColumns. * * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element + * @param object $element + * * @return array */ private function collectJoinTableColumnParameters(PersistentCollection $coll, $element) @@ -181,6 +185,7 @@ class ManyToManyPersister extends AbstractCollectionPersister * {@inheritdoc} * * @override + * * @internal Order of the parameters must be the same as the order of the columns in getDeleteSql. */ protected function getDeleteSQLParameters(PersistentCollection $coll) @@ -253,8 +258,9 @@ class ManyToManyPersister extends AbstractCollectionPersister /** * @param \Doctrine\ORM\PersistentCollection $coll - * @param int $offset - * @param int $length + * @param int $offset + * @param int|null $length + * * @return array */ public function slice(PersistentCollection $coll, $offset, $length = null) @@ -266,7 +272,8 @@ class ManyToManyPersister extends AbstractCollectionPersister /** * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element + * @param object $element + * * @return boolean */ public function contains(PersistentCollection $coll, $element) @@ -294,7 +301,8 @@ class ManyToManyPersister extends AbstractCollectionPersister /** * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element + * @param object $element + * * @return boolean */ public function removeElement(PersistentCollection $coll, $element) @@ -323,8 +331,9 @@ class ManyToManyPersister extends AbstractCollectionPersister /** * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element - * @param boolean $addFilters Whether the filter SQL should be included or not. + * @param object $element + * @param boolean $addFilters Whether the filter SQL should be included or not. + * * @return array */ private function getJoinTableRestrictions(PersistentCollection $coll, $element, $addFilters) @@ -431,8 +440,8 @@ class ManyToManyPersister extends AbstractCollectionPersister /** * Generates the filter SQL for a given entity and table alias. * - * @param ClassMetadata $targetEntity Metadata of the target entity. - * @param string $targetTableAlias The table alias of the joined/selected table. + * @param ClassMetadata $targetEntity Metadata of the target entity. + * @param string $targetTableAlias The table alias of the joined/selected table. * * @return string The SQL query part to add to a query. */ diff --git a/lib/Doctrine/ORM/Persisters/OneToManyPersister.php b/lib/Doctrine/ORM/Persisters/OneToManyPersister.php index 100e834cf..911d699f6 100644 --- a/lib/Doctrine/ORM/Persisters/OneToManyPersister.php +++ b/lib/Doctrine/ORM/Persisters/OneToManyPersister.php @@ -37,7 +37,9 @@ class OneToManyPersister extends AbstractCollectionPersister * key to null. * * @param \Doctrine\ORM\PersistentCollection $coll + * * @return string + * * @override */ protected function getDeleteRowSQL(PersistentCollection $coll) @@ -61,7 +63,8 @@ class OneToManyPersister extends AbstractCollectionPersister /** * {@inheritdoc} - * @throws \BadMethodCallException Not used for OneToManyPersister + * + * @throws \BadMethodCallException Not used for OneToManyPersister. */ protected function getInsertRowSQL(PersistentCollection $coll) { @@ -70,8 +73,8 @@ class OneToManyPersister extends AbstractCollectionPersister /** * {@inheritdoc} - * - * @throws \BadMethodCallException Not used for OneToManyPersister + * + * @throws \BadMethodCallException Not used for OneToManyPersister. */ protected function getInsertRowSQLParameters(PersistentCollection $coll, $element) { @@ -81,7 +84,7 @@ class OneToManyPersister extends AbstractCollectionPersister /** * {@inheritdoc} * - * @throws \BadMethodCallException Not used for OneToManyPersister + * @throws \BadMethodCallException Not used for OneToManyPersister. */ protected function getUpdateRowSQL(PersistentCollection $coll) { @@ -91,7 +94,7 @@ class OneToManyPersister extends AbstractCollectionPersister /** * {@inheritdoc} * - * @throws \BadMethodCallException Not used for OneToManyPersister + * @throws \BadMethodCallException Not used for OneToManyPersister. */ protected function getDeleteSQL(PersistentCollection $coll) { @@ -101,7 +104,7 @@ class OneToManyPersister extends AbstractCollectionPersister /** * {@inheritdoc} * - * @throws \BadMethodCallException Not used for OneToManyPersister + * @throws \BadMethodCallException Not used for OneToManyPersister. */ protected function getDeleteSQLParameters(PersistentCollection $coll) { @@ -146,8 +149,9 @@ class OneToManyPersister extends AbstractCollectionPersister /** * @param \Doctrine\ORM\PersistentCollection $coll - * @param int $offset - * @param int $length + * @param int $offset + * @param int|null $length + * * @return \Doctrine\Common\Collections\ArrayCollection */ public function slice(PersistentCollection $coll, $offset, $length = null) @@ -161,7 +165,8 @@ class OneToManyPersister extends AbstractCollectionPersister /** * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element + * @param object $element + * * @return boolean */ public function contains(PersistentCollection $coll, $element) @@ -193,7 +198,8 @@ class OneToManyPersister extends AbstractCollectionPersister /** * @param \Doctrine\ORM\PersistentCollection $coll - * @param object $element + * @param object $element + * * @return boolean */ public function removeElement(PersistentCollection $coll, $element) diff --git a/lib/Doctrine/ORM/Persisters/SingleTablePersister.php b/lib/Doctrine/ORM/Persisters/SingleTablePersister.php index ed3924fbe..0d7abc8d9 100644 --- a/lib/Doctrine/ORM/Persisters/SingleTablePersister.php +++ b/lib/Doctrine/ORM/Persisters/SingleTablePersister.php @@ -147,6 +147,9 @@ class SingleTablePersister extends AbstractEntityInheritancePersister return $conditionSql . $this->getSelectConditionDiscriminatorValueSQL(); } + /** + * @return string + */ protected function getSelectConditionDiscriminatorValueSQL() { $values = array(); diff --git a/lib/Doctrine/ORM/Persisters/SqlExpressionVisitor.php b/lib/Doctrine/ORM/Persisters/SqlExpressionVisitor.php index 2fb685f98..4e7cc268d 100644 --- a/lib/Doctrine/ORM/Persisters/SqlExpressionVisitor.php +++ b/lib/Doctrine/ORM/Persisters/SqlExpressionVisitor.php @@ -46,7 +46,7 @@ class SqlExpressionVisitor extends ExpressionVisitor } /** - * Convert a comparison expression into the target query language output + * Converts a comparison expression into the target query language output. * * @param \Doctrine\Common\Collections\Expr\Comparison $comparison * @@ -61,11 +61,13 @@ class SqlExpressionVisitor extends ExpressionVisitor } /** - * Convert a composite expression into the target query language output + * Converts a composite expression into the target query language output. * * @param \Doctrine\Common\Collections\Expr\CompositeExpression $expr * * @return mixed + * + * @throws \RuntimeException */ public function walkCompositeExpression(CompositeExpression $expr) { @@ -88,7 +90,7 @@ class SqlExpressionVisitor extends ExpressionVisitor } /** - * Convert a value expression into the target query language part. + * Converts a value expression into the target query language part. * * @param \Doctrine\Common\Collections\Expr\Value $value * diff --git a/lib/Doctrine/ORM/Persisters/SqlValueVisitor.php b/lib/Doctrine/ORM/Persisters/SqlValueVisitor.php index 62422cf61..1d805c041 100644 --- a/lib/Doctrine/ORM/Persisters/SqlValueVisitor.php +++ b/lib/Doctrine/ORM/Persisters/SqlValueVisitor.php @@ -42,7 +42,7 @@ class SqlValueVisitor extends ExpressionVisitor private $types = array(); /** - * Convert a comparison expression into the target query language output + * Converts a comparison expression into the target query language output. * * @param \Doctrine\Common\Collections\Expr\Comparison $comparison * @@ -58,7 +58,7 @@ class SqlValueVisitor extends ExpressionVisitor } /** - * Convert a composite expression into the target query language output + * Converts a composite expression into the target query language output. * * @param \Doctrine\Common\Collections\Expr\CompositeExpression $expr * @@ -72,7 +72,7 @@ class SqlValueVisitor extends ExpressionVisitor } /** - * Convert a value expression into the target query language part. + * Converts a value expression into the target query language part. * * @param \Doctrine\Common\Collections\Expr\Value $value * @@ -84,7 +84,7 @@ class SqlValueVisitor extends ExpressionVisitor } /** - * Return the Parameters and Types necessary for matching the last visited expression. + * Returns the Parameters and Types necessary for matching the last visited expression. * * @return array */ diff --git a/lib/Doctrine/ORM/Persisters/UnionSubclassPersister.php b/lib/Doctrine/ORM/Persisters/UnionSubclassPersister.php index b2ea51490..d27dcc9fd 100644 --- a/lib/Doctrine/ORM/Persisters/UnionSubclassPersister.php +++ b/lib/Doctrine/ORM/Persisters/UnionSubclassPersister.php @@ -21,5 +21,4 @@ namespace Doctrine\ORM\Persisters; class UnionSubclassPersister extends BasicEntityPersister { - -} \ No newline at end of file +}