FRUIT\GoogleServices\Domain\Model\Node

Complexity

Total Complexity

24

Size/Duplication

Total Lines	280
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getLoc()	0	4	1
A	getLastmod()	0	4	1
A	getChangefreq()	0	7	2
A	getPriority()	0	7	2
A	getGeo()	0	4	1
A	getImages()	0	4	1
A	addImage()	0	4	1
A	getVideo()	0	4	1
A	getNews()	0	4	1
A	setLoc()	0	7	2
A	setLastmod()	0	7	1
A	setChangefreq()	0	17	2
A	setPriority()	0	13	4
A	setGeo()	0	4	1
A	setImages()	0	4	1
A	setVideo()	0	4	1
A	setNews()	0	4	1

<?php

/**
 * Sitemap node
 */

namespace FRUIT\GoogleServices\Domain\Model;

use FRUIT\GoogleServices\Domain\Model\Node\GeoNode;
use FRUIT\GoogleServices\Domain\Model\Node\ImageNode;
use FRUIT\GoogleServices\Domain\Model\Node\NewsNode;
use FRUIT\GoogleServices\Domain\Model\Node\VideoNode;

/**
 * Sitemap Node
 */
class Node extends AbstractModel
{

    /**
     * Constants for usage in setChangefreq()
     */
    const CHANGE_FREQ_AWLAYS = 'always';
    const CHANGE_FREQ_HOURLY = 'hourly';
    const CHANGE_FREQ_DAILY = 'daily';
    const CHANGE_FREQ_WEEKLY = 'weekly';
    const CHNAGE_FREQ_MONTHLY = 'monthly';
    const CHANGE_FREQ_YEARLY = 'yearly';
    const CHANGE_FREQ_NEVER = 'never';

    /**
     * Location
     *
     * @var string
     */
    protected $loc;

    /**
     * Last modifcation
     *
     * @var string
     */
    protected $lastmod;

    /**
     * Change frequency
     *
     * @var string
     */
    protected $changefreq;

    /**
     * Priority
     *
     * @var float
     */
    protected $priority;

    /**
     * Geo
     *
     * @var GeoNode
     */
    protected $geo;

    /**
     * Images
     *
     * @var array
     */
    protected $images = [];

    /**
     * Video
     *
     * @var VideoNode
     */
    protected $video;

    /**
     * News
     *
     * @var NewsNode
     */
    protected $news;

    /**
     * Get location
     *
     * @return string
     */
    public function getLoc()
    {
        return $this->loc;
    }

    /**
     * Get last modification
     *
     * @return string
     */
    public function getLastmod()
    {
        return $this->lastmod;
    }

    /**
     * Get change frequency
     *
     * @return string
     */
    public function getChangefreq()
    {
        if (!strlen($this->changefreq)) {
            return false;
        }
        return $this->changefreq;
    }

    /**
     * Get priotiy
     *
     * @return float
     */
    public function getPriority()
    {
        if ($this->priority === null) {
            return -1;
        }
        return $this->priority;
    }

    /**
     * Get geo
     *
     * @return GeoNode
     */
    public function getGeo()
    {
        return $this->geo;
    }

    /**
     * Get images
     *
     * @return array
     */
    public function getImages()
    {
        return $this->images;
    }

    /**
     * Add image
     *
     * @param ImageNode $image
     */
    public function addImage(ImageNode $image)
    {
        $this->images[] = $image;
    }

    /**
     * get Video
     *
     * @return VideoNode
     */
    public function getVideo()
    {
        return $this->video;
    }

    /**
     * Get news
     *
     * @return NewsNode
     */
    public function getNews()
    {
        return $this->news;
    }

    /**
     * Set location
     *
     * @param string $loc
     *
     * @throws \Exception
     */
    public function setLoc($loc)
    {
        if (!filter_var($loc, FILTER_VALIDATE_URL)) {
            throw new \Exception('The location of a google sitemap has have to be a valid URL');
        }
        $this->loc = $loc;
    }

    /**
     * Set last modifiction date
     *
     * @param string $lastmod
     */
    public function setLastmod($lastmod)
    {

        // timestamp or parsable date

        $this->lastmod = $lastmod;
    }

    /**
     * Set change frequency
     *
     * @param string $changefreq One of the Node::CHANGE_FREQ_* constants.
     *
     * @throws \Exception
     */
    public function setChangefreq($changefreq)
    {
        $possibleValues = [
            self::CHANGE_FREQ_AWLAYS,
            self::CHANGE_FREQ_HOURLY,
            self::CHANGE_FREQ_DAILY,
            self::CHANGE_FREQ_WEEKLY,
            self::CHNAGE_FREQ_MONTHLY,
            self::CHANGE_FREQ_YEARLY,
            self::CHANGE_FREQ_NEVER,
        ];

        if (!in_array(trim($changefreq), $possibleValues)) {
            throw new \Exception('The value of the changefreq have to be one of theses values: ' . implode(',', $possibleValues));
        }
        $this->changefreq = $changefreq;
    }

    /**
     * Set priority
     *
     * @param float $priority
     *
     * @throws \Exception
     */
    public function setPriority($priority)
    {
        if (!is_float($priority)) {
            throw new \Exception('Parameter $priority has to be a float value');
        }
        if ($priority < 0) {
            $this->setPriority(0.0);
        }
        if ($priority > 1) {
            $this->setPriority(1.0);
        }
        $this->priority = $priority;
    }

    /**
     * Set geo
     *
     * @param GeoNode $geo
     */
    public function setGeo(GeoNode $geo)
    {
        $this->geo = $geo;
    }

    /**
     * Set images
     *
     * @param array $images
     */
    public function setImages(array $images)
    {
        $this->images = $images;
    }

    /**
     * Set video
     *
     * @param VideoNode $video
     */
    public function setVideo(VideoNode $video)
    {
        $this->video = $video;
    }

    /**
     * Set news
     *
     * @param NewsNode $news
     */
    public function setNews(NewsNode $news)
    {
        $this->news = $news;
    }
}