Video::addContentLoc() - Code Metrics - Inspection of "Code clean-ups" - wszetko/sitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 92b030...ab5bab )

by Paweł
created 2019-09-03 14:52 UTC
Video::addContentLoc() A

↳ Parent: Video
Complexity

Conditions	2
Paths	2
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	2
Importance

Changes
Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	8
ccs	4
cts	4
cp	1
crap	2
rs	10
c	0
b	0
f	0
<?php
declare(strict_types=1);

namespace Wszetko\Sitemap\Items;

use DateTimeInterface;
use InvalidArgumentException as InvalidArgumentException;
use Wszetko\Sitemap\Traits\DateTime;

/**
 * Class Video
 *
 * @todo    : add support for content_segment_loc tag
 * @package Wszetko\Sitemap\Items
 */
class Video extends Extension
{
    use DateTime;

    /**
     * Name of Namescapce
     */
    const NAMESPACE_NAME = 'video';

    /**
     * Namespace URL
     */
    const NAMESPACE_URL = 'http://www.google.com/schemas/sitemap-video/1.1';

    /**
     * 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 array
     */
    protected $contentLoc;

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

    /**
     * Indicates whether the video is live.
     *
     * @var string
     */
    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 array
     */
    protected $platform;

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

    /**
     * Information about price
     *
     * @var array
     */
    protected $price;

    /**
     * The currency used for the price.
     *
     * @var string
     */
    protected $currency;

    /**
     * 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 array
     */
    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.
     *
     * @var string|null
     */
    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|array
     */
    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
     *
     * @var string
     */
    protected $expirationDate;

    /**
     * Video constructor.
     *
     * @param string $thumbnailLoc
     * @param string $title
     * @param string $description
     *
     * @throws InvalidArgumentException
     */
    public function __construct($thumbnailLoc, $title, $description)
    {
        if (!\Wszetko\Sitemap\Helpers\Url::normalizeUrl('https://example.com' . $thumbnailLoc)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new InvalidArgumentException('Invalid thumbnail location parameter.');
        }

        $this->thumbnailLoc = '/' . ltrim($thumbnailLoc, '/');
        $this->title = mb_substr($title, 0, 100);
        $this->description = mb_substr($description, 0, 2048);
    }

    /**
     * The currency used for the price.
     *
     * @return string|null
     */
    public function getCurrency(): ?string
    {
        return $this->currency;
    }

