Merge pull request #8 from m4olivei/7-advertisingSettings

Issue #7 add support for advertisingSettings document property.

Author: minnur

autoload.php

@@ -7,6 +7,7 @@ function autoload679875ef60343fd604aa0fa4d353e67e($class) {
     if ($classes === null) {
         $classes = array(
             'chapterthree\\applenewsapi\\document' => '/src/Document.php',
+            'chapterthree\\applenewsapi\\document\\advertisingsettings' => '/src/Document/AdvertisingSettings.php',
             'chapterthree\\applenewsapi\\document\\anchor' => '/src/Document/Anchor.php',
             'chapterthree\\applenewsapi\\document\\animations\\componentanimations\\appearanimation' => '/src/Document/Animations/ComponentAnimations/AppearAnimation.php',
             'chapterthree\\applenewsapi\\document\\animations\\componentanimations\\componentanimation' => '/src/Document/Animations/ComponentAnimations/ComponentAnimation.php',
@@ -62,6 +63,7 @@ function autoload679875ef60343fd604aa0fa4d353e67e($class) {
             'chapterthree\\applenewsapi\\document\\components\\video' => '/src/Document/Components/Video.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',
             'chapterthree\\applenewsapi\\document\\layouts\\componentlayout' => '/src/Document/Layouts/ComponentLayout.php',
             'chapterthree\\applenewsapi\\document\\layouts\\layout' => '/src/Document/Layouts/Layout.php',
             'chapterthree\\applenewsapi\\document\\margin' => '/src/Document/Margin.php',

src/Document.php

@@ -7,6 +7,7 @@
 
 namespace ChapterThree\AppleNewsAPI;
 
+use ChapterThree\AppleNewsAPI\Document\AdvertisingSettings;
 use ChapterThree\AppleNewsAPI\Document\Base;
 use ChapterThree\AppleNewsAPI\Document\Components\Component;
 use ChapterThree\AppleNewsAPI\Document\Components\ComponentNested;
@@ -31,6 +32,7 @@ class Document extends Base {
   protected $components;
   protected $componentTextStyles;
 
+  protected $advertisingSettings;
   protected $subtitle;
   protected $metadata;
   protected $documentStyle;
@@ -65,6 +67,7 @@ public function __construct($identifier, $title, $language, Layout $layout) {
    */
   protected function optional() {
     return array_merge(parent::optional(), array(
+      'advertisingSettings',
       'subtitle',
       'metadata',
       'documentStyle',
@@ -227,6 +230,30 @@ public function addComponentTextStyle($name, ComponentTextStyle $component_text_
     return $this;
   }
 
+  /**
+   * Getter for advertisingSettings.
+   */
+  public function getAdvertisingSettings() {
+    return $this->advertisingSettings;
+  }
+
+  /**
+   * Setter for advertisingSettings.
+   *
+   * @param AdvertisingSettings $value
+   *
+   * @return $this
+   */
+  public function setAdvertisingSettings($value) {
+    if (is_object($value) && !$value instanceof AdvertisingSettings) {
+      $this->triggerError('Object not of type AdvertisingSettings');
+    }
+    else {
+      $this->advertisingSettings = $value;
+    }
+    return $this;
+  }
+
   /**
    * Getter for subtitle.
    */

src/Document/AdvertisingSettings.php

@@ -0,0 +1,112 @@
+<?php
+
+/**
+ * @file
+ * Apple News Document Advertising Settings.
+ */
+
+namespace ChapterThree\AppleNewsAPI\Document;
+use ChapterThree\AppleNewsAPI\Document\Layouts\AdvertisingLayout;
+
+/**
+ * Apple News Document Advertising Settings.
+ */
+class AdvertisingSettings extends Base {
+
+  protected $bannerType;
+  protected $frequency;
+  protected $layout;
+
+  const BANNER_TYPE_ANY = 'any';
+  const BANNER_TYPE_STANDARD = 'standard';
+  const BANNER_TYPE_DOUBLE = 'double_height';
+  const BANNER_TYPE_LARGE = 'large';
+
+  /**
+   * Define optional properties.
+   */
+  protected function optional() {
+    return array_merge(parent::optional(), array(
+      'bannerType',
+      'frequency',
+      'layout',
+    ));
+  }
+
+  /**
+   * Getter for bannerType.
+   */
+  public function getBannerType() {
+    return $this->bannerType;
+  }
+
+  /**
+   * Setting for bannerType.
+   *
+   * @param string $bannerType
+   *   The banner type that should be shown. One of 'any', 'standard',
+   *   'double_height', and 'large'.
+   *
+   * @return $this
+   */
+  public function setBannerType($bannerType) {
+    if (!in_array($bannerType, [
+        self::BANNER_TYPE_ANY,
+        self::BANNER_TYPE_DOUBLE,
+        self::BANNER_TYPE_LARGE,
+        self::BANNER_TYPE_STANDARD,
+      ])) {
+      $this->triggerError('Invalid value for bannerType advertisingSettings.');
+    }
+    else {
+      $this->bannerType = $bannerType;
+    }
+    return $this;
+  }
+
+  /**
+   * Getter for frequency.
+   */
+  public function getFrequency() {
+    return $this->frequency;
+  }
+
+  /**
+   * Setter for frequency.
+   *
+   * @param int $frequency
+   *   A number between 0 and 10 defining the frequency for automatically
+   *   inserting advertising components into articles.
+   *
+   * @return $this
+   */
+  public function setFrequency($frequency) {
+    if ($frequency >= 0 && $frequency <= 10) {
+      $this->frequency = $frequency;
+    }
+    else {
+      $this->triggerError('Invalid value for frequency advertisingSettings.');
+    }
+    return $this;
+  }
+
+  /**
+   * Getter for layout.
+   */
+  public function getLayout() {
+    return $this->layout;
+  }
+
+  /**
+   * Setter for layout.
+   *
+   * @param AdvertisingLayout $layout
+   *   Layout object that currently supports only margin.
+   *
+   * @return $this
+   */
+  public function setLayout(AdvertisingLayout $layout) {
+    $this->layout = $layout;
+    return $this;
+  }
+}

src/Document/Layouts/AdvertisingLayout.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * @file
+ * An Apple News Document Advertising Layout.
+ */
+
+namespace ChapterThree\AppleNewsAPI\Document\Layouts;
+
+use ChapterThree\AppleNewsAPI\Document\Base;
+use ChapterThree\AppleNewsAPI\Document\Margin;
+
+/**
+ * An Apple News Document Advertising Layout.
+ */
+class AdvertisingLayout extends Base {
+
+  protected $margin;
+
+  /**
+   * Getter for margin.
+   */
+  public function getMargin() {
+    return $this->margin;
+  }
+
+  /**
+   * Setter for margin.
+   *
+   * @param Margin $value
+   *   Margin.
+   *
+   * @return $this
+   */
+  public function setMargin($value) {
+    if (is_object($value) && !$value instanceof Margin) {
+      $this->triggerError('Object not of type Margin');
+    }
+    else {
+      $this->margin = $value;
+    }
+    return $this;
+  }
+}

tests/Document/AdvertisingSettingsTest.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * @file
+ * Tests for ChapterThree\AppleNewsAPI\Document\AdvertisingSettings.
+ */
+
+use ChapterThree\AppleNewsAPI\Document\AdvertisingSettings;
+use ChapterThree\AppleNewsAPI\Document\Layouts\AdvertisingLayout;
+use ChapterThree\AppleNewsAPI\Document\Margin;
+
+class AdvertisingSettingsTest extends PHPUnit_Framework_TestCase {
+
+  /**
+   * Setting properties and outputting JSON.
+   */
+  public function testSetters() {
+    $obj = new AdvertisingSettings();
+
+    $expected = '{}';
+    $this->assertEquals($expected, $obj->json());
+
+    $expected = '{"bannerType":"large","frequency":5,"layout":{"margin":{"top":10,"bottom":10}}}';
+    $obj->setBannerType('any');
+    $obj->setBannerType('double_height');
+    $obj->setBannerType('standard');
+    $obj->setBannerType('large');
+
+    $obj->setFrequency(0);
+    $obj->setFrequency(10);
+    $obj->setFrequency(5);
+
+    $ad_layout = new AdvertisingLayout();
+    $ad_layout->setMargin(new Margin(10, 10));
+    $obj->setLayout($ad_layout);
+    $this->assertEquals($expected, $obj->json());
+  }
+}

tests/Document/Layouts/AdvertisingLayoutTest.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @file
+ * Tests for ChapterThree\AppleNewsAPI\Document\Layouts\AdvertisingLayout
+ */
+
+use ChapterThree\AppleNewsAPI\Document\Layouts\AdvertisingLayout;
+use ChapterThree\AppleNewsAPI\Document\Margin;
+
+class AdvertisingLayoutTest extends PHPUnit_Framework_TestCase {
+
+  /**
+   * Settings properties and outputting JSON.
+   */
+  public function testSetters() {
+    $expected = '{"margin":{"top":10,"bottom":10}}';
+    $obj = new AdvertisingLayout();
+    $obj->setMargin(new Margin(10, 10));
+    $this->assertEquals($expected, $obj->json());
+  }
+}