Document fluent interfaces (#9009)

doctrine · Sep 13, 2021 · 334ca18 · 334ca18
1 parent 6371081
commit 334ca18
Show file tree

Hide file tree

Showing 13 changed files with 112 additions and 112 deletions.
diff --git a/lib/Doctrine/ORM/AbstractQuery.php b/lib/Doctrine/ORM/AbstractQuery.php
@@ -181,7 +181,7 @@ public function __construct(EntityManagerInterface $em)
      *
      * @param bool $cacheable
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setCacheable($cacheable)
     {
@@ -201,7 +201,7 @@ public function isCacheable()
     /**
      * @param string $cacheRegion
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setCacheRegion($cacheRegion)
     {
@@ -241,7 +241,7 @@ public function getLifetime()
      *
      * @param int $lifetime
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setLifetime($lifetime)
     {
@@ -261,7 +261,7 @@ public function getCacheMode()
     /**
      * @param int $cacheMode
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setCacheMode($cacheMode)
     {
@@ -342,7 +342,7 @@ static function (Query\Parameter $parameter) use ($key): bool {
      * @param ArrayCollection|mixed[] $parameters
      * @psalm-param ArrayCollection<int, Parameter>|mixed[] $parameters
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setParameters($parameters)
     {
@@ -372,7 +372,7 @@ public function setParameters($parameters)
      *                           the type conversion of this type. This is usually not needed for
      *                           strings and numeric types.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setParameter($key, $value, $type = null)
     {
@@ -479,7 +479,7 @@ private function processArrayParameterValue(array $value): array
     /**
      * Sets the ResultSetMapping that should be used for hydration.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setResultSetMapping(Query\ResultSetMapping $rsm)
     {
@@ -524,7 +524,7 @@ private function translateNamespaces(Query\ResultSetMapping $rsm): void
      * some form of caching with UnitOfWork registration you should use
      * {@see AbstractQuery::setResultCacheProfile()}.
      *
-     * @return static This query instance.
+     * @return $this
      *
      * @example
      * $lifetime = 100;
@@ -684,7 +684,7 @@ public function getResultCacheDriver()
      * @param int    $lifetime      How long the cache entry is valid, in seconds.
      * @param string $resultCacheId ID to use for the cache entry.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function useResultCache($useCache, $lifetime = null, $resultCacheId = null)
     {
@@ -700,7 +700,7 @@ public function useResultCache($useCache, $lifetime = null, $resultCacheId = nul
      * @param int|null    $lifetime      How long the cache entry is valid, in seconds.
      * @param string|null $resultCacheId ID to use for the cache entry.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function enableResultCache(?int $lifetime = null, ?string $resultCacheId = null): self
     {
@@ -713,7 +713,7 @@ public function enableResultCache(?int $lifetime = null, ?string $resultCacheId
     /**
      * Disables caching of the results of this query.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function disableResultCache(): self
     {
@@ -775,7 +775,7 @@ public function getResultCacheLifetime()
      *
      * @param bool $expire Whether or not to force resultset cache expiration.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function expireResultCache($expire = true)
     {
@@ -811,7 +811,7 @@ public function getQueryCacheProfile()
      * @param string $assocName
      * @param int    $fetchMode
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setFetchMode($class, $assocName, $fetchMode)
     {
@@ -830,7 +830,7 @@ public function setFetchMode($class, $assocName, $fetchMode)
      * @param string|int $hydrationMode Doctrine processing mode to be used during hydration process.
      *                                  One of the Query::HYDRATE_* constants.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setHydrationMode($hydrationMode)
     {
@@ -987,7 +987,7 @@ public function getSingleScalarResult()
      * @param string $name  The name of the hint.
      * @param mixed  $value The value of the hint.
      *
-     * @return static This query instance.
+     * @return $this
      */
     public function setHint($name, $value)
     {

diff --git a/lib/Doctrine/ORM/Mapping/Builder/AssociationBuilder.php b/lib/Doctrine/ORM/Mapping/Builder/AssociationBuilder.php
@@ -35,7 +35,7 @@ public function __construct(ClassMetadataBuilder $builder, array $mapping, $type
     /**
      * @param string $fieldName
      *
-     * @return static
+     * @return $this
      */
     public function mappedBy($fieldName)
     {
@@ -47,7 +47,7 @@ public function mappedBy($fieldName)
     /**
      * @param string $fieldName
      *
-     * @return static
+     * @return $this
      */
     public function inversedBy($fieldName)
     {
@@ -57,7 +57,7 @@ public function inversedBy($fieldName)
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function cascadeAll()
     {
@@ -67,7 +67,7 @@ public function cascadeAll()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function cascadePersist()
     {
@@ -77,7 +77,7 @@ public function cascadePersist()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function cascadeRemove()
     {
@@ -87,7 +87,7 @@ public function cascadeRemove()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function cascadeMerge()
     {
@@ -97,7 +97,7 @@ public function cascadeMerge()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function cascadeDetach()
     {
@@ -107,7 +107,7 @@ public function cascadeDetach()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function cascadeRefresh()
     {
@@ -117,7 +117,7 @@ public function cascadeRefresh()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function fetchExtraLazy()
     {
@@ -127,7 +127,7 @@ public function fetchExtraLazy()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function fetchEager()
     {
@@ -137,7 +137,7 @@ public function fetchEager()
     }
 
     /**
-     * @return static
+     * @return $this
      */
     public function fetchLazy()
     {
@@ -156,7 +156,7 @@ public function fetchLazy()
      * @param string|null $onDelete
      * @param string|null $columnDef
      *
-     * @return static
+     * @return $this
      */
     public function addJoinColumn($columnName, $referencedColumnName, $nullable = true, $unique = false, $onDelete = null, $columnDef = null)
     {
@@ -175,7 +175,7 @@ public function addJoinColumn($columnName, $referencedColumnName, $nullable = tr
     /**
      * Sets field as primary key.
      *
-     * @return static
+     * @return $this
      */
     public function makePrimaryKey()
     {
@@ -187,7 +187,7 @@ public function makePrimaryKey()
     /**
      * Removes orphan entities when detached from their parent.
      *
-     * @return static
+     * @return $this
      */
     public function orphanRemoval()
     {