Thepixeldeveloper\Sitemap\Subelements\Image

Complexity

Total Complexity

14

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	4
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	generateXML()	0	12	1
A	getLoc()	0	4	1
A	optionalWriteElement()	0	6	2
A	getCaption()	0	4	1
A	setCaption()	0	6	1
A	getGeoLocation()	0	4	1
A	setGeoLocation()	0	6	1
A	getTitle()	0	4	1
A	setTitle()	0	6	1
A	getLicense()	0	4	1
A	setLicense()	0	6	1
A	appendAttributeToCollectionXML()	0	4	1

<?php

namespace Thepixeldeveloper\Sitemap\Subelements;

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

/**
 * Class Image
 *
 * @package Thepixeldeveloper\Sitemap\Subelements
 */
class Image implements OutputInterface, AppendAttributeInterface
{
    /**
     * Location (URL).
     *
     * @var string
     */
    protected $loc;

    /**
     * The caption of the image.
     *
     * @var string
     */
    protected $caption;

    /**
     * The geographic location of the image.
     *
     * @var string
     */
    protected $geoLocation;

    /**
     * The title of the image.
     *
     * @var string
     */
    protected $title;

    /**
     * A URL to the license of the image.
     *
     * @var string
     */
    protected $license;

    /**
     * Image constructor
     *
     * @param string $loc
     */
    public function __construct($loc)
    {
        $this->loc = $loc;
    }

    /**
     * {@inheritdoc}
     */
    public function generateXML(XMLWriter $XMLWriter)
    {
        $XMLWriter->startElement('image:image');
        $XMLWriter->writeElement('image:loc', $this->getLoc());

        $this->optionalWriteElement($XMLWriter, 'image:caption', $this->getCaption());
        $this->optionalWriteElement($XMLWriter, 'image:geo_location', $this->getGeoLocation());
        $this->optionalWriteElement($XMLWriter, 'image:title', $this->getTitle());
        $this->optionalWriteElement($XMLWriter, 'image:license', $this->getLicense());

        $XMLWriter->endElement();
    }

    /**
     * Location (URL).
     *
     * @return string
     */
    public function getLoc()
    {
        return $this->loc;
    }

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

    /**
     * The caption of the image.
     *
     * @return string
     */
    public function getCaption()
    {
        return $this->caption;
    }

    /**
     * Set the caption of the image.
     *
     * @param string $caption
     *
     * @return $this
     */
    public function setCaption($caption)
    {
        $this->caption = $caption;

        return $this;
    }

    /**
     * The geographic location of the image.
     *
     * @return string
     */
    public function getGeoLocation()
    {
        return $this->geoLocation;
    }

    /**
     * Set the geographic location of the image.
     *
     * @param string $geoLocation
     *
     * @return $this
     */
    public function setGeoLocation($geoLocation)
    {
        $this->geoLocation = $geoLocation;

        return $this;
    }

    /**
     * The title of the image.
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Set the title of the image.
     *
     * @param string $title
     *
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * A URL to the license of the image.
     *
     * @return string
     */
    public function getLicense()
    {
        return $this->license;
    }

    /**
     * Set a URL to the license of the image.
     *
     * @param string $license
     *
     * @return $this
     */
    public function setLicense($license)
    {
        $this->license = $license;

        return $this;
    }

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