Added teaser-provider (#11)

* added teaser-provider * introduced fallbacks for media and description
sulu · Aug 18, 2016 · 6c9938f · 6c9938f
1 parent 99c048e
commit 6c9938f
Show file tree

Hide file tree

Showing 14 changed files with 424 additions and 2 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -15,6 +15,7 @@ matrix:
     - php: 7.0
 
 before_install:
+  - phpenv config-add Tests/travis.php.ini
   - composer self-update
 
 install:
@@ -23,6 +24,8 @@ install:
   - ./Tests/app/console doctrine:database:create
   - ./Tests/app/console doctrine:schema:update --force
   - ./Tests/app/console sulu:document:initialize
+  - ./Tests/app/console ongr:es:index:create -m default
   - ./Tests/app/console ongr:es:index:create -m live
+
 script:
   - ./vendor/bin/phpunit
diff --git a/Controller/ArticleController.php b/Controller/ArticleController.php
@@ -89,7 +89,9 @@ public function cgetAction(Request $request)
             }
         }
 
-        $search->addQuery(new TermQuery('type', $request->get('type', 'default')));
+        if (null !== ($type = $request->get('type'))) {
+            $search->addQuery(new TermQuery('type', $type));
+        }
 
         $count = $repository->count($search);
 

diff --git a/Document/ArticleOngrDocument.php b/Document/ArticleOngrDocument.php
@@ -44,6 +44,13 @@ class ArticleOngrDocument
      */
     protected $title;
 
+    /**
+     * @var string
+     *
+     * @Property(type="string")
+     */
+    protected $routePath;
+
     /**
      * @var string
      *
@@ -107,6 +114,20 @@ class ArticleOngrDocument
      */
     protected $authors;
 
+    /**
+     * @var string
+     *
+     * @Property(type="string")
+     */
+    protected $teaserDescription = '';
+
+    /**
+     * @var int
+     *
+     * @Property(type="integer")
+     */
+    protected $teaserMediaId;
+
     /**
      * @param string $uuid
      */
@@ -187,6 +208,26 @@ public function setTitle($title)
         return $this;
     }
 
+    /**
+     * Returns route-path.
+     *
+     * @return string
+     */
+    public function getRoutePath()
+    {
+        return $this->routePath;
+    }
+
+    /**
+     * Set route-path.
+     *
+     * @param string $routePath
+     */
+    public function setRoutePath($routePath)
+    {
+        $this->routePath = $routePath;
+    }
+
     /**
      * Returns type.
      *
@@ -402,4 +443,50 @@ public function setAuthors($authors)
 
         return $this;
     }
+
+    /**
+     * Returns teaser-description.
+     *
+     * @return string
+     */
+    public function getTeaserDescription()
+    {
+        return $this->teaserDescription;
+    }
+
+    /**
+     * Set teaser-description.
+     *
+     * @param string $teaserDescription
+     *
+     * @return $this
+     */
+    public function setTeaserDescription($teaserDescription)
+    {
+        $this->teaserDescription = $teaserDescription;
+
+        return $this;
+    }
+
+    /**
+     * Returns teaser-media-id.
+     *
+     * @return int
+     */
+    public function getTeaserMediaId()
+    {
+        return $this->teaserMediaId;
+    }
+
+    /**
+     * Set teaser-media-id.
+     *
+     * @param int $teaserMediaId
+     *
+     * @return int
+     */
+    public function setTeaserMediaId($teaserMediaId)
+    {
+        $this->teaserMediaId = $teaserMediaId;
+    }
 }
diff --git a/Document/Index/ArticleIndexer.php b/Document/Index/ArticleIndexer.php
@@ -88,6 +88,7 @@ public function index(ArticleDocument $document)
         $structure = $this->structureManager->getStructure($document->getStructureType(), 'article');
 
         $article->setTitle($document->getTitle());
+        $article->setRoutePath($document->getRoutePath());
         $article->setChanged($document->getChanged());
         $article->setCreated($document->getCreated());
         $article->setAuthored($document->getAuthored());
@@ -99,6 +100,20 @@ public function index(ArticleDocument $document)
         $article->setExcerpt($this->createExcerptObject($extensions['excerpt']));
         $article->setSeo($this->createSeoObject($extensions['seo']));
 
+        if ($structure->hasTag('sulu.teaser.description')) {
+            $descriptionProperty = $structure->getPropertyByTagName('sulu.teaser.description');
+            $article->setTeaserDescription(
+                $document->getStructure()->getProperty($descriptionProperty->getName())->getValue()
+            );
+        }
+        if ($structure->hasTag('sulu.teaser.media')) {
+            $mediaProperty = $structure->getPropertyByTagName('sulu.teaser.media');
+            $mediaData = $document->getStructure()->getProperty($mediaProperty->getName())->getValue();
+            if (null !== $mediaData && array_key_exists('ids', $mediaData)) {
+                $article->setTeaserMediaId(reset($mediaData['ids']) ?: null);
+            }
+        }
+
         $this->manager->persist($article);
     }
 

