Thepixeldeveloper\Sitemap\Subelements\Video

Complexity

Total Complexity

43

Size/Duplication

Total Lines	656
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	6
Bugs	0	Features	1

41 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getPlayerLoc()	0	4	1
A	setPlayerLoc()	0	6	1
B	generateXML()	0	32	2
A	getThumbnailLoc()	0	4	1
A	getTitle()	0	4	1
A	getDescription()	0	4	1
A	optionalWriteElement()	0	6	2
A	getContentLoc()	0	4	1
A	setContentLoc()	0	6	1
A	getDuration()	0	4	1
A	setDuration()	0	6	1
A	getExpirationDate()	0	4	1
A	setExpirationDate()	0	6	1
A	getRating()	0	4	1
A	setRating()	0	6	1
A	getViewCount()	0	4	1
A	setViewCount()	0	6	1
A	getPublicationDate()	0	4	1
A	setPublicationDate()	0	6	1
A	getFamilyFriendly()	0	4	1
A	setFamilyFriendly()	0	6	1
A	getTags()	0	4	1
A	setTags()	0	6	1
A	getCategory()	0	4	1
A	setCategory()	0	6	1
A	getRestriction()	0	4	1
A	setRestriction()	0	6	1
A	getGalleryLoc()	0	4	1
A	setGalleryLoc()	0	6	1
A	getPrice()	0	4	1
A	setPrice()	0	6	1
A	getRequiresSubscription()	0	4	1
A	setRequiresSubscription()	0	6	1
A	getUploader()	0	4	1
A	setUploader()	0	6	1
A	getPlatform()	0	4	1
A	setPlatform()	0	6	1
A	getLive()	0	4	1
A	setLive()	0	6	1
A	appendAttributeToCollectionXML()	0	4	1

<?php

namespace Thepixeldeveloper\Sitemap\Subelements;

use XMLWriter;
use Thepixeldeveloper\Sitemap\OutputInterface;
use Thepixeldeveloper\Sitemap\AppendAttributeInterface;

/**
 * Class Video
 *
 * @package Thepixeldeveloper\Sitemap\Subelements
 */
class Video implements OutputInterface, AppendAttributeInterface
{
    /**
     * URL pointing to an image thumbnail.
     *
     * @var string
     */
    protected $thumbnailLoc;

    /**
     * Title of the video, max 100 characters.
     *
     * @var string
     */
    protected $title;

    /**
     * Description of the video, max 2048 characters.
     *
     * @var string
     */
    protected $description;

    /**
     * URL pointing to the actual media file (mp4).
     *
     * @var string
     */
    protected $contentLoc;

    /**
     * URL pointing to the player file (normally a SWF).
     *
     * @var string
     */
    protected $playerLoc;

    /**
     * Indicates whether the video is live.
     *
     * @var boolean
     */
    protected $live;

    /**
     * Duration of the video in seconds.
     *
     * @var integer
     */
    protected $duration;

    /**
     * String of space delimited platform values.
     *
     * Allowed values are web, mobile, and tv.
     *
     * @var string
     */
    protected $platform;

    /**
     * Does the video require a subscription?
     *
     * @var boolean
     */
    protected $requiresSubscription;

    /**
     * The price to download or view the video in ISO 4217 format.
     *
     * @link http://en.wikipedia.org/wiki/ISO_4217
     *
     * @var string
     */
    protected $price;

    /**
     * Link to gallery of which this video appears in.
     *
     * @var string
     */
    protected $galleryLoc;

    /**
     * A space-delimited list of countries where the video may or may not be played.
     *
     * @var string
     */
    protected $restriction;

    /**
     * A tag associated with the video.
     *
     * @var array
     */
    protected $tags = [];

    /**
     * The video's category. For example, cooking.
     *
     * @var string
     */
    protected $category;

    /**
     * No if the video should be available only to users with SafeSearch turned off.
     *
     * @var string
     */
    protected $familyFriendly;

    /**
     * The date the video was first published, in W3C format.
     *
     * @var string
     */
    protected $publicationDate;

    /**
     * The number of times the video has been viewed.
     *
     * @var integer
     */
    protected $viewCount;

    /**
     * The video uploader's name. Only one <video:uploader> is allowed per video.
     *
     * @var string
     */
    protected $uploader;

    /**
     * The rating of the video. Allowed values are float numbers in the range 0.0 to 5.0.
     *
     * @var float
     */
    protected $rating;

    /**
     * The date after which the video will no longer be available, in W3C format.
     *
     * @var string
     */
    protected $expirationDate;

    /**
     * Video constructor.
     *
     * @param string $thumbnailLoc
     * @param string $title
     * @param string $description
     */
    public function __construct($thumbnailLoc, $title, $description)
    {
        $this->thumbnailLoc = $thumbnailLoc;
        $this->title        = $title;
        $this->description  = $description;
    }

