JDecool\JsonFeed\Item

Complexity

Total Complexity

37

Size/Duplication

Total Lines	442
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getId()	0	4	1
A	getUrl()	0	4	1
A	setUrl()	0	6	1
A	getExternalUrl()	0	4	1
A	setExternalUrl()	0	6	1
A	getTitle()	0	4	1
A	setTitle()	0	6	1
A	getContentHtml()	0	4	1
A	setContentHtml()	0	6	1
A	getContentText()	0	4	1
A	setContentText()	0	6	1
A	getSummary()	0	4	1
A	setSummary()	0	6	1
A	getImage()	0	4	1
A	setImage()	0	6	1
A	getBannerImage()	0	4	1
A	setBannerImage()	0	6	1
A	getDatePublished()	0	4	1
A	setDatePublished()	0	6	1
A	getDateModified()	0	4	1
A	setDateModified()	0	6	1
A	getAuthor()	0	4	1
A	setAuthor()	0	6	1
A	getTags()	0	4	1
A	addTag()	0	8	2
A	setTags()	0	6	1
A	getAttachments()	0	4	1
A	addAttachment()	0	8	2
A	setAttachments()	0	6	1
A	addExtension()	0	10	2
A	getExtensions()	0	4	1
A	getExtension()	0	8	2

<?php

namespace JDecool\JsonFeed;

use DateTime;
use InvalidArgumentException;

class Item
{
    /** @var string */
    private $id;

    /** @var string */
    private $url;

    /** @var string */
    private $externalUrl;

    /** @var string */
    private $title;

    /** @var string */
    private $contentHtml;

    /** @var string */
    private $contentText;

    /** @var string */
    private $summary;

    /** @var string */
    private $image;

    /** @var string */
    private $bannerImage;

    /** @var DateTime */
    private $datePublished;

    /** @var DateTime */
    private $dateModified;

    /** @var Author */
    private $author;

    /** @var string[] */
    private $tags;

    /** @var Attachment[] */
    private $attachments;

    /** @var array */
    private $extensions;

    /**
     * Constructor
     *
     * @param string $id
     */
    public function __construct($id)
    {
        $this->id = $id;

        $this->tags = [];
        $this->attachments = [];
        $this->extensions = [];
    }

    /**
     * Get unique identifer for that item for that feed over time
     *
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Get the URL of the resource described by the item
     *
     * @return string
     */
    public function getUrl()
    {
        return $this->url;
    }

    /**
     * Set the URL of the resource described by the item
     *
     * @param string $url
     * @return Item
     */
    public function setUrl($url)
    {
        $this->url = $url;

        return $this;
    }

    /**
     * Get the URL of a page elsewhere
     *
     * @return string
     */
    public function getExternalUrl()
    {
        return $this->externalUrl;
    }

    /**
     * Set the URL of a page elsewhere
     *
     * @param string $externalUrl
     * @return Item
     */
    public function setExternalUrl($externalUrl)
    {
        $this->externalUrl = $externalUrl;

        return $this;
    }

    /**
     * Get plaintext title
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Set plaintext title
     *
     * @param string $title
     * @return Item
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * Get the HTML content for the item
     *
     * @return string
     */
    public function getContentHtml()
    {
        return $this->contentHtml;
    }

    /**
     * Set the HTML content for the item
     *
     * @param string $contentHtml
     * @return Item
     */
    public function setContentHtml($contentHtml)
    {
        $this->contentHtml = $contentHtml;

        return $this;
    }

    /**
     * Get plain text content for the item
     *
     * @return string
     */
    public function getContentText()
    {
        return $this->contentText;
    }

    /**
     * Set plain text content for the item
     *
     * @param string $contentText
     * @return Item
     */
    public function setContentText($contentText)
    {
        $this->contentText = $contentText;

        return $this;
    }