    /**
     * The currency used for the price.
     *
     * @param string $currency
     *
     * @return self
     */
    public function setCurrency(string $currency): self
    {
        preg_match_all("/^(?'currency'[A-Z]{3})$/", $currency, $matches);

        if (!empty($matches['currency'])) {
            $this->currency = $matches['currency'][0];
        }

        return $this;
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        if (empty($this->getContentLoc()) && empty($this->getPlayerLoc())) {
            throw new InvalidArgumentException('Nor content_loc or player_loc parameter is set.');
        }

        $array = [
            '_namespace' => static::NAMESPACE_NAME,
            '_element' => 'video',
            'video' => [
                'thumbnail_loc' => $this->getThumbnailLoc(),
                'title' => $this->getTitle(),
                'description' => $this->getDescription()
            ]
        ];

        if (!empty($this->getContentLoc())) {
            foreach ($this->getContentLoc() as $contentLoc) {
                if ($contentLoc != $this->getDomain()) {
                    if (!isset($array['video']['content_loc'])) {
                        $array['video']['content_loc'] = [];
                    }
                    $array['video']['content_loc'][] = $contentLoc;
                }
            }
        }

        if (!empty($this->getPlayerLoc())) {
            foreach ($this->getPlayerLoc() as $playerLoc) {
                if ($playerLoc != $this->getDomain()) {
                    if (!isset($array['video']['player_loc'])) {
                        $array['video']['player_loc'] = [];
                    }
                    if (is_array($playerLoc)) {
                        $loc = array_key_first($playerLoc);
                        $array['video']['player_loc'][] = [
                            '_attributes' => ['allow_embed' => $playerLoc[$loc]],
                            '_value' => $loc
                        ];
                    } else {
                        $array['video']['player_loc'][] = $playerLoc;
                    }
                }
            }
        }

        if (!empty($this->getDuration())) {
            $array['video']['duration'] = $this->getDuration();
        }

        if (!empty($this->getExpirationDate())) {
            $array['video']['expiration_date'] = $this->getExpirationDate();
        }

        if (!empty($this->getRating())) {
            $array['video']['rating'] = $this->getRating();
        }

        if (!empty($this->getViewCount())) {
            $array['video']['view_count'] = $this->getViewCount();
        }

        if (!empty($this->getPublicationDate())) {
            $array['video']['publication_date'] = $this->getPublicationDate();
        }

        if (!empty($this->getFamilyFriendly())) {
            $array['video']['family_friendly'] = $this->getFamilyFriendly();
        }

        if (!empty($this->getRestriction())) {
            $restriction = $this->getRestriction();
            $relationship = array_key_first($this->getRestriction());
            $countries = $restriction[$relationship];

            $array['video']['restriction'] = [
                '_attributes' => ['relationship' => $relationship],
                '_value' => $countries
            ];
        }

        if (!empty($this->getPlatform())) {
            $platform = $this->getPlatform();
            $relationship = array_key_first($platform);
            $platform = $platform[$relationship];
            $array['video']['platform'] = [
                '_attributes' => ['relationship' => $relationship],
                '_value' => $platform
            ];
        }

        if (!empty($this->getPrice())) {
            $price = $this->getPrice();
            $array['video']['price'] = [
                '_attributes' => ['currency' => $price['currency']],
                '_value' => $price['price']
            ];

            if (isset($price['type'])) {
                $array['video']['price']['_attributes']['type'] = $price['type'];
            }

            if (isset($price['resolution'])) {
                $array['video']['price']['_attributes']['resolution'] = $price['resolution'];
            }
        }

        if (!empty($this->getRequiresSubscription())) {
            $array['video']['requires_subscription'] = $this->getRequiresSubscription();
        }

        if (!empty($this->getUploader())) {
            if (is_array($this->getUploader())) {
                $uploader = array_key_first($this->getUploader());
                $array['video']['uploader'] = [
                    '_attributes' => ['info' => $this->getUploader()[$uploader]],
                    '_value' => $uploader
                ];
            } else {
                $array['video']['uploader'] = $this->getUploader();
            }
        }

        if (!empty($this->getLive())) {
            $array['video']['live'] = $this->getLive();
        }

        if (!empty($this->getTags())) {
            $tags = $this->getTags();
            $array['video']['tag'] = [];

            foreach ($tags as $tag) {
                $array['video']['tag'][] = $tag;
            }
        }

        if (!empty($this->getCategory())) {
            $array['video']['category'] = $this->getCategory();
        }

        if (!empty($this->getGalleryLoc())) {
            $array['video']['gallery_loc'] = $this->getGalleryLoc();
        }

        return $array;
    }

    /**
     * URL pointing to the actual media file (mp4).
     *
     * @return array
     * @throws \InvalidArgumentException
     */
    public function getContentLoc(): ?array
    {
        if ($this->getDomain()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            if (!empty($this->contentLoc)) {
                $result = [];
                foreach ($this->contentLoc as $contentLoc) {
                    $result[] = \Wszetko\Sitemap\Helpers\Url::normalizeUrl($this->getDomain() . $contentLoc);
                }

                return $result;
            } else {
                return null;
            }
        } else {
            throw new InvalidArgumentException('Domain is not set.');
        }
    }