diff --git a/Document/MediaCollectionOngrObject.php b/Document/MediaCollectionOngrObject.php
@@ -26,7 +26,7 @@ class MediaCollectionOngrObject
      *
      * @Property(type="integer")
      */
-    public $ids;
+    public $ids = [];
 
     /**
      * @var string

diff --git a/EventListener/ArticleOngrDocumentSerializeSubscriber.php b/EventListener/ArticleOngrDocumentSerializeSubscriber.php
@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) MASSIVE ART WebServices GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\ArticleBundle\EventListener;
+
+use JMS\Serializer\EventDispatcher\Events;
+use JMS\Serializer\EventDispatcher\EventSubscriberInterface;
+use JMS\Serializer\EventDispatcher\ObjectEvent;
+use Sulu\Bundle\ArticleBundle\Document\ArticleOngrDocument;
+
+/**
+ * Append type translation to serialized article-ongr document.
+ */
+class ArticleOngrDocumentSerializeSubscriber implements EventSubscriberInterface
+{
+    /**
+     * @var array
+     */
+    private $typeConfiguration;
+
+    /**
+     * @param array $typeConfiguration
+     */
+    public function __construct(array $typeConfiguration)
+    {
+        $this->typeConfiguration = $typeConfiguration;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            [
+                'event' => Events::POST_SERIALIZE,
+                'format' => 'json',
+                'method' => 'onPostSerialize',
+            ],
+        ];
+    }
+
+    /**
+     * Add translated type.
+     *
+     * @param ObjectEvent $event
+     */
+    public function onPostSerialize(ObjectEvent $event)
+    {
+        $article = $event->getObject();
+        $visitor = $event->getVisitor();
+        $context = $event->getContext();
+
+        if (!($article instanceof ArticleOngrDocument)) {
+            return;
+        }
+
+        $visitor->addData('typeTranslation', $context->accept($this->getTitle($article->getType())));
+    }
+
+    /**
+     * Returns title for given type.
+     *
+     * @param string $type
+     *
+     * @return string
+     */
+    private function getTitle($type)
+    {
+        if (!array_key_exists($type, $this->typeConfiguration)) {
+            return ucfirst($type);
+        }
+
+        return $this->typeConfiguration[$type]['translation_key'];
+    }
+}
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -91,5 +91,19 @@
 
             <tag name="sulu.smart_content.data_provider" alias="articles"/>
         </service>
+        <service id="sulu_article.teaser.provider" class="Sulu\Bundle\ArticleBundle\Teaser\ArticleTeaserProvider">
+            <argument type="service" id="es.manager.live"/>
+
+            <tag name="sulu.teaser.provider" alias="article"/>
+        </service>
+
+        <!-- serialization -->
+        <service id="sulu_article.serializer.event_subscriber"
+                 class="Sulu\Bundle\ArticleBundle\EventListener\ArticleOngrDocumentSerializeSubscriber">
+            <argument>%sulu_articles.types%</argument>
+
+            <tag name="jms_serializer.event_subscriber" />
+            <tag name="sulu.context" context="admin"/>
+        </service>
     </services>
 </container>
diff --git a/Resources/translations/sulu/backend.de.xlf b/Resources/translations/sulu/backend.de.xlf
@@ -34,6 +34,10 @@
                 <source>sulu_article.authors</source>
                 <target>Autoren</target>
             </trans-unit>
+            <trans-unit id="9" resname="sulu_article.teaser">
+                <source>sulu_article.teaser</source>
+                <target>Artikel</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>
diff --git a/Resources/translations/sulu/backend.en.xlf b/Resources/translations/sulu/backend.en.xlf
@@ -34,6 +34,10 @@
                 <source>sulu_article.authors</source>
                 <target>Authors</target>
             </trans-unit>
+            <trans-unit id="9" resname="sulu_article.teaser">
+                <source>sulu_article.teaser</source>
+                <target>Article</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>
diff --git a/Resources/translations/sulu/backend.fr.xlf b/Resources/translations/sulu/backend.fr.xlf
@@ -34,6 +34,10 @@
                 <source>sulu_article.authors</source>
                 <target>Auteur</target>
             </trans-unit>
+            <trans-unit id="9" resname="sulu_article.teaser">
+                <source>sulu_article.teaser</source>
+                <target>Article</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>