ezsystems / ezpublish-kernel

eZ/Publish/Core/Persistence/Legacy/Tests/Content/StorageRegistryTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
     /**
      * Returns a mock for Storage.
      *
-     * @return Storage
+     * @return \PHPUnit\Framework\MockObject\MockObject
      */
     protected function getStorageMock()
     {

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

Doc Comments +20 added lines, -17 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, '/'));
@@ -751,7 +754,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)
@@ -879,8 +882,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)
     {
@@ -948,8 +951,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)
     {
@@ -1108,8 +1111,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
      */
@@ -1145,9 +1148,9 @@ 
      *
      * The associated content object is left untouched.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
-     * @return bool
+     * @return boolean|null
      */
     public function trashLocation($locationId)
     {
@@ -1177,8 +1180,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
      */
@@ -1431,10 +1434,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 @@ 
      *
      * @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/FieldType/Author/Type.php

Doc Comments +2 added lines, -2 removed lines

@@ -212,7 +212,7 @@ 
      *
      * @param string $name
      *
-     * @return \eZ\Publish\SPI\FieldType\ValidationError|null
+     * @return ValidationError|null
      */
     private function validateSettingName($name)
     {
@@ -236,7 +236,7 @@ 
      * @param string $name
      * @param string $value
      *
-     * @return \eZ\Publish\SPI\FieldType\ValidationError|null
+     * @return ValidationError|null
      */
     private function validateDefaultAuthorSetting($name, $value)
     {

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

Doc Comments +13 added lines, -14 removed lines

@@ -94,7 +94,7 @@ 
     }
 
     /**
-     * @param mixed $groupId
+     * @param integer $groupId
      *
      * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException If type group contains types
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException If type group with id is not found
@@ -175,7 +175,7 @@ 
     }
 
     /**
-     * @param mixed $groupId
+     * @param integer $groupId
      * @param int $status
      *
      * @return Type[]
@@ -237,7 +237,7 @@ 
      *
      * Note: This method is responsible of having the Field Definitions of the loaded ContentType sorted by placement.
      *
-     * @param mixed $remoteId
+     * @param string $remoteId
      *
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException If defined type is not found
      *
@@ -338,7 +338,6 @@ 
     /**
      * @param mixed $typeId
      * @param int $status
-     * @param \eZ\Publish\SPI\Persistence\Content\Type\UpdateStruct $contentType
      *
      * @return Type
      */
@@ -355,7 +354,7 @@ 
     /**
      * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException If type is defined and still has content
      *
-     * @param mixed $contentTypeId
+     * @param integer $contentTypeId
      * @param int $status
      *
      * @return bool
@@ -437,8 +436,8 @@ 
     /**
      * Unlink a content type group from a content type.
      *
-     * @param mixed $groupId
-     * @param mixed $contentTypeId
+     * @param integer $groupId
+     * @param integer $contentTypeId
      * @param int $status
      *
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException If group or type with provided status is not found
@@ -462,8 +461,8 @@ 
     /**
      * Link a content type group with a content type.
      *
-     * @param mixed $groupId
-     * @param mixed $contentTypeId
+     * @param integer $groupId
+     * @param integer $contentTypeId
      *
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException If group or type with provided status is not found
      * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException If type is already part of group
@@ -509,7 +508,7 @@ 
     /**
      * Counts the number of Content instances of the ContentType identified by given $contentTypeId.
      *
-     * @param mixed $contentTypeId
+     * @param integer $contentTypeId
      *
      * @return int
      */
@@ -525,7 +524,7 @@ 
      * added. It does not update existing content objects depending on the
      * field (default) values.
      *
-     * @param mixed $contentTypeId
+     * @param integer $contentTypeId
      * @param int $status One of Type::STATUS_DEFINED|Type::STATUS_DRAFT|Type::STATUS_MODIFIED
      * @param \eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition
      */
@@ -548,8 +547,8 @@ 
      * referred to by $fieldDefinitionId removed. It does not update existing
      * content objects depending on the field (default) values.
      *
-     * @param mixed $contentTypeId
-     * @param mixed $fieldDefinitionId
+     * @param integer $contentTypeId
+     * @param integer $fieldDefinitionId
      *
      * @return bool
      */
@@ -568,7 +567,7 @@ 
      * on the
      * field (default) values.
      *
-     * @param mixed $contentTypeId
+     * @param integer $contentTypeId
      * @param \eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition
      */
     public function updateFieldDefinition($contentTypeId, $status, FieldDefinition $fieldDefinition)

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/Publish/Core/Persistence/Cache/UrlAliasHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -383,7 +383,7 @@
      * @param \eZ\Publish\SPI\Persistence\Content\UrlAlias $urlAlias
      * @param array $tags Optional, can be used to specify other tags.
      *
-     * @return array
+     * @return string[]
      */
     private function getCacheTags(UrlAlias $urlAlias, array $tags = [])
     {

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) {

eZ/Bundle/EzPublishIOBundle/BinaryStreamResponse.php

Doc Comments +2 added lines, -4 removed lines

@@ -44,7 +44,6 @@ 
      * @param array               $headers            An array of response headers
      * @param bool                $public             Files are public by default
      * @param null|string         $contentDisposition The type of Content-Disposition to set automatically with the filename
-     * @param bool                $autoEtag           Whether the ETag header should be automatically set
      * @param bool                $autoLastModified   Whether the Last-Modified header should be automatically set
      */
     public function __construct(BinaryFile $binaryFile, IOServiceInterface $ioService, $status = 200, $headers = [], $public = true, $contentDisposition = null, $autoLastModified = true)
@@ -63,12 +62,11 @@ 
     /**
      * Sets the file to stream.
      *
-     * @param \SplFileInfo|string $file The file to stream
+     * @param BinaryFile $file The file to stream
      * @param string $contentDisposition
-     * @param bool $autoEtag
      * @param bool $autoLastModified
      *
-     * @return BinaryFileResponse
+     * @return BinaryStreamResponse
      */
     public function setFile($file, $contentDisposition = null, $autoLastModified = true)
     {

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

Doc Comments +1 added lines, -2 removed lines

@@ -215,7 +215,6 @@ 
      *
      * @param \eZ\Publish\API\Repository\Values\ValueObject $expectedValues
      * @param \eZ\Publish\API\Repository\Values\ValueObject $actualObject
-     * @param array $propertyNames
      */
     protected function assertStructPropertiesCorrect(ValueObject $expectedValues, ValueObject $actualObject, array $additionalProperties = [])
     {
@@ -477,7 +476,7 @@ 
     /**
      * Create role of a given name with the given policies described by an array.
      *
-     * @param $roleName
+     * @param string $roleName
      * @param array $policiesData [['module' => 'content', 'function' => 'read', 'limitations' => []]
      *
      * @return \eZ\Publish\API\Repository\Values\User\Role