EZP-31097: Introduced strict types for URLService

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

@@ -646,6 +646,7 @@ public function testUpdateUrlStatus()
         $urlService = $repository->getURLService();
 
         $urlBeforeUpdate = $urlService->loadById($id);
+
         $updateStruct = $urlService->createUpdateStruct();
         $updateStruct->isValid = false;
         $updateStruct->lastChecked = $checked;

eZ/Publish/API/Repository/URLService.php

@@ -4,11 +4,15 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\API\Repository;
 
+use eZ\Publish\API\Repository\Values\URL\SearchResult;
 use eZ\Publish\API\Repository\Values\URL\URL;
 use eZ\Publish\API\Repository\Values\URL\URLQuery;
 use eZ\Publish\API\Repository\Values\URL\URLUpdateStruct;
+use eZ\Publish\API\Repository\Values\URL\UsageSearchResult;
 
 /**
  * URL Service.
@@ -20,17 +24,18 @@ interface URLService
      *
      * @return \eZ\Publish\API\Repository\Values\URL\URLUpdateStruct
      */
-    public function createUpdateStruct();
+    public function createUpdateStruct(): URLUpdateStruct;
 
     /**
      * Find URLs.
      *
      * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
      *
      * @param \eZ\Publish\API\Repository\Values\URL\URLQuery $query
+     *
      * @return \eZ\Publish\API\Repository\Values\URL\SearchResult
      */
-    public function findUrls(URLQuery $query);
+    public function findUrls(URLQuery $query): SearchResult;
 
     /**
      * Find content objects using URL.
@@ -40,42 +45,46 @@ public function findUrls(URLQuery $query);
      * @param \eZ\Publish\API\Repository\Values\URL\URL $url
      * @param int $offset
      * @param int $limit
+     *
      * @return \eZ\Publish\API\Repository\Values\URL\UsageSearchResult
      */
-    public function findUsages(URL $url, $offset = 0, $limit = -1);
+    public function findUsages(URL $url, int $offset = 0, int $limit = -1): UsageSearchResult;
 
     /**
      * Load single URL (by ID).
      *
+     * @param int $id ID of URL
+     *
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
      * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
      *
-     * @param int $id ID of URL
      * @return \eZ\Publish\API\Repository\Values\URL\URL
      */
-    public function loadById($id);
+    public function loadById(int $id): URL;
 
     /**
      * Load single URL (by URL).
      *
+     * @param string $url URL
+     *
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
      * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
      *
-     * @param string $url url
      * @return \eZ\Publish\API\Repository\Values\URL\URL
      */
-    public function loadByUrl($url);
+    public function loadByUrl(string $url): URL;
 
     /**
      * Updates URL.
      *
+     * @param \eZ\Publish\API\Repository\Values\URL\URL $url
+     * @param \eZ\Publish\API\Repository\Values\URL\URLUpdateStruct $struct
+     *
      * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
      * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
      * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the url already exists
      *
-     * @param \eZ\Publish\API\Repository\Values\URL\URL $url
-     * @param \eZ\Publish\API\Repository\Values\URL\URLUpdateStruct $struct
      * @return \eZ\Publish\API\Repository\Values\URL\URL
      */
-    public function updateUrl(URL $url, URLUpdateStruct $struct);
+    public function updateUrl(URL $url, URLUpdateStruct $struct): URL;
 }

eZ/Publish/Core/Event/URLService.php