    /**
     * URL pointing to the player file (normally a SWF).
     *
     * @return string
     */
    public function getPlayerLoc()
    {
        return $this->playerLoc;
    }

    /**
     * URL pointing to the player file (normally a SWF).
     *
     * @param string $playerLoc
     *
     * @return $this
     */
    public function setPlayerLoc($playerLoc)
    {
        $this->playerLoc = $playerLoc;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function generateXML(XMLWriter $XMLWriter)
    {
        $XMLWriter->startElement('video:video');

        $XMLWriter->writeElement('video:thumbnail_loc', $this->getThumbnailLoc());
        $XMLWriter->writeElement('video:title', $this->getTitle());
        $XMLWriter->writeElement('video:description', $this->getDescription());

        $this->optionalWriteElement($XMLWriter, 'video:content_loc', $this->getContentLoc());
        $this->optionalWriteElement($XMLWriter, 'video:player_loc', $this->getPlayerLoc());
        $this->optionalWriteElement($XMLWriter, 'video:duration', $this->getDuration());
        $this->optionalWriteElement($XMLWriter, 'video:expiration_date', $this->getExpirationDate());
        $this->optionalWriteElement($XMLWriter, 'video:rating', $this->getRating());
        $this->optionalWriteElement($XMLWriter, 'video:view_count', $this->getViewCount());
        $this->optionalWriteElement($XMLWriter, 'video:publication_date', $this->getPublicationDate());
        $this->optionalWriteElement($XMLWriter, 'video:family_friendly', $this->getFamilyFriendly());

        foreach ($this->getTags() as $tag) {
            $this->optionalWriteElement($XMLWriter, 'video:tag', $tag);
        }

        $this->optionalWriteElement($XMLWriter, 'video:category', $this->getCategory());
        $this->optionalWriteElement($XMLWriter, 'video:restriction', $this->getRestriction());
        $this->optionalWriteElement($XMLWriter, 'video:gallery_loc', $this->getGalleryLoc());
        $this->optionalWriteElement($XMLWriter, 'video:price', $this->getPrice());
        $this->optionalWriteElement($XMLWriter, 'video:requires_subscription', $this->getRequiresSubscription());
        $this->optionalWriteElement($XMLWriter, 'video:uploader', $this->getUploader());
        $this->optionalWriteElement($XMLWriter, 'video:platform', $this->getPlatform());
        $this->optionalWriteElement($XMLWriter, 'video:live', $this->getLive());

        $XMLWriter->endElement();
    }

    /**
     * URL pointing to an image thumbnail.
     *
     * @return string
     */
    public function getThumbnailLoc()
    {
        return $this->thumbnailLoc;
    }

    /**
     * Title of the video, max 100 characters.
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Description of the video, max 2048 characters.
     *
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * {@inheritdoc}
     */
    protected function optionalWriteElement(XMLWriter $XMLWriter, $name, $value)
    {
        if ($value) {
            $XMLWriter->writeElement($name, $value);
        }
    }

    /**
     * URL pointing to the actual media file (mp4).
     *
     * @return string
     */
    public function getContentLoc()
    {
        return $this->contentLoc;
    }

    /**
     * URL pointing to the actual media file (mp4).
     *
     * @param string $contentLoc
     *
     * @return $this
     */
    public function setContentLoc($contentLoc)
    {
        $this->contentLoc = $contentLoc;

        return $this;
    }

    /**
     * Duration of the video in seconds.
     *
     * @return integer
     */
    public function getDuration()
    {
        return $this->duration;
    }

    /**
     * Duration of the video in seconds.
     *
     * @param integer $duration
     *
     * @return $this
     */
    public function setDuration($duration)
    {
        $this->duration = $duration;

        return $this;
    }

    /**
     * The date after which the video will no longer be available, in W3C format.
     *
     * @return string
     */
    public function getExpirationDate()
    {
        return $this->expirationDate;
    }

    /**
     * The date after which the video will no longer be available, in W3C format.
     *
     * @param string $expirationDate
     *
     * @return $this
     */
    public function setExpirationDate($expirationDate)
    {
        $this->expirationDate = $expirationDate;

        return $this;
    }

    /**
     * The rating of the video. Allowed values are float numbers in the range 0.0 to 5.0.
     *
     * @return float
     */
    public function getRating()
    {
        return $this->rating;
    }

    /**
     * The rating of the video. Allowed values are float numbers in the range 0.0 to 5.0.
     *
     * @param float $rating
     *
     * @return $this
     */
    public function setRating($rating)
    {
        $this->rating = $rating;

        return $this;
    }

    /**
     * The number of times the video has been viewed.
     *
     * @return integer
     */
    public function getViewCount()
    {
        return $this->viewCount;
    }

    /**
     * The number of times the video has been viewed.
     *
     * @param integer $viewCount
     *
     * @return $this
     */
    public function setViewCount($viewCount)
    {
        $this->viewCount = $viewCount;

        return $this;
    }

    /**
     * The date the video was first published, in W3C format.
     *
     * @return string
     */
    public function getPublicationDate()
    {
        return $this->publicationDate;
    }

    /**
     * The date the video was first published, in W3C format.
     *
     * @param string $publicationDate
     *
     * @return $this
     */
    public function setPublicationDate($publicationDate)
    {
        $this->publicationDate = $publicationDate;

        return $this;
    }

    /**
     * No if the video should be available only to users with SafeSearch turned off.
     *
     * @return string
     */
    public function getFamilyFriendly()
    {
        return $this->familyFriendly;
    }

    /**
     * No if the video should be available only to users with SafeSearch turned off.
     *
     * @param string $familyFriendly
     *
     * @return $this
     */
    public function setFamilyFriendly($familyFriendly)
    {
        $this->familyFriendly = $familyFriendly;

        return $this;
    }

    /**
     * A tag associated with the video.
     *
     * @return array
     */
    public function getTags()
    {
        return $this->tags;
    }

    /**
     * A tag associated with the video.
     *
     * @param array $tags
     *
     * @return $this
     */
    public function setTags($tags)
    {
        $this->tags = $tags;

        return $this;
    }

    /**
     * The video's category. For example, cooking.
     *
     * @return string
     */
    public function getCategory()
    {
        return $this->category;
    }

    /**
     * The video's category. For example, cooking.
     *
     * @param string $category
     *
     * @return $this
     */
    public function setCategory($category)
    {
        $this->category = $category;

        return $this;
    }

    /**
     * A space-delimited list of countries where the video may or may not be played.
     *
     * @return string
     */
    public function getRestriction()
    {
        return $this->restriction;
    }

    /**
     * A space-delimited list of countries where the video may or may not be played.
     *
     * @param string $restriction
     *
     * @return $this
     */
    public function setRestriction($restriction)
    {
        $this->restriction = $restriction;

        return $this;
    }

    /**
     * Link to gallery of which this video appears in.
     *
     * @return string
     */
    public function getGalleryLoc()
    {
        return $this->galleryLoc;
    }

    /**
     * Link to gallery of which this video appears in.
     *
     * @param string $galleryLoc
     *
     * @return $this
     */
    public function setGalleryLoc($galleryLoc)
    {
        $this->galleryLoc = $galleryLoc;

        return $this;
    }

    /**
     * The price to download or view the video in ISO 4217 format.
     *
     * @return string
     */
    public function getPrice()
    {
        return $this->price;
    }

    /**
     * The price to download or view the video in ISO 4217 format.
     *
     * @param string $price
     *
     * @return $this
     */
    public function setPrice($price)
    {
        $this->price = $price;

        return $this;
    }

    /**
     * Does the video require a subscription?
     *
     * @return boolean
     */
    public function getRequiresSubscription()
    {
        return $this->requiresSubscription;
    }

    /**
     * Does the video require a subscription?
     *
     * @param boolean $requiresSubscription
     *
     * @return $this
     */
    public function setRequiresSubscription($requiresSubscription)
    {
        $this->requiresSubscription = $requiresSubscription;

        return $this;
    }

    /**
     * The video uploader's name. Only one <video:uploader> is allowed per video.
     *
     * @return string
     */
    public function getUploader()
    {
        return $this->uploader;
    }

    /**
     * The video uploader's name. Only one <video:uploader> is allowed per video.
     *
     * @param string $uploader
     *
     * @return $this
     */
    public function setUploader($uploader)
    {
        $this->uploader = $uploader;

        return $this;
    }

    /**
     * String of space delimited platform values.
     *
     * Allowed values are web, mobile, and tv.
     *
     * @return string
     */
    public function getPlatform()
    {
        return $this->platform;
    }

    /**
     * String of space delimited platform values.
     *
     * Allowed values are web, mobile, and tv.
     *
     * @param string $platform
     *
     * @return $this
     */
    public function setPlatform($platform)
    {
        $this->platform = $platform;

        return $this;
    }

    /**
     * Indicates whether the video is live.
     *
     * @return boolean
     */
    public function getLive()
    {
        return $this->live;
    }

    /**
     * Indicates whether the video is live.
     *
     * @param boolean $live
     *
     * @return $this
     */
    public function setLive($live)
    {
        $this->live = $live;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function appendAttributeToCollectionXML(XMLWriter $XMLWriter)
    {
        $XMLWriter->writeAttribute('xmlns:video', 'http://www.google.com/schemas/sitemap-video/1.1');
    }
}