Arcanedev\LaravelSitemap\SitemapManager

Complexity

Total Complexity

20

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	create()	0	4	1
A	add()	0	6	1
A	all()	0	4	1
A	get()	0	4	1
A	has()	0	4	1
A	forget()	0	6	1
A	count()	0	4	1
B	render()	0	15	5
A	renderIndex()	0	4	1
A	save()	0	8	2
A	toArray()	0	4	1
A	toJson()	0	4	1
A	jsonSerialize()	0	4	1
A	renderView()	0	8	1

<?php namespace Arcanedev\LaravelSitemap;

use Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap as SitemapContract;
use Arcanedev\LaravelSitemap\Contracts\SitemapManager as SitemapManagerContract;
use Arcanedev\LaravelSitemap\Entities\Sitemap;
use DOMDocument;
use Illuminate\Support\Collection;

/**
 * Class     SitemapManager
 *
 * @package  Arcanedev\LaravelSitemap
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class SitemapManager implements SitemapManagerContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  \Illuminate\Support\Collection */
    protected $sitemaps;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * SitemapManager constructor.
     */
    public function __construct()
    {
        $this->sitemaps = new Collection;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create and add a sitemap to the collection.
     *
     * @param  string    $name
     * @param  callable  $callback
     *
     * @return self
     */
    public function create($name, callable $callback)
    {
        return $this->add($name, tap((new Sitemap)->setPath($name), $callback));
    }

    /**
     * Add a sitemap to the collection.
     *
     * @param  string                                                $name
     * @param  \Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap  $sitemap
     *
     * @return self
     */
    public function add($name, SitemapContract $sitemap)
    {
        $this->sitemaps->put($name, $sitemap);

        return $this;
    }

    /**
     * Get the sitemaps collection.
     *
     * @return \Illuminate\Support\Collection
     */
    public function all()
    {
        return $this->sitemaps;
    }

    /**
     * Get a sitemap instance.
     *
     * @param  string      $name
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    public function get($name, $default = null)
    {
        return $this->sitemaps->get($name, $default);
    }

    /**
     * Check if a sitemap exists.
     *
     * @param  string  $name
     *
     * @return bool
     */
    public function has($name)
    {
        return $this->sitemaps->has($name);
    }

    /**
     * Remove a sitemap from the collection by key.
     *
     * @param  string|array  $names
     *
     * @return self
     */
    public function forget($names)
    {
        $this->sitemaps->forget($names);

        return $this;
    }

    /**
     * Get the sitemaps count.
     *
     * @return int
     */
    public function count()
    {
        return $this->sitemaps->count();
    }

    /**
     * Render the sitemaps.
     *
     * @param  string  $name
     *
     * @return string|null
     */
    public function render($name = null)
    {
        if ($this->sitemaps->isEmpty())
            return null;

        if (is_null($name)) {
            return $this->count() === 1
                ? $this->renderView('sitemap::sitemap.xml', ['sitemap' => $this->sitemaps->first()])
                : $this->renderIndex();
        }
        elseif ($this->has($name))
            return $this->renderView('sitemap::sitemap.xml', ['sitemap' => $this->get($name)]);

        return null;
    }

    /**
     * Render the sitemap index.
     *
     * @return string
     */
    public function renderIndex()
    {
        return $this->renderView('sitemap::sitemap-index.xml', ['sitemaps' => $this->sitemaps]);
    }

    /**
     * Save the sitemaps.
     *
     * @param  string       $path
     * @param  string|null  $name
     *
     * @return self
     */
    public function save($path, $name = null)
    {
        if ($this->sitemaps->isNotEmpty()) {
            file_put_contents($path, $this->render($name));
        }

        return $this;

The return type of return $this; (Arcanedev\LaravelSitemap\SitemapManager) is incompatible with the return type declared by the interface Arcanedev\LaravelSitemap\Contracts\SitemapManager::save of type boolean.

    }

    /**
     * Get the collection of items as a plain array.
     *
     * @return array
     */
    public function toArray()
    {
        return $this->all()->toArray();
    }

    /**
     * Get the collection of sitemaps as JSON.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->jsonSerialize(), $options);
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Render the view.
     *
     * @param  string  $view
     * @param  array   $data
     *
     * @return string
     */
    public function renderView($view, array $data)
    {
        return tap(new DOMDocument('1.0'), function (DOMDocument $document) use ($view, $data) {
            $document->preserveWhiteSpace = false;
            $document->formatOutput = true;
            $document->loadXML(view($view, $data)->render());
        })->saveXML();
    }
}