Implement JsonSerializable

webeweb · Jan 24, 2020 · 313cea0 · 313cea0
1 parent dad5716
commit 313cea0
Show file tree

Hide file tree

Showing 75 changed files with 1,125 additions and 38 deletions.
diff --git a/src/Model/AbstractCredit.php b/src/Model/AbstractCredit.php
@@ -23,4 +23,13 @@
 abstract class AbstractCredit extends AbstractModel {
 
     use StringContentTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+        ];
+    }
 }
diff --git a/src/Model/AbstractModel.php b/src/Model/AbstractModel.php
@@ -15,19 +15,53 @@
 
 namespace WBW\Library\XMLTV\Model;
 
+use JsonSerializable;
+
 /**
- * Abstract node.
+ * Abstract model.
  *
  * @author webeweb <https://github.com/webeweb/>
  * @package WBW\Library\XMLTV\Model
  * @abstract
  */
-abstract class AbstractModel {
+abstract class AbstractModel implements JsonSerializable {
 
     /**
      * Constructor.
      */
     public function __construct() {
         // NOTHING TO DO.
     }
+
+    /**
+     * Serialize an array.
+     *
+     * @param AbstractModel[] $models The models.
+     * @return array Returns the serialized array.
+     */
+    public static function serializeArray(array $models) {
+
+        $output = [];
+
+        foreach ($models as $current) {
+            $output[] = static::serializeModel($current);
+        }
+
+        return $output;
+    }
+
+    /**
+     * Serialize a model.
+     *
+     * @param AbstractModel|null $model The model.
+     * @return array Returns the serialized model.
+     */
+    public static function serializeModel(AbstractModel $model = null) {
+
+        if (null === $model) {
+            return null;
+        }
+
+        return $model->jsonSerialize();
+    }
 }
diff --git a/src/Model/Actor.php b/src/Model/Actor.php
@@ -35,6 +35,17 @@ public function getRole() {
         return $this->role;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+
+        $output          = parent::jsonSerialize();
+        $output ["role"] = $this->getContent();
+
+        return $output;
+    }
+
     /**
      * Set the role.
      *

diff --git a/src/Model/Aspect.php b/src/Model/Aspect.php
@@ -22,4 +22,13 @@
 class Aspect extends AbstractModel {
 
     use StringContentTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+        ];
+    }
 }
diff --git a/src/Model/Audio.php b/src/Model/Audio.php
@@ -39,6 +39,16 @@ public function getStereo() {
         return $this->stereo;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "present" => $this->getPresent(),
+            "stereo"  => $this->getStereo(),
+        ];
+    }
+
     /**
      * Get the stereo.
      *

diff --git a/src/Model/Category.php b/src/Model/Category.php
@@ -24,4 +24,14 @@ class Category extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/Channel.php b/src/Model/Channel.php
@@ -57,6 +57,18 @@ public function getId() {
         return $this->id;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "displayNames" => static::serializeArray($this->getDisplayNames()),
+            "icons"        => static::serializeArray($this->getIcons()),
+            "id"           => $this->getId(),
+            "urls"         => static::serializeArray($this->getUrls()),
+        ];
+    }
+
     /**
      * Set the id.
      *

diff --git a/src/Model/Colour.php b/src/Model/Colour.php
@@ -22,4 +22,13 @@
 class Colour extends AbstractModel {
 
     use StringContentTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+        ];
+    }
 }
diff --git a/src/Model/Country.php b/src/Model/Country.php
@@ -24,4 +24,14 @@ class Country extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/Credits.php b/src/Model/Credits.php
@@ -57,4 +57,22 @@ public function __construct() {
         $this->setProducers([]);
         $this->setWriters([]);
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "actors"       => static::serializeArray($this->getActors()),
+            "adapters"     => static::serializeArray($this->getAdapters()),
+            "commentators" => static::serializeArray($this->getCommentators()),
+            "composers"    => static::serializeArray($this->getComposers()),
+            "directors"    => static::serializeArray($this->getDirectors()),
+            "editors"      => static::serializeArray($this->getEditors()),
+            "guests"       => static::serializeArray($this->getGuests()),
+            "presenters"   => static::serializeArray($this->getPresenters()),
+            "producers"    => static::serializeArray($this->getProducers()),
+            "writers"      => static::serializeArray($this->getWriters()),
+        ];
+    }
 }
diff --git a/src/Model/Date.php b/src/Model/Date.php
@@ -22,4 +22,13 @@
 class Date extends AbstractModel {
 
     use StringContentTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+        ];
+    }
 }
diff --git a/src/Model/Desc.php b/src/Model/Desc.php
@@ -24,4 +24,14 @@ class Desc extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/DisplayName.php b/src/Model/DisplayName.php
@@ -24,4 +24,14 @@ class DisplayName extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/EpisodeNum.php b/src/Model/EpisodeNum.php
@@ -50,4 +50,14 @@ public static function enumSystem() {
             self::SYSTEM_XMLTV_NS,
         ];
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "system"  => $this->getSystem(),
+        ];
+    }
 }
diff --git a/src/Model/Icon.php b/src/Model/Icon.php
@@ -41,6 +41,17 @@ public function getSrc() {
         return $this->src;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "height" => $this->getHeight(),
+            "src"    => $this->getSrc(),
+            "width"  => $this->getWidth(),
+        ];
+    }
+
     /**
      * Set the source.
      *

diff --git a/src/Model/Keyword.php b/src/Model/Keyword.php
@@ -24,4 +24,14 @@ class Keyword extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/Language.php b/src/Model/Language.php
@@ -24,4 +24,14 @@ class Language extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/LastChance.php b/src/Model/LastChance.php
@@ -24,4 +24,14 @@ class LastChance extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/Length.php b/src/Model/Length.php
@@ -74,6 +74,16 @@ public function getUnits() {
         return $this->units;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "units"   => $this->getUnits(),
+        ];
+    }
+
     /**
      * Set the units.
      *

diff --git a/src/Model/OrigLanguage.php b/src/Model/OrigLanguage.php
@@ -24,4 +24,14 @@ class OrigLanguage extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/Premiere.php b/src/Model/Premiere.php
@@ -24,4 +24,14 @@ class Premiere extends AbstractModel {
 
     use StringContentTrait;
     use StringLangTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+            "lang"    => $this->getLang(),
+        ];
+    }
 }
diff --git a/src/Model/Present.php b/src/Model/Present.php
@@ -22,4 +22,13 @@
 class Present extends AbstractModel {
 
     use StringContentTrait;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function jsonSerialize() {
+        return [
+            "content" => $this->getContent(),
+        ];
+    }
 }