Add some missing docblocks

netgen · Nov 30, 2019 · e754bb9 · e754bb9
1 parent 4ee25eb
commit e754bb9
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 0 deletions.
diff --git a/bundle/Converter/ContentParamConverter.php b/bundle/Converter/ContentParamConverter.php
@@ -18,6 +18,13 @@ protected function getPropertyName(): string
         return 'contentId';
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     * @throws \Netgen\EzPlatformSiteApi\API\Exceptions\TranslationNotMatchedException
+     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
+     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
+     */
     protected function loadValueObject(int $id): Content
     {
         return $this->loadService->loadContent($id);

diff --git a/bundle/Converter/LocationParamConverter.php b/bundle/Converter/LocationParamConverter.php
@@ -18,6 +18,13 @@ protected function getPropertyName(): string
         return 'locationId';
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     * @throws \Netgen\EzPlatformSiteApi\API\Exceptions\TranslationNotMatchedException
+     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
+     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
+     */
     protected function loadValueObject(int $id): Location
     {
         return $this->loadService->loadLocation($id);

diff --git a/bundle/Core/Site/Settings.php b/bundle/Core/Site/Settings.php
@@ -21,6 +21,13 @@ public function __construct(ConfigResolverInterface $configResolver)
         $this->configResolver = $configResolver;
     }
 
+    /**
+     * @param string $property
+     *
+     * @throws \eZ\Publish\API\Repository\Exceptions\PropertyNotFoundException
+     *
+     * @return mixed
+     */
     public function __get(string $property)
     {
         switch ($property) {
@@ -43,11 +50,24 @@ public function __get(string $property)
         throw new PropertyNotFoundException($property, \get_class($this));
     }
 
+    /**
+     * @param string $property
+     * @param $value
+     *
+     * @throws \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
+     */
     public function __set(string $property, $value): void
     {
         throw new PropertyReadOnlyException($property, \get_class($this));
     }
 
+    /**
+     * @param string $property
+     *
+     * @throws \eZ\Publish\API\Repository\Exceptions\PropertyNotFoundException
+     *
+     * @return bool
+     */
     public function __isset(string $property): bool
     {
         switch ($property) {

diff --git a/bundle/Routing/ContentUrlAliasRouter.php b/bundle/Routing/ContentUrlAliasRouter.php
@@ -48,6 +48,8 @@ public function matchRequest(Request $request): array
      * @param mixed $name
      * @param mixed $parameters
      * @param mixed $referenceType
+     *
+     * @return string
      */
     public function generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH): string
     {

diff --git a/bundle/Routing/LocationUrlAliasRouter.php b/bundle/Routing/LocationUrlAliasRouter.php
@@ -46,6 +46,8 @@ public function matchRequest(Request $request): array
      * @param mixed $name
      * @param mixed $parameters
      * @param mixed $referenceType
+     *
+     * @return string
      */
     public function generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH): string
     {