ezsystems / ezpublish-kernel

eZ/Publish/Core/REST/Common/Output/Generator.php

Doc Comments +15 added lines, -12 removed lines

@@ -32,6 +32,9 @@ 
      */
     protected $formatOutput = false;
 
+    /**
+     * @param boolean $formatOutput
+     */
     public function setFormatOutput($formatOutput)
     {
         $this->formatOutput = (bool)$formatOutput;
@@ -108,7 +111,7 @@ 
     /**
      * Check start object element.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkStartObjectElement($data)
     {
@@ -136,7 +139,7 @@ 
     /**
      * Check end object element.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkEndObjectElement($data)
     {
@@ -153,7 +156,7 @@ 
     /**
      * Check start hash element.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkStartHashElement($data)
     {
@@ -181,7 +184,7 @@ 
     /**
      * Check end hash element.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkEndHashElement($data)
     {
@@ -199,7 +202,7 @@ 
     /**
      * Check start value element.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkStartValueElement($data)
     {
@@ -216,7 +219,7 @@ 
     /**
      * Check end value element.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkEndValueElement($data)
     {
@@ -233,7 +236,7 @@ 
     /**
      * Check start list.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkStartList($data)
     {
@@ -250,7 +253,7 @@ 
     /**
      * Check end list.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkEndList($data)
     {
@@ -268,7 +271,7 @@ 
     /**
      * Check start attribute.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkStartAttribute($data)
     {
@@ -285,7 +288,7 @@ 
     /**
      * Check end attribute.
      *
-     * @param mixed $data
+     * @param string $data
      */
     protected function checkEndAttribute($data)
     {
@@ -329,7 +332,7 @@ 
      *
      * @param string $type
      * @param mixed $data
-     * @param array $validParents
+     * @param string[] $validParents
      */
     protected function checkStart($type, $data, array $validParents)
     {
@@ -393,7 +396,7 @@ 
      *
      * @param bool $boolValue
      *
-     * @return mixed
+     * @return string
      */
     abstract public function serializeBool($boolValue);
 }

eZ/Publish/Core/FieldType/Tests/RichText/Normalizer/DocumentTypeDefinitionTest.php

Doc Comments +5 added lines

@@ -213,6 +213,11 @@
         $this->assertFalse($normalizer->accept($input));
     }
 
+    /**
+     * @param string $documentElement
+     * @param string $namespace
+     * @param string $dtdPath
+     */
     protected function getNormalizer($documentElement, $namespace, $dtdPath)
     {
         return new DocumentTypeDefinition($documentElement, $namespace, $dtdPath);

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

Doc Comments +26 added lines, -23 removed lines

@@ -91,7 +91,7 @@ 
      *
      * @todo optimize
      *
-     * @param mixed $remoteId
+     * @param string $remoteId
      *
      * @return array
      */
@@ -246,7 +246,7 @@ 
     /**
      * Returns data for the first level children of the location identified by given $locationId.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
      * @return array
      */
@@ -380,6 +380,9 @@ 
         }
     }
 
+    /**
+     * @param string $pathString
+     */
     private function isHiddenByParent($pathString, array $rows)
     {
         $parentNodeIds = explode('/', trim($pathString, '/'));
@@ -579,10 +582,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)
     {
@@ -739,7 +742,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)
@@ -867,8 +870,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)
     {
@@ -936,8 +939,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)
     {
@@ -1096,8 +1099,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
      */
@@ -1133,9 +1136,9 @@ 
      *
      * The associated content object is left untouched.
      *
-     * @param mixed $locationId
+     * @param integer $locationId
      *
-     * @return bool
+     * @return boolean|null
      */
     public function trashLocation($locationId)
     {
@@ -1164,8 +1167,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
      */
@@ -1339,10 +1342,10 @@ 
     /**
      * Set section on all content objects in the subtree.
      *
-     * @param mixed $pathString
-     * @param mixed $sectionId
+     * @param string $pathString
+     * @param integer $sectionId
      *
-     * @return bool
+     * @return boolean|null
      */
     public function setSectionForSubtree($pathString, $sectionId)
     {
@@ -1408,10 +1411,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)

eZ/Publish/Core/Repository/Helper/DomainMapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -360,7 +360,7 @@
      * @param \eZ\Publish\API\Repository\Values\Content\Location $parentLocation
      * @param mixed $mainLocation
      * @param mixed $contentId
-     * @param mixed $contentVersionNo
+     * @param null|integer $contentVersionNo
      *
      * @return \eZ\Publish\SPI\Persistence\Content\Location\CreateStruct
      */

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

Unused Use Statements -1 removed lines

@@ -11,7 +11,6 @@
 namespace eZ\Bundle\EzPublishRestBundle\Tests\Functional;
 
 use eZ\Bundle\EzPublishRestBundle\Tests\Functional\TestCase as RESTFunctionalTestCase;
-use eZ\Publish\API\Repository\Values\User\Limitation;
 
 class RoleTest extends RESTFunctionalTestCase
 {

Doc Comments +1 added lines, -1 removed lines

@@ -117,6 +117,7 @@ 
      * @depends testCreateRole
      * Covers POST /user/roles/{roleId}
      *
+     * @param string $roleHref
      * @return string The created role draft href
      */
     public function testCreateRoleDraft($roleHref)
@@ -410,7 +411,6 @@ 
     /**
      * @covers       \POST /user/users/{userId}/roles
      *
-     * @param string $roleHref
      * @param array $limitation
      *
      * @return string assigned role href

eZ/Publish/Core/Base/Container/ApiLoader/FieldTypeNameableCollectionFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
      * Registers an eZ Publish field type.
      * Field types are being registered as a closure so that they will be lazy loaded.
      *
-     * @param string $nameableFieldTypeServiceId The field type nameable service Id
+     * @param string $fieldTypeServiceId The field type nameable service Id
      * @param string $fieldTypeAlias The field type alias (e.g. "ezstring")
      */
     public function registerNonNameableFieldType($fieldTypeServiceId, $fieldTypeAlias)

eZ/Bundle/EzPublishRestBundle/DependencyInjection/Configuration.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
         return $treeBuilder;
     }
 
+    /**
+     * @param \Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition $rootNode
+     */
     public function addRestRootResourcesSection($rootNode)
     {
         $systemNode = $this->generateScopeBaseNode($rootNode);

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

Doc Comments +5 added lines, -5 removed lines

@@ -762,7 +762,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
@@ -826,7 +826,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
@@ -855,7 +855,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
@@ -2127,7 +2127,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)
     {
@@ -2139,7 +2139,7 @@ 
 
     /**
      * @param \eZ\Publish\API\Repository\URLAliasService $urlAliasService
-     * @param array $expectedSubItemAliases
+     * @param string[] $expectedSubItemAliases
      */
     private function assertAliasesBeforeCopy($urlAliasService, array $expectedSubItemAliases)
     {

eZ/Publish/Core/Search/Common/FieldValueMapper/DateMapper.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
      *
      * @param \eZ\Publish\SPI\Search\Field $field
      *
-     * @return mixed
+     * @return boolean
      */
     public function canMap(Field $field)
     {
@@ -39,7 +39,7 @@ 
      *
      * @param \eZ\Publish\SPI\Search\Field $field
      *
-     * @return mixed
+     * @return string
      */
     public function map(Field $field)
     {