ezsystems / ezpublish-kernel

eZ/Publish/Core/Search/Legacy/Tests/Content/HandlerLocationSortTest.php

Doc Comments +8 added lines, -1 removed lines

@@ -28,9 +28,16 @@ 
  */
 class HandlerLocationSortTest extends AbstractTestCase
 {
+    /**
+     * @param \eZ\Publish\API\Repository\Values\Content\Search\SearchResult $searchResult
+     */
     protected function getIds($searchResult)
     {
         $ids = array_map(
+
+            /**
+             * @param \eZ\Publish\API\Repository\Values\Content\Search\SearchResult $hit
+             */
             function ($hit) {
                 return $hit->valueObject->id;
             },
@@ -106,7 +113,7 @@ 
     /**
      * Returns a location mapper mock.
      *
-     * @return \eZ\Publish\Core\Persistence\Legacy\Content\Location\Mapper
+     * @return \PHPUnit\Framework\MockObject\MockObject
      */
     protected function getLocationMapperMock()
     {

eZ/Publish/Core/Search/Legacy/Tests/Content/HandlerLocationTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -166,7 +166,7 @@
     /**
      * Returns a location mapper mock.
      *
-     * @return \eZ\Publish\Core\Persistence\Legacy\Content\Location\Mapper
+     * @return \PHPUnit\Framework\MockObject\MockObject
      */
     protected function getLocationMapperMock()
     {

eZ/Publish/Core/Search/Legacy/Tests/Content/HandlerContentTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
     /**
      * Returns a content mapper mock.
      *
-     * @return \eZ\Publish\Core\Persistence\Legacy\Content\Mapper
+     * @return \PHPUnit\Framework\MockObject\MockObject
      */
     protected function getContentMapperMock()
     {
@@ -149,7 +149,7 @@ 
     /**
      * Returns a content field handler mock.
      *
-     * @return \eZ\Publish\Core\Persistence\Legacy\Content\FieldHandler
+     * @return \PHPUnit\Framework\MockObject\MockObject
      */
     protected function getContentFieldHandlerMock()
     {

eZ/Publish/Core/Persistence/Legacy/Content/UrlAlias/Handler.php

Doc Comments +9 added lines, -9 removed lines

@@ -311,7 +311,7 @@ 
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
      * @throws \eZ\Publish\API\Repository\Exceptions\ForbiddenException
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      * @param string $path
      * @param bool $forwarding
      * @param string $languageCode
@@ -479,7 +479,7 @@ 
      *
      * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      * @param bool $custom if true the user generated aliases are listed otherwise the autogenerated
      *
      * @return \eZ\Publish\SPI\Persistence\Content\UrlAlias[]
@@ -615,9 +615,9 @@ 
      *
      * This method triggers the change of the autogenerated aliases.
      *
-     * @param mixed $locationId
-     * @param mixed $oldParentId
-     * @param mixed $newParentId
+     * @param integer $locationId
+     * @param integer $oldParentId
+     * @param integer $newParentId
      */
     public function locationMoved($locationId, $oldParentId, $newParentId)
     {
@@ -645,9 +645,9 @@ 
      *
      * This method triggers the creation of the autogenerated aliases for the copied locations
      *
-     * @param mixed $locationId
-     * @param mixed $newLocationId
-     * @param mixed $newParentId
+     * @param integer $locationId
+     * @param integer $newLocationId
+     * @param integer $newParentId
      */
     public function locationCopied($locationId, $newLocationId, $newParentId)
     {
@@ -976,7 +976,7 @@ 
     /**
      * Notifies the underlying engine that a location was deleted or moved to trash.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      */
     public function locationDeleted($locationId)
     {

eZ/Publish/Core/Repository/LocationService.php

Doc Comments +1 added lines, -1 removed lines

@@ -723,7 +723,7 @@
      * Instantiates a new location create class.
      *
      * @param mixed $parentLocationId the parent under which the new location should be created
-     * @param eZ\Publish\API\Repository\Values\ContentType\ContentType|null $contentType
+     * @param null|ContentType $contentType
      *
      * @return \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct
      */

eZ/Publish/Core/SignalSlot/LocationService.php

Doc Comments +1 added lines, -1 removed lines

@@ -723,7 +723,7 @@
      * Instantiates a new location create class.
      *
      * @param mixed $parentLocationId the parent under which the new location should be created
-     * @param eZ\Publish\API\Repository\Values\ContentType\ContentType|null $contentType
+     * @param null|ContentType $contentType
      *
      * @return \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct
      */

eZ/Publish/Core/REST/Client/LocationService.php

Doc Comments +1 added lines, -1 removed lines

@@ -222,7 +222,7 @@
      * @param \eZ\Publish\API\Repository\Values\Content\Location $rootLocation
      * @param string[]|null $prioritizedLanguages Used as prioritized language code on translated properties of returned object.
      *
-     * @return \eZ\Publish\API\Repository\Values\Content\Location[]
+     * @return \eZ\Publish\API\Repository\Values\ValueObject
      */
     public function loadLocations(ContentInfo $contentInfo, Location $rootLocation = null, array $prioritizedLanguages = null)
     {

eZ/Publish/Core/Persistence/Legacy/Content/Location/Gateway/DoctrineDatabase.php

Doc Comments +23 added lines, -20 removed lines

@@ -247,7 +247,7 @@ 
     /**
      * Returns data for the first level children of the location identified by given $locationId.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
      * @return array
      */
@@ -374,6 +374,9 @@ 
         }
     }
 
+    /**
+     * @param string $pathString
+     */
     private function isHiddenByParent($pathString, array $rows)
     {
         $parentNodeIds = explode('/', trim($pathString, '/'));
@@ -574,10 +577,10 @@ 
      * Make the location identified by $locationId1 refer to the Content
      * referred to by $locationId2 and vice versa.
      *
-     * @param mixed $locationId1
-     * @param mixed $locationId2
+     * @param integer $locationId1
+     * @param integer $locationId2
      *
-     * @return bool
+     * @return boolean|null
      */
     public function swap($locationId1, $locationId2)
     {
@@ -734,7 +737,7 @@ 
      * Create an entry in the node assignment table.
      *
      * @param \eZ\Publish\SPI\Persistence\Content\Location\CreateStruct $createStruct
-     * @param mixed $parentNodeId
+     * @param string $parentNodeId
      * @param int $type
      */
     public function createNodeAssignment(CreateStruct $createStruct, $parentNodeId, $type = self::NODE_ASSIGNMENT_OP_CODE_CREATE_NOP)
@@ -862,8 +865,8 @@ 
      *
      * Convert existing node assignments into real locations.
      *
-     * @param mixed $contentId
-     * @param mixed $versionNo
+     * @param integer $contentId
+     * @param integer $versionNo
      */
     public function createLocationsFromNodeAssignments($contentId, $versionNo)
     {
@@ -931,8 +934,8 @@ 
     /**
      * Updates all Locations of content identified with $contentId with $versionNo.
      *
-     * @param mixed $contentId
-     * @param mixed $versionNo
+     * @param integer $contentId
+     * @param integer $versionNo
      */
     public function updateLocationsContentVersionNo($contentId, $versionNo)
     {
@@ -1091,8 +1094,8 @@ 
      * the node identified by given $locationId (current main node).
      * Assumes that content has more than one location.
      *
-     * @param mixed $contentId
-     * @param mixed $locationId
+     * @param integer $contentId
+     * @param integer $locationId
      *
      * @return array
      */
@@ -1128,9 +1131,9 @@ 
      *
      * The associated content object is left untouched.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
-     * @return bool
+     * @return boolean|null
      */
     public function trashLocation($locationId)
     {
@@ -1159,8 +1162,8 @@ 
      * at the old position. If this is not possible ( because the old location
      * does not exist any more) and exception is thrown.
      *
-     * @param mixed $locationId
-     * @param mixed|null $newParentId
+     * @param integer $locationId
+     * @param integer $newParentId
      *
      * @return \eZ\Publish\SPI\Persistence\Content\Location
      */
@@ -1413,10 +1416,10 @@ 
      * Updates ezcontentobject_tree table for the given $contentId and eznode_assignment table for the given
      * $contentId, $parentLocationId and $versionNo
      *
-     * @param mixed $contentId
-     * @param mixed $locationId
-     * @param mixed $versionNo version number, needed to update eznode_assignment table
-     * @param mixed $parentLocationId parent location of location identified by $locationId, needed to update
+     * @param integer $contentId
+     * @param integer $locationId
+     * @param integer $versionNo version number, needed to update eznode_assignment table
+     * @param integer $parentLocationId parent location of location identified by $locationId, needed to update
      *        eznode_assignment table
      */
     public function changeMainLocation($contentId, $locationId, $versionNo, $parentLocationId)
@@ -1546,7 +1549,7 @@ 
      *
      * @todo Align with createNodeQueryBuilder, removing the need for both(?)
      *
-     * @param array $columns list of columns to fetch
+     * @param string[] $columns list of columns to fetch
      *
      * @return \Doctrine\DBAL\Query\QueryBuilder
      */

eZ/Publish/Core/Persistence/Cache/LocationHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -339,9 +339,9 @@
      * Return relevant content and location tags so cache can be purged reliably.
      *
      * @param \eZ\Publish\SPI\Persistence\Content\Location $location
-     * @param array $tags Optional, can be used to specify additional tags.
+     * @param string[] $tags Optional, can be used to specify additional tags.
      *
-     * @return array
+     * @return string[]
      */
     private function getCacheTags(Location $location, $tags = [])
     {