Move Url related functionality to separate Url namespace

Signed-off-by: Anton Fedurtsya <[email protected]>

services.yaml

@@ -1,10 +1,10 @@
 imports:
   - { resource: src/ChangeFilter/services.yaml }
   - { resource: src/Command/services.yaml }
-  - { resource: src/PageType/services.yaml }
   - { resource: src/Repository/services.yaml }
   - { resource: src/Service/services.yaml }
   - { resource: src/Settings/services.yaml }
+  - { resource: src/Url/services.yaml }
 
 services:
     _defaults:

src/ChangeFilter/ChangeFilterTemplate.php

@@ -13,11 +13,9 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\ForwardCompatibility\Result;
 use FreshAdvance\Sitemap\DataStructure\ObjectUrl;
-use FreshAdvance\Sitemap\DataStructure\PageUrl;
-use FreshAdvance\Sitemap\PageType\PageTypeConfigurationInterface;
 use FreshAdvance\Sitemap\Repository\ModelItemRepositoryInterface;
-use OxidEsales\EshopCommunity\Core\Contract\IUrl;
-use OxidEsales\EshopCommunity\Core\Model\BaseModel;
+use FreshAdvance\Sitemap\Url\DataType\UrlTypeInterface;
+use Generator;
 use OxidEsales\EshopCommunity\Internal\Framework\Database\ConnectionProviderInterface;
 
 abstract class ChangeFilterTemplate
@@ -26,13 +24,13 @@ abstract class ChangeFilterTemplate
 
     public function __construct(
         ConnectionProviderInterface $connectionProvider,
-        protected PageTypeConfigurationInterface $pageTypeConfiguration,
+        protected UrlTypeInterface $pageTypeConfiguration,
         protected ModelItemRepositoryInterface $modelItemRepository,
     ) {
         $this->connection = $connectionProvider->get();
     }
 
