[Task] Add @param and @return php doc types to non-internal public an…

…d protected methods (#636) * [Task] Add @param and @return php doc types to non-internal public and protected methods * Apply php-cs-fixer changes * [Task] Add @param and @return php doc types to non-internal public and protected methods mixed parameter types * Apply php-cs-fixer changes Co-authored-by: mcop1 <[email protected]>
pimcore · Nov 29, 2022 · 3a454f2 · 3a454f2
1 parent 996812b
commit 3a454f2
Show file tree

Hide file tree

Showing 208 changed files with 702 additions and 648 deletions.
diff --git a/src/Command/GraphQL/RebuildDefinitionsCommand.php b/src/Command/GraphQL/RebuildDefinitionsCommand.php
@@ -41,15 +41,16 @@ protected function configure()
     }
 
     /**
-     *
-     * @deprecated Use Pimcore\Bundle\DataHubBundle\Command\Configuration\RebuildWorkspacesCommand instead.
      *
      * @param InputInterface $input
      * @param OutputInterface $output
      *
-     * @return int|void|null
+     * @return int
      *
      * @throws \Exception
+     *
+     *@deprecated Use Pimcore\Bundle\DataHubBundle\Command\Configuration\RebuildWorkspacesCommand instead.
+     *
      */
     public function execute(InputInterface $input, OutputInterface $output)
     {

diff --git a/src/Configuration.php b/src/Configuration.php
@@ -83,6 +83,9 @@ public function __construct($type, $path, $name = null, $configuration = null)
         $this->setConfiguration($configuration ?? []);
     }
 
+    /**
+     * @return array
+     */
     public function getObjectVars()
     {
         $data = parent::getObjectVars();
@@ -133,24 +136,18 @@ public function getModificationDate()
         return $this->modificationDate;
     }
 
-    /**
-     * @return string
-     */
     public function getType(): string
     {
         return $this->type;
     }
 
-    /**
-     * @param string $type
-     */
     public function setType(string $type): void
     {
         $this->type = $type;
     }
 
     /**
-     * @param mixed $configuration
+     * @param array|null $configuration
      */
     public function setConfiguration($configuration): void
     {
@@ -164,7 +161,7 @@ public function setConfiguration($configuration): void
     }
 
     /**
-     * @return mixed
+     * @return array
      */
     public function getConfiguration()
     {
@@ -182,33 +179,21 @@ public function setName($name): void
         $this->name = $name;
     }
 
-    /**
-     * @return string|null
-     */
     public function getName(): ?string
     {
         return $this->name;
     }
 
-    /**
-     * @return string|null
-     */
     public function getGroup(): ?string
     {
         return $this->group;
     }
 
-    /**
-     * @param string|null $group
-     */
     public function setGroup(?string $group): void
     {
         $this->group = $group;
     }
 
-    /**
-     * @return string|null
-     */
     public function getSqlObjectCondition(): ?string
     {
         return $this->configuration && $this->configuration['general'] ? $this->configuration['general']['sqlObjectCondition'] ?? null : null;
@@ -238,9 +223,6 @@ public function setPath($path): void
         $this->path = $path;
     }
 
-    /**
-     * @return string|null
-     */
     public function getPath(): ?string
     {
         return $this->path;
@@ -306,9 +288,6 @@ public function save(): void
         \Pimcore::getEventDispatcher()->dispatch($event, ConfigurationEvents::CONFIGURATION_POST_SAVE);
     }
 
-    /**
-     * @return void
-     */
     public function delete(): void
     {
         if (!$this->isAllowed('delete')) {
@@ -349,9 +328,6 @@ public static function getByName($name): ?self
         }
     }
 
-    /**
-     * @return array
-     */
     public function getQueryEntities(): array
     {
         $schema = $this->configuration['schema'] ?? null;
@@ -361,9 +337,6 @@ public function getQueryEntities(): array
         return $entities;
     }
 
-    /**
-     * @return array
-     */
     public function getSpecialEntities(): array
     {
         $schema = $this->configuration['schema'] ?? null;
@@ -372,9 +345,6 @@ public function getSpecialEntities(): array
         return $entities;
     }
 
-    /**
-     * @return array
-     */
     public function getMutationEntities(): array
     {
         $schema = $this->configuration['schema'] ?? null;

diff --git a/src/Configuration/Dao.php b/src/Configuration/Dao.php
@@ -88,6 +88,11 @@ public function delete(): void
         $this->deleteData($this->model->getName());
     }
 
