Arcanedev\LaravelSitemap\SitemapBuilder

Complexity

Total Complexity

18

Size/Duplication

Total Lines	160
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	make()	0	4	1
B	build()	0	20	6
A	renderSitemap()	0	15	4
A	renderSitemapIndex()	0	4	1
A	render()	0	16	4
A	renderXml()	0	10	1
A	renderView()	0	4	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelSitemap;

use Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap;
use DOMDocument;
use Illuminate\Support\{Collection, Str};

/**
 * Class     SitemapBuilder
 *
 * @package  Arcanedev\LaravelSitemap
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class SitemapBuilder
{
    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create the builder instance.
     *
     * @return \Arcanedev\LaravelSitemap\SitemapBuilder
     */
    public static function make()
    {
        return new static;
    }

    /**
     * Build the sitemap.
     *
     * @param  string|null                     $name
     * @param  \Illuminate\Support\Collection  $sitemaps
     * @param  string                          $format
     *
     * @throws \Throwable
     *
     * @return string|null
     */
    public function build(?string $name, Collection $sitemaps, string $format): ?string
    {
        if ($sitemaps->isEmpty())
            return null;

        if (is_null($name)) {
            return $sitemaps->count() > 1
                ? static::renderSitemapIndex($format, $sitemaps)
                : static::renderSitemap($format, $sitemaps->first());
        }

        list($name, $key) = Str::contains($name, '.')
            ? explode('.', $name, 2)
            : [$name, null];

        if ($sitemaps->has($name))
            return static::renderSitemap($format, $sitemaps->get($name), $key);

        return null;
    }

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

    /**
     * Build a single sitemap item.
     *
     * @param  string                                                     $format
     * @param  \Arcanedev\LaravelSitemap\Contracts\Entities\Sitemap|null  $sitemap
     * @param  string|null                                                $key
     *
     * @throws \Throwable
     *
     * @return string|null
     */
    protected function renderSitemap(string $format, Sitemap $sitemap = null, string $key = null)
    {
        if (is_null($sitemap))
            return null;

        if ( ! $sitemap->isExceeded())
            return static::render($format, 'sitemap', ['sitemap' => $sitemap]);

        $chunks = $sitemap->chunk();

        if (is_null($key))
            return static::renderSitemapIndex($format, $chunks);

        return static::renderSitemap($format, $chunks->get($key));
    }

    /**
     * Render sitemap index.
     *
     * @param  string                          $format
     * @param  \Illuminate\Support\Collection  $sitemaps
     *
     * @throws \Throwable
     *
     * @return string|null
     */
    protected function renderSitemapIndex(string $format, Collection $sitemaps): ?string
    {
        return static::render($format, 'sitemap-index', compact('sitemaps'));
    }

    /**
     * Render the file.
     *
     * @param  string  $format
     * @param  string  $type
     * @param  array   $data
     *
     * @throws \Throwable
     *
     * @return string|null
     */
    protected function render(string $format, string $type, array $data): ?string
    {
        $format = strtolower(trim($format));

        switch ($format) {
            case 'xml':
            case 'rss':
                return static::renderXml($format, $type, $data);

            case 'txt':
                return static::renderView($type, $format, $data);

            default:
                return null;
        }
    }

    /**
     * Render the xml file.
     *
     * @param  string  $format
     * @param  string  $type
     * @param  array   $data
     *
     * @return string
     */
    protected function renderXml(string $format, string $type, array $data): string
    {
        return tap(new DOMDocument('1.0'), function (DOMDocument $document) use ($format, $type, $data) {
            $document->preserveWhiteSpace = false;
            $document->formatOutput = true;
            $document->loadXML(
                static::renderView($type, $format, $data)
            );
        })->saveXML();
    }

    /**
     * Render with illuminate.
     *
     * @param  string  $type
     * @param  string  $format
     * @param  array   $data
     *
     * @throws \Throwable
     *
     * @return string
     */
    protected function renderView(string $type, string $format, array $data): string
    {
        return view("sitemap::{$type}.{$format}", $data)->render();

The method render does only exist in Illuminate\View\View, but not in Illuminate\Contracts\View\Factory.

    }
}