    /**
     * Player location information
     *
     * @return string|array
     * @throws \InvalidArgumentException
     */
    public function getPlayerLoc()
    {
        if ($this->getDomain()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            if (!empty($this->playerLoc)) {
                $result = [];
                foreach ($this->playerLoc as $playerLoc) {
                    if (is_string($playerLoc)) {
                        $result[] = \Wszetko\Sitemap\Helpers\Url::normalizeUrl($this->getDomain() . $playerLoc);
                    } elseif (is_array($playerLoc)) {
                        $result[] = [\Wszetko\Sitemap\Helpers\Url::normalizeUrl($this->getDomain() . array_key_first($playerLoc)) => array_values($playerLoc)[0]];
                    }
                }

                return $result;
            } else {
                return null;
            }
        } else {
            throw new InvalidArgumentException('Domain is not set.');
        }
    }

    /**
     * URL pointing to an image thumbnail.
     *
     * @return string
     */
    public function getThumbnailLoc(): string
    {
        return \Wszetko\Sitemap\Helpers\Url::normalizeUrl($this->getDomain() . $this->thumbnailLoc);
    }

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

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

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

    /**
     * Duration of the video in seconds.
     *
     * @param int $duration
     *
     * @return self
     * @todo: add support for adding time duration in different format (eg. ISO-8601)
     */
    public function setDuration($duration): self
    {
        if ($duration >= 0 && $duration <= 28800) {
            $this->duration = $duration;
        }

        return $this;
    }

    /**
     * The date after which the video will no longer be available.
     *
     * @return string|null
     */
    public function getExpirationDate(): ?string
    {
        return $this->expirationDate;
    }

    /**
     * The date after which the video will no longer be available.
     *
     * @param DateTimeInterface|string $expirationDate
     *
     * @return self
     */
    public function setExpirationDate($expirationDate): self
    {
        if ($dateTime = $this->processDateTime($expirationDate)) {
            $this->expirationDate = $dateTime;
        }

        return $this;
    }

    /**
     * The rating of the video. Allowed values are float numbers in the range 0.0 to 5.0.
     *
     * @return float|null
     */
    public function getRating(): ?float
    {
        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 self
     * @todo: support other formats like int, string
     */
    public function setRating(float $rating): self
    {
        if ($rating >= 0 && $rating <= 5) {
            $this->rating = round($rating, 1);
        }

        return $this;
    }

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

    /**
     * The number of times the video has been viewed.
     *
     * @param integer $viewCount
     *
     * @return self
     * @todo: support other format like string
     */
    public function setViewCount(int $viewCount): self
    {
        $this->viewCount = $viewCount;

        return $this;
    }

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

    /**
     * The date the video was first published, in W3C format.
     *
     * @param DateTimeInterface|string $publicationDate
     *
     * @return self
     */
    public function setPublicationDate($publicationDate): self
    {
        if ($dateTime = $this->processDateTime($publicationDate)) {
            $this->publicationDate = $dateTime;
        }

        return $this;
    }

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

    /**
     * No if the video should be available only to users with SafeSearch turned off.
     *
     * @todo: support other format like strings ('Yes', 'No, 'yes', 'no', 'y', 'n') or null
     *
     * @param bool $familyFriendly
     *
     * @return self
     */
    public function setFamilyFriendly(bool $familyFriendly): self
    {
        $this->familyFriendly = $familyFriendly ? 'Yes' : 'No';

        return $this;
    }

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

    /**
     * A space-delimited list of countries where the video may or may not be played.
     *
     * @param string $relationship
     * @param string $countries
     *
     * @return self
     */
    public function setRestriction(string $relationship, string $countries): self
    {
        preg_match_all("/^(?'countries'[A-Z]{2}( +[A-Z]{2})*)?$/", $countries, $matches);

        if ($this->validRelationship($relationship) && !empty($matches['countries'])) {
            $this->restriction = [$relationship => $countries];
        }

        return $this;
    }

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

    /**
     * String of space delimited platform values.
     * Allowed values are web, mobile, and tv.
     *
     * @param string $relationship
     * @param string $platform
     *
     * @return self
     */
    public function setPlatform(string $relationship, string $platform): self
    {
        preg_match_all("/^(?'platform'(web|mobile|tv)( (web|mobile|tv))*)?/", $platform, $matches);

        if ($this->validRelationship($relationship) && !empty($matches['platform'])) {
            $this->platform = [$relationship => $platform];
        }

        return $this;
    }

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

    /**
     * The price to download or view the video in ISO 4217 format.
     *
     * @param float  $price
     * @param string $currency
     * @param string $type
     * @param string $resolution
     *
     * @return self
     * @todo: support more formats for price (rg. int, string)
     * @todo: normalize output to one format
     */
    public function setPrice(float $price, string $currency, string $type = '', string $resolution = ''): self
    {
        preg_match_all("/^(?'currency'[A-Z]{3})$/", $currency, $matches);

        if (!empty($matches['currency'])) {
            $data = [];
            $data['price'] = round($price, 2);
            $data['currency'] = $currency;

            if (in_array($type, ['rent', 'RENT', 'purchase', 'PURCHASE'])) {
                $data['type'] = $type;
            }

            if (in_array($resolution, ['sd', 'hd', 'SD', 'HD'])) {
                $data['resolution'] = $resolution;
            }

            $this->price = $data;
        }

        return $this;
    }

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

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

        return $this;
    }

