Merge pull request #11 from m4olivei/10-caption-descriptor

Issue #10 add support for caption descriptor.

Author: minnur

autoload.php

@@ -61,6 +61,7 @@ function autoload679875ef60343fd604aa0fa4d353e67e($class) {
             'chapterthree\\applenewsapi\\document\\components\\title' => '/src/Document/Components/Title.php',
             'chapterthree\\applenewsapi\\document\\components\\tweet' => '/src/Document/Components/Tweet.php',
             'chapterthree\\applenewsapi\\document\\components\\video' => '/src/Document/Components/Video.php',
+            'chapterthree\\applenewsapi\\document\\captiondescriptor' => '/src/Document/CaptionDescriptor.php',
             'chapterthree\\applenewsapi\\document\\contentinset' => '/src/Document/ContentInset.php',
             'chapterthree\\applenewsapi\\document\\galleryitem' => '/src/Document/GalleryItem.php',
             'chapterthree\\applenewsapi\\document\\layouts\\advertisinglayout' => '/src/Document/Layouts/AdvertisingLayout.php',

src/Document/CaptionDescriptor.php

@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * @file
+ * Caption Descriptor referenced property.
+ */
+namespace ChapterThree\AppleNewsAPI\Document;
+
+use ChapterThree\AppleNewsAPI\Document\Components\Text;
+
+/**
+ * An Apple News Document Caption Descriptor. Used with Galleries to support
+ * HTML.
+ */
+class CaptionDescriptor extends Text {
+
+  protected $additions;
+
+  /**
+   * CaptionDescriptor constructor.
+   *
+   * @param string $text
+   *   Contains the raw caption text that needs to be displayed.
+   */
+  public function __construct($text) {
+    $this->setText($text);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function optional() {
+    return array_merge(parent::optional(), array(
+      // Note that CaptionDescriptor from Text components in that it is a
+      // referenced property, not a component. Thus we mark role as optional.
+      'role',
+      'additions',
+    ));
+  }
+
+  /**
+   * @return mixed
+   */
+  public function getAdditions() {
+    return $this->additions;
+  }
+
+  /**
+   * @param mixed $additions
+   */
+  public function setAdditions($additions) {
+    $this->additions = $additions;
+  }
+}

src/Document/Components/ScalableImage.php

@@ -7,6 +7,8 @@
 
 namespace ChapterThree\AppleNewsAPI\Document\Components;
 
+use ChapterThree\AppleNewsAPI\Document\CaptionDescriptor;
+
 /**
  * An Apple News Document ScalableImage.
  */
@@ -74,13 +76,24 @@ public function getCaption() {
   /**
    * Setter for caption.
    *
-   * @param string $value
+   * @param string|CaptionDescriptor $value
    *   Caption.
    *
    * @return $this
    */
   public function setCaption($value) {
-    $this->caption = (string) $value;
+    $class = CaptionDescriptor::class;
+    if (is_object($value)) {
+      if ($value instanceof $class) {
+        $this->caption = $value;
+      }
+      else {
+        $this->triggerError("Caption not of class ${class}.");
+      }
+    }
+    else {
+      $this->caption = (string) $value;
+    }
     return $this;
   }
 

src/Document/GalleryItem.php

@@ -69,13 +69,24 @@ public function getCaption() {
   /**
    * Setter for caption.
    *
-   * @param string $value
+   * @param string|CaptionDescriptor $value
    *   Caption.
    *
    * @return $this
    */
   public function setCaption($value) {
-    $this->caption = (string) $value;
+    $class = CaptionDescriptor::class;
+    if (is_object($value)) {
+      if ($value instanceof $class) {
+        $this->caption = $value;
+      }
+      else {
+        $this->triggerError("Caption not of class ${class}.");
+      }
+    }
+    else {
+      $this->caption = (string) $value;
+    }
     return $this;
   }