OXDEV-9909: Add a new SeoEncoderArticle model extension including factory

Author: MarcelOxid

CHANGELOG-v13.md

@@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Minimum PHP version is now 8.3, tested up to PHP 8.5
 - Upgraded PHPUnit from 11 to 12
 
+### Added
+- `SeoEncoderArticle` with `oeGetCategoryUri` and `oeIsFixed` method, including `SeoEncoderArticleFactory`
+
 ### Fixed
 - Graphqlite is incompatible with webonyx/graphql-php v15.31
 

metadata.php

@@ -10,6 +10,9 @@
 /**
  * Metadata version
  */
+
+use OxidEsales\GraphQL\Base\Seo\Infrastructure\Model\SeoEncoderArticle;
+
 $sMetadataVersion = '2.0';
 
 /**
@@ -31,6 +34,7 @@
     'url'         => 'www.oxid-esales.com',
     'email'       => 'info@oxid-esales.com',
     'extend'      => [
+        \OxidEsales\Eshop\Application\Model\SeoEncoderArticle::class => SeoEncoderArticle::class,
     ],
     'controllers' => [
         // Widget Controller

services.yaml

@@ -1,5 +1,6 @@
 imports:
   - { resource: src/Infrastructure/services.yaml }
+  - { resource: src/Seo/services.yaml }
 
 services:
 

src/Seo/Infrastructure/Factory/SeoEncoderArticleFactory.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\Base\Seo\Infrastructure\Factory;
+
+use OxidEsales\Eshop\Application\Model\SeoEncoderArticle;
+
+class SeoEncoderArticleFactory implements SeoEncoderArticleFactoryInterface
+{
+    public function create(): SeoEncoderArticle
+    {
+        return oxNew(SeoEncoderArticle::class);
+    }
+}

src/Seo/Infrastructure/Factory/SeoEncoderArticleFactoryInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+namespace OxidEsales\GraphQL\Base\Seo\Infrastructure\Factory;
+
+use OxidEsales\Eshop\Application\Model\SeoEncoderArticle;
+
+interface SeoEncoderArticleFactoryInterface
+{
+    public function create(): SeoEncoderArticle;
+}

src/Seo/Infrastructure/Factory/services.yaml

@@ -0,0 +1,7 @@
+services:
+  _defaults:
+    autowire: true
+    public: false
+
+  OxidEsales\GraphQL\Base\Seo\Infrastructure\Factory\SeoEncoderArticleFactoryInterface:
+    class: OxidEsales\GraphQL\Base\Seo\Infrastructure\Factory\SeoEncoderArticleFactory

src/Seo/Infrastructure/Model/SeoEncoderArticle.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\Base\Seo\Infrastructure\Model;
+
+use OxidEsales\Eshop\Application\Model\Article;
+use OxidEsales\Eshop\Application\Model\Category;
+
+/*
+ * This class is used to create proxy-methods for needed protected methods.
+ * This class will be removed as far as the used methods are public.
+ * Please avoid using this class in your code if possible!
+ */
+
+class SeoEncoderArticle extends SeoEncoderArticle_parent
+{
+    public function oeGetCategoryUri(Article $article, Category $category, int $languageId): string
+    {
+        /** @phpstan-ignore method.notFound */
+        return $this->createArticleCategoryUri($article, $category, $languageId);
+    }
+
+    public function oeIsFixed(string $objectId, int $languageId, ?string $params = null): bool
+    {
+        /** @phpstan-ignore method.notFound */
+        return $this->isFixed('oxarticle', $objectId, $languageId, null, $params);
+    }
+}

src/Seo/Infrastructure/services.yaml

@@ -0,0 +1,2 @@
+imports:
+  - { resource: Factory/services.yaml }

src/Seo/services.yaml

@@ -0,0 +1,2 @@
+imports:
+  - { resource: Infrastructure/services.yaml }

tests/Integration/Seo/Infrastructure/Factory/SeoEncoderArticleFactoryTest.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\GraphQL\Base\Tests\Integration\Seo\Infrastructure\Factory;
+
+use OxidEsales\Eshop\Application\Model\SeoEncoderArticle;
+use OxidEsales\EshopCommunity\Tests\Integration\IntegrationTestCase;
+use OxidEsales\GraphQL\Base\Seo\Infrastructure\Factory\SeoEncoderArticleFactory;
+use OxidEsales\GraphQL\Base\Seo\Infrastructure\Model\SeoEncoderArticle as ExtendedSeoEncoderArticle;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+
+#[CoversClass(SeoEncoderArticleFactory::class)]
+final class SeoEncoderArticleFactoryTest extends IntegrationTestCase
+{
+    #[Test]
+    public function createReturnsSeoEncoderArticle(): void
+    {
+        $sut = new SeoEncoderArticleFactory();
+
+        $this->assertInstanceOf(SeoEncoderArticle::class, $sut->create());
+    }
+
+    #[Test]
+    public function oxNewResolvesToOurSeoEncoderArticle(): void
+    {
+        $result = oxNew(SeoEncoderArticle::class);
+
+        $this->assertInstanceOf(ExtendedSeoEncoderArticle::class, $result);
+    }
+}