@@ -33,7 +33,7 @@ public function __construct(
     public function updateUrl(
         URL $url,
         URLUpdateStruct $struct
-    ) {
+    ): URL {
         $eventData = [
             $url,
             $struct,

eZ/Publish/Core/Repository/Tests/Service/Mock/UrlTest.php

@@ -213,11 +213,6 @@ public function testUpdateUrlStatus()
         ]);
 
         $urlService = $this->createUrlService(['isUnique']);
-        $urlService
-            ->expects($this->once())
-            ->method('isUnique')
-            ->with($apiUrl->id, $apiStruct->url)
-            ->willReturn(true);
 
         $this->urlHandler
             ->expects($this->once())

eZ/Publish/Core/Repository/URLService.php

@@ -4,9 +4,12 @@
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
+
 namespace eZ\Publish\Core\Repository;
 
 use DateTime;
+use DateTimeInterface;
 use Exception;
 use eZ\Publish\API\Repository\Exceptions\NotFoundException;
 use eZ\Publish\API\Repository\PermissionResolver;
@@ -55,7 +58,7 @@ public function __construct(
     /**
      * {@inheritdoc}
      */
-    public function findUrls(URLQuery $query)
+    public function findUrls(URLQuery $query): SearchResult
     {
         if ($this->permissionResolver->hasAccess('url', 'view') === false) {
             throw new UnauthorizedException('url', 'view');
@@ -85,13 +88,13 @@ public function findUrls(URLQuery $query)
     /**
      * {@inheritdoc}
      */
-    public function updateUrl(URL $url, URLUpdateStruct $struct)
+    public function updateUrl(URL $url, URLUpdateStruct $struct): URL
     {
         if (!$this->permissionResolver->canUser('url', 'update', $url)) {
             throw new UnauthorizedException('url', 'update');
         }
 
-        if (!$this->isUnique($url->id, $struct->url)) {
+        if ($struct->url !== null && !$this->isUnique($url->id, $struct->url)) {
             throw new InvalidArgumentException('struct', 'url already exists');
         }
 
@@ -112,7 +115,7 @@ public function updateUrl(URL $url, URLUpdateStruct $struct)
     /**
      * {@inheritdoc}
      */
-    public function loadById($id)
+    public function loadById(int $id): URL
     {
         $url = $this->buildDomainObject(
             $this->urlHandler->loadById($id)
@@ -128,7 +131,7 @@ public function loadById($id)
     /**
      * {@inheritdoc}
      */
-    public function loadByUrl($url)
+    public function loadByUrl(string $url): URL
     {
         $apiUrl = $this->buildDomainObject(
             $this->urlHandler->loadByUrl($url)
@@ -144,15 +147,15 @@ public function loadByUrl($url)
     /**
      * {@inheritdoc}
      */
-    public function createUpdateStruct()
+    public function createUpdateStruct(): URLUpdateStruct
     {
         return new URLUpdateStruct();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function findUsages(URL $url, $offset = 0, $limit = -1)
+    public function findUsages(URL $url, int $offset = 0, int $limit = -1): UsageSearchResult
     {
         $contentIds = $this->urlHandler->findUsages($url->id);
         if (empty($contentIds)) {
@@ -188,7 +191,7 @@ public function findUsages(URL $url, $offset = 0, $limit = -1)
      *
      * @return \eZ\Publish\API\Repository\Values\URL\URL
      */
-    protected function buildDomainObject(SPIUrl $data)
+    protected function buildDomainObject(SPIUrl $data): URL
     {
         return new URL([
             'id' => $data->id,
@@ -208,7 +211,7 @@ protected function buildDomainObject(SPIUrl $data)
      *
      * @return \eZ\Publish\SPI\Persistence\URL\URLUpdateStruct
      */
-    protected function buildUpdateStruct(URL $url, URLUpdateStruct $data)
+    protected function buildUpdateStruct(URL $url, URLUpdateStruct $data): SPIUrlUpdateStruct
     {
         $updateStruct = new SPIUrlUpdateStruct();
 
@@ -245,9 +248,10 @@ protected function buildUpdateStruct(URL $url, URLUpdateStruct $data)
      * @param string $url
      *
      * @return bool
+     *
      * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
      */
-    protected function isUnique($id, $url)
+    protected function isUnique(int $id, string $url): bool
     {
         try {
             return $this->loadByUrl($url)->id === $id;
@@ -256,7 +260,7 @@ protected function isUnique($id, $url)
         }
     }
 
-    private function createDateTime($timestamp)
+    private function createDateTime(?int $timestamp): ?DateTimeInterface
     {
         if ($timestamp > 0) {
             return new DateTime("@{$timestamp}");

eZ/Publish/SPI/Repository/Decorator/URLServiceDecorator.php

@@ -9,9 +9,11 @@
 namespace eZ\Publish\SPI\Repository\Decorator;
 
 use eZ\Publish\API\Repository\URLService;
+use eZ\Publish\API\Repository\Values\URL\SearchResult;
 use eZ\Publish\API\Repository\Values\URL\URL;
 use eZ\Publish\API\Repository\Values\URL\URLQuery;
 use eZ\Publish\API\Repository\Values\URL\URLUpdateStruct;
+use eZ\Publish\API\Repository\Values\URL\UsageSearchResult;
 
 abstract class URLServiceDecorator implements URLService
 {
@@ -23,38 +25,38 @@ public function __construct(URLService $innerService)
         $this->innerService = $innerService;
     }
 
-    public function createUpdateStruct()
+    public function createUpdateStruct(): URLUpdateStruct
     {
         return $this->innerService->createUpdateStruct();
     }
 
-    public function findUrls(URLQuery $query)
+    public function findUrls(URLQuery $query): SearchResult
     {
         return $this->innerService->findUrls($query);
     }
 
     public function findUsages(
         URL $url,
-        $offset = 0,
-        $limit = -1
-    ) {
+        int $offset = 0,
+        int $limit = -1
+    ): UsageSearchResult {
         return $this->innerService->findUsages($url, $offset, $limit);
     }
 
-    public function loadById($id)
+    public function loadById(int $id): URL
     {
         return $this->innerService->loadById($id);
     }
 
-    public function loadByUrl($url)
+    public function loadByUrl(string $url): URL
     {
         return $this->innerService->loadByUrl($url);
     }
 
     public function updateUrl(
         URL $url,
         URLUpdateStruct $struct
-    ) {
+    ): URL {
         return $this->innerService->updateUrl($url, $struct);
     }
 }

eZ/Publish/SPI/Repository/Tests/Decorator/URLServiceDecoratorTest.php

@@ -60,8 +60,8 @@ public function testFindUsagesDecorator()
 
         $parameters = [
             $this->createMock(URL::class),
-            'random_value_5ced05ce172579.87753442',
-            'random_value_5ced05ce1725a8.96796907',
+            10,
+            100,
         ];
 
         $serviceMock->expects($this->once())->method('findUsages')->with(...$parameters);
@@ -74,7 +74,7 @@ public function testLoadByIdDecorator()
         $serviceMock = $this->createServiceMock();
         $decoratedService = $this->createDecorator($serviceMock);
 
-        $parameters = ['random_value_5ced05ce172600.22330806'];
+        $parameters = [1];
 
         $serviceMock->expects($this->once())->method('loadById')->with(...$parameters);