    /**
     * Get a plain text sentence or two describing the item
     *
     * @return string
     */
    public function getSummary()
    {
        return $this->summary;
    }

    /**
     * Set a plain text sentence or two describing the item
     *
     * @param string $summary
     * @return Item
     */
    public function setSummary($summary)
    {
        $this->summary = $summary;

        return $this;
    }

    /**
     * Get the URL of the main image for the item
     *
     * @return string
     */
    public function getImage()
    {
        return $this->image;
    }

    /**
     * Set the URL of the main image for the item
     *
     * @param string $image
     * @return Item
     */
    public function setImage($image)
    {
        $this->image = $image;

        return $this;
    }

    /**
     * Get the URL of an image to use as a banner
     *
     * @return string
     */
    public function getBannerImage()
    {
        return $this->bannerImage;
    }

    /**
     * Set the URL of an image to use as a banner
     *
     * @param string $bannerImage
     * @return Item
     */
    public function setBannerImage($bannerImage)
    {
        $this->bannerImage = $bannerImage;

        return $this;
    }

    /**
     * Get the item published date
     *
     * @return DateTime
     */
    public function getDatePublished()
    {
        return $this->datePublished;
    }

    /**
     * Set the item published date
     *
     * @param DateTime $datePublished
     * @return Item
     */
    public function setDatePublished(DateTime $datePublished)
    {
        $this->datePublished = $datePublished;

        return $this;
    }

    /**
     * Get the item modified date
     *
     * @return DateTime
     */
    public function getDateModified()
    {
        return $this->dateModified;
    }

    /**
     * Set the item modified date
     *
     * @param DateTime $dateModified
     * @return Item
     */
    public function setDateModified(DateTime $dateModified)
    {
        $this->dateModified = $dateModified;

        return $this;
    }

    /**
     * Get item author
     *
     * @return Author
     */
    public function getAuthor()
    {
        return $this->author;
    }

    /**
     * Set item author
     *
     * @param Author $author
     * @return Item
     */
    public function setAuthor(Author $author)
    {
        $this->author = $author;

        return $this;
    }

    /**
     * Get item tags
     *
     * @return string[]
     */
    public function getTags()
    {
        return $this->tags;
    }

    /**
     * Add item tag
     * @param string $tag
     * @return Item
     */
    public function addTag($tag)
    {
        if (!in_array($tag, $this->tags, true)) {
            $this->tags[] = $tag;
        }

        return $this;
    }

    /**
     * Set item tags
     *
     * @param string[] $tags
     * @return Item
     */
    public function setTags(array $tags)
    {
        $this->tags = $tags;

        return $this;
    }

    /**
     * Get item attachments
     *
     * @return Attachment[]
     */
    public function getAttachments()
    {
        return $this->attachments;
    }

    /**
     * Add item attachment
     *
     * @param Attachment $attachment
     * @return Item
     */
    public function addAttachment(Attachment $attachment)
    {
        if (!in_array($attachment, $this->attachments, true)) {
            $this->attachments[] = $attachment;
        }

        return $this;
    }

    /**
     * Set item attachments
     *
     * @param Attachment[] $attachments
     * @return Item
     */
    public function setAttachments(array $attachments)
    {
        $this->attachments = $attachments;

        return $this;
    }

    /**
     * Add an extension to the item
     *
     * @param string $key
     * @param array $value
     * @return Item
     */
    public function addExtension($key, array $value)
    {
        if (!is_string($key)) {
            throw new InvalidArgumentException('Extension key must be a string');
        }

        $this->extensions[$key] = $value;

        return $this;
    }

    /**
     * Get all extensions
     *
     * @return array
     */
    public function getExtensions()
    {
        return $this->extensions;
    }

    /**
     * Get an extension
     *
     * @param string $key
     * @return array|null
     */
    public function getExtension($key)
    {
        if (!isset($this->extensions[$key])) {
            return null;
        }

        return $this->extensions[$key];
    }
}