ezsystems / ezpublish-kernel

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/REST/Client/LocationService.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,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
      */
@@ -218,7 +218,7 @@ 
      * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
      * @param \eZ\Publish\API\Repository\Values\Content\Location $rootLocation
      *
-     * @return \eZ\Publish\API\Repository\Values\Content\Location[]
+     * @return \eZ\Publish\API\Repository\Values\ValueObject
      */
     public function loadLocations(ContentInfo $contentInfo, Location $rootLocation = null)
     {

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

Doc Comments +13 added lines, -13 removed lines

@@ -209,8 +209,8 @@ 
      * @todo Either move to async/batch or find ways toward optimizing away operations per object.
      * @todo Optionally retain dates and set creator
      *
-     * @param mixed $sourceId
-     * @param mixed $destinationParentId
+     * @param integer $sourceId
+     * @param integer $destinationParentId
      * @param int|null $newOwnerId
      *
      * @return Location the newly created Location.
@@ -368,10 +368,10 @@ 
      * destination, identified by $destinationParentId. Relations do not need
      * to be updated, since they refer to Content. URLs are not touched.
      *
-     * @param mixed $sourceId
-     * @param mixed $destinationParentId
+     * @param integer $sourceId
+     * @param integer $destinationParentId
      *
-     * @return bool
+     * @return boolean|null
      */
     public function move($sourceId, $destinationParentId)
     {
@@ -414,7 +414,7 @@ 
     /**
      * Sets a location to be hidden, and it self + all children to invisible.
      *
-     * @param mixed $id Location ID
+     * @param integer $id Location ID
      */
     public function hide($id)
     {
@@ -427,7 +427,7 @@ 
      * Sets a location to be unhidden, and self + children to visible unless a parent is hiding the tree.
      * If not make sure only children down to first hidden node is marked visible.
      *
-     * @param mixed $id
+     * @param integer $id
      */
     public function unHide($id)
     {
@@ -442,10 +442,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)
     {
@@ -492,9 +492,9 @@ 
      * main Location will get the first of its other Locations assigned as the
      * new main Location.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
-     * @return bool
+     * @return boolean|null
      */
     public function removeSubtree($locationId)
     {
@@ -505,7 +505,7 @@ 
      * Set section on all content objects in the subtree.
      *
      * @param mixed $locationId
-     * @param mixed $sectionId
+     * @param integer $sectionId
      */
     public function setSectionForSubtree($locationId, $sectionId)
     {

eZ/Publish/API/Repository/Tests/LocationServiceTest.php

Doc Comments +6 added lines, -6 removed lines

@@ -763,7 +763,7 @@ 
     /**
      * Test for the loadLocationChildren() method.
      *
-     * @return \eZ\Publish\API\Repository\Values\Content\Location[]
+     * @return LocationList
      *
      * @see \eZ\Publish\API\Repository\LocationService::loadLocationChildren($location, $offset)
      * @depends eZ\Publish\API\Repository\Tests\LocationServiceTest::testLoadLocationChildren
@@ -827,7 +827,7 @@ 
     /**
      * Test for the loadLocationChildren() method.
      *
-     * @return \eZ\Publish\API\Repository\Values\Content\Location[]
+     * @return LocationList
      *
      * @see \eZ\Publish\API\Repository\LocationService::loadLocationChildren($location, $offset, $limit)
      * @depends eZ\Publish\API\Repository\Tests\LocationServiceTest::testLoadLocationChildren
@@ -856,7 +856,7 @@ 
     /**
      * Test for the loadLocationChildren() method.
      *
-     * @param \eZ\Publish\API\Repository\Values\Content\Location[] $locations
+     * @param LocationList $locations
      *
      * @see \eZ\Publish\API\Repository\LocationService::loadLocationChildren($location, $offset, $limit)
      * @depends eZ\Publish\API\Repository\Tests\LocationServiceTest::testLoadLocationChildrenWithOffsetAndLimit
@@ -1140,7 +1140,7 @@ 
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
      * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
      *
-     * @return int[]
+     * @return Content[]
      */
     public function testSwapLocationForMainAndSecondaryLocation()
     {
@@ -2342,7 +2342,7 @@ 
      * Assert generated aliases to expected alias return.
      *
      * @param \eZ\Publish\API\Repository\URLAliasService $urlAliasService
-     * @param array $expectedAliases
+     * @param string[] $expectedAliases
      */
     protected function assertGeneratedAliases($urlAliasService, array $expectedAliases)
     {
@@ -2354,7 +2354,7 @@ 
 
     /**
      * @param \eZ\Publish\API\Repository\URLAliasService $urlAliasService
-     * @param array $expectedSubItemAliases
+     * @param string[] $expectedSubItemAliases
      */
     private function assertAliasesBeforeCopy($urlAliasService, array $expectedSubItemAliases)
     {

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

Doc Comments +23 added lines, -20 removed lines

@@ -96,7 +96,7 @@ 
      *
      * @todo optimize
      *
-     * @param mixed $remoteId
+     * @param string $remoteId
      *
      * @return array
      */
@@ -250,7 +250,7 @@ 
     /**
      * Returns data for the first level children of the location identified by given $locationId.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
      * @return array
      */
@@ -377,6 +377,9 @@ 
         }
     }
 
+    /**
+     * @param string $pathString
+     */
     private function isHiddenByParent($pathString, array $rows)
     {
         $parentNodeIds = explode('/', trim($pathString, '/'));
@@ -577,8 +580,8 @@ 
      * 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
      */
@@ -754,7 +757,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)
@@ -882,8 +885,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)
     {
@@ -951,8 +954,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)
     {
@@ -1111,8 +1114,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
      */
@@ -1148,9 +1151,9 @@ 
      *
      * The associated content object is left untouched.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
-     * @return bool
+     * @return boolean|null
      */
     public function trashLocation($locationId)
     {
@@ -1179,8 +1182,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
      */
@@ -1433,10 +1436,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)
@@ -1564,7 +1567,7 @@ 
     /**
      * Get Query Builder for fetching data of all Locations except the Root node.
      *
-     * @param array $columns list of columns to fetch
+     * @param string[] $columns list of columns to fetch
      *
      * @return \Doctrine\DBAL\Query\QueryBuilder
      */

eZ/Publish/Core/MVC/Symfony/Templating/Twig/Extension/FileSizeExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
     /**
      * Returns a list of filters to add to the existing list.
      *
-     * @return array An array of filters
+     * @return Twig_SimpleFilter[] An array of filters
      */
     public function getFilters()
     {

eZ/Bundle/EzPublishRestBundle/Tests/Functional/TestCase.php

Doc Comments +11 added lines, -1 removed lines

@@ -109,6 +109,7 @@ 
     }
 
     /**
+     * @param string $method
      * @return HttpRequest
      */
     public function createHttpRequest($method, $uri, $contentType = '', $acceptType = '')
@@ -170,6 +171,9 @@ 
         return $errorMessageString;
     }
 
+    /**
+     * @param string $header
+     */
     protected function assertHttpResponseHasHeader(HttpResponse $response, $header, $expectedValue = null)
     {
         $headerValue = $response->getHeader($header);
@@ -179,6 +183,9 @@ 
         }
     }
 
+    /**
+     * @param string $typeString
+     */
     protected function generateMediaTypeString($typeString)
     {
         return "application/vnd.ez.api.$typeString";
@@ -209,7 +216,7 @@ 
     /**
      * @param string $string The value of the folders name field
      * @param string $parentLocationId The REST id of the parent location
-     * @param null $remoteId
+     * @param string $remoteId
      *
      * @return array created Content, as an array
      */
@@ -294,6 +301,9 @@ 
         return $folderLocations;
     }
 
+    /**
+     * @param string $string
+     */
     protected function addTestSuffix($string)
     {
         if (!isset(self::$testSuffix)) {

eZ/Bundle/EzPublishCoreBundle/Features/Context/UserContext.php

Doc Comments +11 added lines, -8 removed lines

@@ -62,9 +62,9 @@ 
      * Search User with given username, optionally at given location.
      *
      * @param string $username name of User to search for
-     * @param string $parentGroupLocationId where to search, in User Group tree
+     * @param string $parentGroupId where to search, in User Group tree
      *
-     * @return User found
+     * @return null|\eZ\Publish\API\Repository\Values\User\User found
      */
     public function searchUserByLogin($username, $parentGroupId = null)
     {
@@ -95,7 +95,7 @@ 
      * @param string $name name of User Group to search for
      * @param string $parentLocationId (optional) parent location id to search in
      *
-     * @return search results
+     * @return \eZ\Publish\API\Repository\Values\Content\Search\SearchHit[] results
      */
     public function searchUserGroups($name, $parentLocationId = null)
     {
@@ -118,12 +118,12 @@ 
     /**
      * Create user inside given User Group; DELETES existing User if login already exists!
      *
-     * @param $username username of the user to create
-     * @param $email email address of user to create
-     * @param $password account password for user to create
-     * @param $parentGroup pathstring wherein to create user
+     * @param string $username username of the user to create
+     * @param string $email email address of user to create
+     * @param string $password account password for user to create
+     * @param \eZ\Publish\API\Repository\Values\User\UserGroup $parentGroup pathstring wherein to create user
      *
-     * @return eZ\Publish\API\Repository\Values\User\User
+     * @return \eZ\Publish\API\Repository\Values\User\User
      */
     protected function createUser($username, $email, $password, $parentGroup = null, $fields = [])
     {
@@ -317,6 +317,9 @@ 
         return false;
     }
 
+    /**
+     * @param integer $type
+     */
     public function createPasswordHash($login, $password, $type)
     {
         switch ($type) {