+    /**
+     * @param array $data
+     *
+     * @return void
+     */
     public function setVariables($data)
     {
         $this->model->setConfiguration($data);
@@ -146,11 +151,12 @@ public static function getByName($name)
 
     /**
      *
-     * @deprecated will be removed with pimcore 11
+     * @return int
+     *
+     *@deprecated will be removed with pimcore 11
      *
      * get latest modification date of configuration file.
      *
-     * @return bool|int
      */
     public static function getConfigModificationDate()
     {
@@ -160,7 +166,7 @@ public static function getConfigModificationDate()
     /**
      * get the whole configuration file content.
      *
-     * @return array|mixed|null
+     * @return array
      */
     private function &getConfig()
     {

diff --git a/src/Configuration/Workspace/AbstractWorkspace.php b/src/Configuration/Workspace/AbstractWorkspace.php
@@ -58,65 +58,41 @@ abstract class AbstractWorkspace extends AbstractModel
      */
     public $delete = false;
 
-    /**
-     * @return string
-     */
     public function getConfiguration(): string
     {
         return $this->configuration;
     }
 
-    /**
-     * @param string $configuration
-     */
     public function setConfiguration(string $configuration): void
     {
         $this->configuration = $configuration;
     }
 
-    /**
-     * @return int
-     */
     public function getCid(): int
     {
         return $this->cid;
     }
 
-    /**
-     * @param int $cid
-     */
     public function setCid(int $cid): void
     {
         $this->cid = $cid;
     }
 
-    /**
-     * @return string
-     */
     public function getCpath(): string
     {
         return $this->cpath;
     }
 
-    /**
-     * @param string $cpath
-     */
     public function setCpath(string $cpath): void
     {
         $this->cpath = $cpath;
     }
 
-    /**
-     * @return bool
-     */
     public function isCreate(): bool
     {
         return $this->create;
     }
 
-    /**
-     * @param bool $create
-     */
     public function setCreate(bool $create): void
     {
         $this->create = $create;
@@ -130,41 +106,26 @@ public function getRead()
         return $this->read;
     }
 
-    /**
-     * @param bool $read
-     */
     public function setRead(bool $read): void
     {
         $this->read = $read;
     }
 
-    /**
-     * @return bool
-     */
     public function isUpdate(): bool
     {
         return $this->update;
     }
 
-    /**
-     * @param bool $update
-     */
     public function setUpdate(bool $update): void
     {
         $this->update = $update;
     }
 
-    /**
-     * @return bool
-     */
     public function isDelete(): bool
     {
         return $this->delete;
     }
 
-    /**
-     * @param bool $delete
-     */
     public function setDelete(bool $delete): void
     {
         $this->delete = $delete;

diff --git a/src/Controller/ConfigController.php b/src/Controller/ConfigController.php
@@ -121,9 +121,9 @@ public function listAction(Request $request): JsonResponse
      *
      * @param Request $request
      *
-     * @return JsonResponse
+     * @return JsonResponse|null
      *
-     * @throws \Exception
+     * @throws ConfigWriteException
      */
     public function deleteAction(Request $request): ?JsonResponse
     {
@@ -162,9 +162,9 @@ public function deleteAction(Request $request): ?JsonResponse
      *
      * @param Request $request
      *
-     * @throws \Exception
+     * @return JsonResponse|null
      *
-     * @return JsonResponse
+     * @throws ConfigWriteException
      */
     public function addAction(Request $request): ?JsonResponse
     {
@@ -200,9 +200,7 @@ public function addAction(Request $request): ?JsonResponse
      *
      * @param Request $request
      *
-     * @throws \Exception
-     *
-     * @return JsonResponse
+     * @return JsonResponse|null
      */
     public function cloneAction(Request $request): ?JsonResponse
     {
@@ -243,10 +241,11 @@ public function cloneAction(Request $request): ?JsonResponse
      *
      * @param Request $request
      * @param Service $graphQlService
-     *
-     * @throws \Exception
+     * @param EventDispatcherInterface $eventDispatcher
      *
      * @return JsonResponse
+     *
+     * @throws \Exception
      */
     public function getAction(Request $request, Service $graphQlService, EventDispatcherInterface $eventDispatcher): JsonResponse
     {
@@ -397,9 +396,7 @@ public function getAction(Request $request, Service $graphQlService, EventDispat
      *
      * @param Request $request
      *
-     * @throws \Exception
-     *
-     * @return JsonResponse
+     * @return JsonResponse|null
      */
     public function saveAction(Request $request): ?JsonResponse
     {
@@ -483,9 +480,9 @@ public function saveAction(Request $request): ?JsonResponse
      * @param RouterInterface $routingService
      * @param Request $request
      *
-     * @throws \Exception
+     * @return JsonResponse|null
      *
-     * @return JsonResponse
+     * @throws \Exception
      */
     public function getExplorerUrlAction(RouterInterface $routingService, Request $request): ?JsonResponse
     {

diff --git a/src/Controller/WebserviceController.php b/src/Controller/WebserviceController.php
@@ -18,6 +18,7 @@
 use GraphQL\Error\DebugFlag;
 use GraphQL\Error\Warning;
 use GraphQL\GraphQL;
+use GraphQL\Server\RequestError;
 use GraphQL\Validator\DocumentValidator;
 use GraphQL\Validator\Rules\DisableIntrospection;
 use Pimcore\Bundle\DataHubBundle\Configuration;
@@ -66,9 +67,6 @@ class WebserviceController extends FrontendController
      */
     private $uploadService;
 
-    /**
-     * @param EventDispatcherInterface $eventDispatcher
-     */
     public function __construct(
         EventDispatcherInterface $eventDispatcher,
         CheckConsumerPermissionsService $permissionsService,
@@ -86,10 +84,11 @@ public function __construct(
      * @param LocaleServiceInterface $localeService
      * @param Factory $modelFactory
      * @param Request $request
+     * @param LongRunningHelper $longRunningHelper
      *
      * @return JsonResponse
      *
-     * @throws \Exception
+     * @throws RequestError
      */
     public function webonyxAction(
         Service $service,