Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Fix for wrong return types in documentation. #578

Merged
merged 1 commit into from

3 participants

@BenMorel

Several methods were declaring erroneous / incomplete return types.
This PR fixes them.

@doctrinebot
Collaborator

Hello,

thank you for positing this Pull Request. I have automatically opened an issue on our Jira Bug Tracker for you with the details of this Pull-Request. See the Link:

http://doctrine-project.org/jira/browse/DDC-2293

@guilhermeblanco guilhermeblanco merged commit 39374b7 into doctrine:master
@BenMorel BenMorel deleted the BenMorel:docfix branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Feb 12, 2013
  1. @BenMorel
This page is out of date. Refresh to see the latest.
View
10 lib/Doctrine/ORM/EntityManager.php
@@ -376,12 +376,12 @@ public function flush($entity = null)
/**
* Finds an Entity by its identifier.
*
- * @param string $entityName
- * @param mixed $id
- * @param integer $lockMode
- * @param integer $lockVersion
+ * @param string $entityName
+ * @param mixed $id
+ * @param integer $lockMode
+ * @param integer|null $lockVersion
*
- * @return object
+ * @return object|null The entity instance or NULL if the entity can not be found.
*
* @throws OptimisticLockException
* @throws ORMInvalidArgumentException
View
4 lib/Doctrine/ORM/EntityRepository.php
@@ -147,7 +147,7 @@ public function clear()
* @param int $lockMode The lock mode.
* @param int|null $lockVersion The lock version.
*
- * @return object The entity.
+ * @return object|null The entity instance or NULL if the entity can not be found.
*/
public function find($id, $lockMode = LockMode::NONE, $lockVersion = null)
{
@@ -187,7 +187,7 @@ public function findBy(array $criteria, array $orderBy = null, $limit = null, $o
* @param array $criteria
* @param array|null $orderBy
*
- * @return object
+ * @return object|null The entity instance or NULL if the entity can not be found.
*/
public function findOneBy(array $criteria, array $orderBy = null)
{
View
4 lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php
@@ -1676,9 +1676,7 @@ public function setIdentifier(array $identifier)
}
/**
- * Gets the mapped identifier field of this class.
- *
- * @return array|string
+ * {@inheritDoc}
*/
public function getIdentifier()
{
View
2  lib/Doctrine/ORM/Persisters/BasicEntityPersister.php
@@ -714,7 +714,7 @@ public function getOwningTable($fieldName)
* @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.
+ * @return object|null 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?
*/
Something went wrong with that request. Please try again.