-    public function queryAndFetchObjectUrl(string $query, array $queryParameters): \Generator
+    public function queryAndFetchObjectUrl(string $query, array $queryParameters): Generator
     {
         /** @var Result $result */
         $result = $this->connection->executeQuery(

src/ChangeFilter/services.yaml

@@ -11,21 +11,21 @@ services:
 
   FreshAdvance\Sitemap\ChangeFilter\ContentChangeFilter:
     arguments:
-      $pageTypeConfiguration: '@FreshAdvance\Sitemap\PageType\ContentConfiguration'
+      $pageTypeConfiguration: '@FreshAdvance\Sitemap\Url\DataTypeFactory\ContentUrlType'
       $modelItemRepository: '@FreshAdvance\Sitemap\Repository\ContentModelItemRepository'
     tags:
       - 'sitemap.change_filter'
 
   FreshAdvance\Sitemap\ChangeFilter\ProductChangeFilter:
     arguments:
-      $pageTypeConfiguration: '@FreshAdvance\Sitemap\PageType\ProductConfiguration'
+      $pageTypeConfiguration: '@FreshAdvance\Sitemap\Url\DataTypeFactory\ProductUrlType'
       $modelItemRepository: '@FreshAdvance\Sitemap\Repository\ProductModelItemRepository'
     tags:
       - 'sitemap.change_filter'
 
   FreshAdvance\Sitemap\ChangeFilter\CategoryChangeFilter:
     arguments:
-      $pageTypeConfiguration: '@FreshAdvance\Sitemap\PageType\CategoryConfiguration'
+      $pageTypeConfiguration: '@FreshAdvance\Sitemap\Url\DataTypeFactory\CategoryUrlType'
       $modelItemRepository: '@FreshAdvance\Sitemap\Repository\CategoryModelItemRepository'
     tags:
       - 'sitemap.change_filter'

src/Command/UpdateTypeCommand.php

@@ -9,7 +9,6 @@
 
 namespace FreshAdvance\Sitemap\Command;
 
-use FreshAdvance\Sitemap\ChangeFilter\FilterFactoryInterface;
 use FreshAdvance\Sitemap\Service\SynchronizerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;

src/DataStructure/ObjectUrl.php

@@ -9,13 +9,15 @@
 
 namespace FreshAdvance\Sitemap\DataStructure;
 
+use DateTimeInterface;
+
 class ObjectUrl implements ObjectUrlInterface
 {
     public function __construct(
         private string $objectId,
         private string $objectType,
         private string $location,
-        private \DateTimeInterface $modified,
+        private DateTimeInterface $modified,
     ) {
     }
 
@@ -34,7 +36,7 @@ public function getLocation(): string
         return $this->location;
     }
 
-    public function getModified(): \DateTimeInterface
+    public function getModified(): DateTimeInterface
     {
         return $this->modified;
     }

src/DataStructure/ObjectUrlInterface.php

@@ -7,6 +7,8 @@
 
 namespace FreshAdvance\Sitemap\DataStructure;
 
+use DateTimeInterface;
+
 interface ObjectUrlInterface
 {
     public function getObjectId(): string;
@@ -15,5 +17,5 @@ public function getObjectType(): string;
 
     public function getLocation(): string;
 
-    public function getModified(): \DateTimeInterface;
+    public function getModified(): DateTimeInterface;
 }

src/DataStructure/SitemapUrl.php

@@ -9,11 +9,13 @@
 
 namespace FreshAdvance\Sitemap\DataStructure;
 
+use DateTimeInterface;
+
 class SitemapUrl implements SitemapUrlInterface
 {
     public function __construct(
         protected string $location,
-        protected \DateTimeInterface $lastModified
+        protected DateTimeInterface $lastModified
     ) {
     }
 
@@ -22,7 +24,7 @@ public function getLocation(): string
         return $this->location;
     }
 
-    public function getLastModified(): \DateTimeInterface
+    public function getLastModified(): DateTimeInterface
     {
         return $this->lastModified;
     }

src/DataStructure/SitemapUrlInterface.php

@@ -7,9 +7,11 @@
 
 namespace FreshAdvance\Sitemap\DataStructure;
 
+use DateTimeInterface;
+
 interface SitemapUrlInterface
 {
     public function getLocation(): string;
 
-    public function getLastModified(): \DateTimeInterface;
+    public function getLastModified(): DateTimeInterface;
 }

src/Exception/FilterConfigurationException.php

@@ -9,6 +9,8 @@
 
 namespace FreshAdvance\Sitemap\Exception;
 
-class FilterConfigurationException extends \Exception
+use Exception;
+
+class FilterConfigurationException extends Exception
 {
 }

src/Exception/FilterNotFoundException.php

@@ -9,6 +9,8 @@
 
 namespace FreshAdvance\Sitemap\Exception;
 
-class FilterNotFoundException extends \Exception
+use Exception;
+
+class FilterNotFoundException extends Exception
 {
 }

src/Exception/ModelItemNotFoundException.php

@@ -9,6 +9,8 @@
 
 namespace FreshAdvance\Sitemap\Exception;
 
-class ModelItemNotFoundException extends \Exception
+use Exception;
+
+class ModelItemNotFoundException extends Exception
 {
 }

src/Exception/SitemapDirectoryAccessException.php

@@ -9,6 +9,8 @@
 
 namespace FreshAdvance\Sitemap\Exception;
 
-class SitemapDirectoryAccessException extends \Exception
+use Exception;
+
+class SitemapDirectoryAccessException extends Exception
 {
 }

src/Repository/services.yaml

@@ -18,6 +18,3 @@ services:
     class: FreshAdvance\Sitemap\Repository\ModelItemRepository
     arguments:
       $model: '\OxidEsales\Eshop\Application\Model\Content'
-
-  FreshAdvance\Sitemap\Repository\UrlRepositoryInterface:
-    class: FreshAdvance\Sitemap\Repository\UrlRepository

src/Service/Sitemap.php

@@ -10,8 +10,8 @@
 namespace FreshAdvance\Sitemap\Service;
 
 use FreshAdvance\Sitemap\DataStructure\SitemapUrlInterface;
-use FreshAdvance\Sitemap\Repository\UrlRepositoryInterface;
 use FreshAdvance\Sitemap\Settings\LocationServiceInterface;
+use FreshAdvance\Sitemap\Url\Repository\UrlRepositoryInterface;
 
 class Sitemap implements SitemapInterface
 {

src/Service/Synchronizer.php

@@ -10,7 +10,7 @@
 namespace FreshAdvance\Sitemap\Service;
 
 use FreshAdvance\Sitemap\ChangeFilter\FilterFactoryInterface;
-use FreshAdvance\Sitemap\Repository\UrlRepositoryInterface;
+use FreshAdvance\Sitemap\Url\Repository\UrlRepositoryInterface;
 
 class Synchronizer implements SynchronizerInterface
 {

src/Service/XmlGenerator.php

@@ -9,16 +9,17 @@
 
 namespace FreshAdvance\Sitemap\Service;
 
-use FreshAdvance\Sitemap\DataStructure\PageUrlInterface;
+use DateTimeInterface;
 use FreshAdvance\Sitemap\DataStructure\SitemapUrlInterface;
+use FreshAdvance\Sitemap\Url\DataType\UrlInterface;
 
 class XmlGenerator implements XmlGeneratorInterface
 {
-    public function generateUrlItem(PageUrlInterface $url): string
+    public function generateUrlItem(UrlInterface $url): string
     {
         $attributes = [
             $this->wrap($url->getLocation(), "loc"),
-            $this->wrap($url->getLastModified()->format(\DateTimeInterface::ATOM), "lastmod"),
+            $this->wrap($url->getLastModified()->format(DateTimeInterface::ATOM), "lastmod"),
             $this->wrap($url->getChangeFrequency(), "changefreq"),
             $this->wrap((string)$url->getPriority(), "priority"),
         ];
@@ -30,7 +31,7 @@ public function generateSitemapItem(SitemapUrlInterface $url): string
     {
         $attributes = [
             $this->wrap($url->getLocation(), "loc"),
-            $this->wrap($url->getLastModified()->format(\DateTimeInterface::ATOM), "lastmod"),
+            $this->wrap($url->getLastModified()->format(DateTimeInterface::ATOM), "lastmod"),
         ];
 
         return $this->wrap(implode("", $attributes), "sitemap");

src/Service/XmlGeneratorInterface.php

@@ -7,13 +7,13 @@
 
 namespace FreshAdvance\Sitemap\Service;
 
-use FreshAdvance\Sitemap\DataStructure\PageUrlInterface;
 use FreshAdvance\Sitemap\DataStructure\SitemapUrlInterface;
+use FreshAdvance\Sitemap\Url\DataType\UrlInterface;
 
 interface XmlGeneratorInterface
 {
     /**
-     * @param iterable<PageUrlInterface> $items
+     * @param iterable<UrlInterface> $items
      */
     public function generateSitemapDocument(iterable $items): string;
 

src/Service/services.yaml

@@ -13,8 +13,5 @@ services:
   FreshAdvance\Sitemap\Service\SynchronizerInterface:
     class: FreshAdvance\Sitemap\Service\Synchronizer
 
-  FreshAdvance\Sitemap\Service\UrlFactoryInterface:
-    class: FreshAdvance\Sitemap\Service\UrlFactory
-
   FreshAdvance\Sitemap\Service\XmlGeneratorInterface:
     class: FreshAdvance\Sitemap\Service\XmlGenerator