    /**
     * The video uploader's name. Only one <video:uploader> is allowed per video.
     *
     * @return string|array
     */
    public function getUploader()
    {
        if (is_array($this->uploader)) {
            return [array_key_first($this->uploader) => $this->getDomain() . $this->uploader[array_key_first($this->uploader)]];
        }

        return $this->uploader;
    }

    /**
     * The video uploader's name. Only one <video:uploader> is allowed per video.
     *
     * @param string $uploader
     * @param string $info
     *
     * @return self
     */
    public function setUploader(string $uploader, string $info = ''): self
    {
        if (!empty($info)) {
            $this->uploader = [$uploader => $info];
        } else {
            $this->uploader = $uploader;
        }

        return $this;
    }

    /**
     * Indicates whether the video is live.
     *
     * @return string|null
     */
    public function getLive(): ?string
    {
        return $this->live;
    }

    /**
     * Indicates whether the video is live.
     *
     * @param boolean $live
     *
     * @return self
     */
    public function setLive(bool $live): self
    {
        $this->live = $live ? 'Yes' : 'No';

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * @param string $value
     *
     * @return bool
     */
    private function validRelationship(string $value): bool
    {
        $accepted = ['allow', 'deny'];

        return (bool) in_array($value, $accepted);
    }

    /**
     * Link to gallery of which this video appears in.
     *
     * @param string $galleryLoc
     *
     * @return self
     */
    public function setGalleryLoc($galleryLoc): self
    {
        if (\Wszetko\Sitemap\Helpers\Url::normalizeUrl($galleryLoc)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->galleryLoc = $galleryLoc;
        }

        return $this;
    }

    /**
     * URL pointing to the actual media file (mp4).
     *
     * @param string $contentLoc
     *
     * @return self
     */
    public function addContentLoc(string $contentLoc): self
    {
        if (!empty($contentLoc)) {
            $this->contentLoc[] = '/' . ltrim($contentLoc, '/');
        }

        return $this;
    }

    /**
     * Add player location information
     *
     * @param string $playerLoc
     * @param mixed  $allowEmbed
     *
     * @return self
     * @todo: add support to autoplay attribute
     */
    public function addPlayerLoc(string $playerLoc, $allowEmbed = null): self
    {
        if (!empty($playerLoc)) {
            $playerLoc = '/' . ltrim($playerLoc, '/');

            if ($allowEmbed !== null) {
                $this->playerLoc[] = [$playerLoc => $allowEmbed];
            } else {
                $this->playerLoc[] = $playerLoc;
            }
        }

        return $this;
    }
}

wszetko / sitemap

Push — master ( 92b030...ab5bab )

Video::addContentLoc() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
