Sitemap::setEndIndex() - Code Metrics - Inspection of "fixes_0060" - ozo2003/HelperBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 91a3e8...7ce289 )

by Dāvis
created 2018-02-21 11:05 UTC
Sitemap::setEndIndex() A

↳ Parent: Sitemap
Complexity

Conditions	2
Paths	2
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	2
nc	2
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0
<?php

namespace Sludio\HelperBundle\Sitemap;

use Sludio\HelperBundle\Sitemap\Dumper\DumperFileInterface;
use Sludio\HelperBundle\Sitemap\Dumper\DumperInterface;
use Sludio\HelperBundle\Sitemap\Entity\Image;
use Sludio\HelperBundle\Sitemap\Entity\SitemapIndex;
use Sludio\HelperBundle\Sitemap\Entity\Url;
use Sludio\HelperBundle\Sitemap\Entity\Video;
use Sludio\HelperBundle\Sitemap\Formatter\FormatterInterface;
use Sludio\HelperBundle\Sitemap\Formatter\SitemapIndexFormatterInterface;
use Sludio\HelperBundle\Sitemap\Provider\ProviderInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Sludio\HelperBundle\Script\Utils\Helper;

class Sitemap
{
    protected $providers = [];
    protected $dumper;
    protected $formatter;
    protected $baseHost;
    protected $limit = 0;
    protected $sitemapIndexes = [];
    protected $originalFilename;

    public function __construct(DumperInterface $dumper, FormatterInterface $formatter, $baseHost = null, $limit = 0, RequestStack $requestStack)
    {
        $this->dumper = $dumper;
        $this->formatter = $formatter;
        $this->baseHost = $baseHost;
        if ($this->baseHost === null && PHP_SAPI !== 'cli') {
            $request = $requestStack->getCurrentRequest();
            $this->baseHost = (Helper::useHttps($request) ? 'https' : 'http').'://'.$request->server->get('HTTP_HOST');
        }
        $this->limit = $limit;
        if ($this->isSitemapIndexable()) {
            if ($dumper instanceof DumperFileInterface) {
                $this->originalFilename = $dumper->getFilename();
            }
        }
    }

    protected function isSitemapIndexable()
    {
        return ($this->limit > 0 && $this->dumper instanceof DumperFileInterface && $this->formatter instanceof SitemapIndexFormatterInterface);
    }

    public function addProvider(ProviderInterface $provider)
    {
        $this->providers[] = $provider;

        return $this;
    }

    public function setDumper(DumperInterface $dumper)
    {
        $this->dumper = $dumper;

        return $this;
    }

    public function build()
    {
        if ($this->isSitemapIndexable()) {
            $this->addSitemapIndex($this->createSitemapIndex());
        }

        $this->dumper->dump($this->formatter->getSitemapStart());

        foreach ($this->providers as $provider) {
            $provider->populate($this);
        }

        $sitemapContent = $this->dumper->dump($this->formatter->getSitemapEnd());

        if (!$this->isSitemapIndexable()) {
            return $sitemapContent;
        }

        if (\count($this->sitemapIndexes)) {
            $this->dumper->setFilename($this->originalFilename);

            $this->dumper->dump($this->formatter->getSitemapIndexStart());
            foreach ($this->sitemapIndexes as $sitemapIndex) {
                $this->dumper->dump($this->formatter->formatSitemapIndex($sitemapIndex));
            }

            $this->dumper->dump($this->formatter->getSitemapIndexEnd());
        }

        return null;
    }

    protected function addSitemapIndex(SitemapIndex $sitemapIndex)
    {
        $nbSitemapIndexs = \count($this->sitemapIndexes);

        if ($nbSitemapIndexs > 0) {
            $this->dumper->dump($this->formatter->getSitemapEnd());
        }
        $sitemapIndexFilename = $this->getSitemapIndexFilename($this->originalFilename);
        $this->dumper->setFilename($sitemapIndexFilename);
                       setFilename($sitemapIndexFilename);

        $this->sitemapIndexes[] = $sitemapIndex;
        if ($nbSitemapIndexs > 0) {
            $this->dumper->dump($this->formatter->getSitemapStart());
        }
    }

    protected function getSitemapIndexFilename($filename)
    {
        $sitemapIndexFilename = basename($filename);
        $index = \count($this->sitemapIndexes) + 1;
        $extPosition = strrpos($sitemapIndexFilename, '.');
        if ($extPosition !== false) {

            $sitemapIndexFilename = substr($sitemapIndexFilename, 0, $extPosition).'-'.$index.substr($sitemapIndexFilename, $extPosition);
        } else {
            $sitemapIndexFilename .= '-'.$index;
        }

        $sitemapIndexFilename = \dirname($filename).DIRECTORY_SEPARATOR.$sitemapIndexFilename;

        return $sitemapIndexFilename;
    }

    protected function createSitemapIndex()
    {
        $sitemapIndex = new SitemapIndex();
        $sitemapIndex->setLastmod(new \DateTime());

        return $sitemapIndex;
    }

    private function addIndex()
    {
        if ($this->isSitemapIndexable() && $this->getCurrentSitemapIndex()->getUrlCount() >= $this->limit) {
            $this->addSitemapIndex($this->createSitemapIndex());
        }
    }

    private function parseBaseHost(Url $url, $loc)
    {
        if ($this->baseHost !== null) {
            if ($this->needHost($loc)) {
                $url->setLoc($this->baseHost.$loc);
            }

            $this->parseVideo($url);
            $this->parseImage($url);
        }
    }

    private function setEndIndex()
    {
        if ($this->isSitemapIndexable()) {
            $this->getCurrentSitemapIndex()->incrementUrl();
        }
    }

    public function add(Url $url)
    {
        $this->addIndex();

        $loc = $url->getLoc();
        if (empty($loc)) {
            throw new \InvalidArgumentException('The url MUST have a loc attribute');
        }

        $this->parseBaseHost($url, $loc);
        $this->dumper->dump($this->formatter->formatUrl($url));
        $this->setEndIndex();

        return $this;
    }

    protected function parseVideo(Url $url)
    {
        foreach ($url->getVideos() as $video) {
            /** @var Video $video */
            if ($this->needHost($video->getThumbnailLoc())) {
                $video->setThumbnailLoc($this->baseHost.$video->getThumbnailLoc());
            }

            if ($this->needHost($video->getContentLoc())) {
                $video->setContentLoc($this->baseHost.$video->getContentLoc());
            }

            $player = $video->getPlayerLoc();
            if ($player !== null && $this->needHost($player['loc'])) {
                $video->setPlayerLoc($this->baseHost.$player['loc'], $player['allow_embed'], $player['autoplay']);
            }

            $gallery = $video->getGalleryLoc();
            if ($gallery !== null && $this->needHost($gallery['loc'])) {
                $video->setGalleryLoc($this->baseHost.$gallery['loc'], $gallery['title']);
            }
        }
    }

    protected function parseImage(Url $url)
    {
        foreach ($url->getImages() as $image) {
            /** @var Image $image */
            if ($this->needHost($image->getLoc())) {
                $image->setLoc($this->baseHost.$image->getLoc());
            }

            if ($this->needHost($image->getLicense())) {
                $image->setLicense($this->baseHost.$image->getLicense());
            }
        }
    }

    protected function getCurrentSitemapIndex()
    {
        return end($this->sitemapIndexes);
    }

    protected function needHost($url)
    {
        if ($url === null) {
            return false;
        }

        return 0 !== strpos($url, 'http');
    }
}

ozo2003 / HelperBundle

Push — master ( 91a3e8...7ce289 )

Sitemap::setEndIndex() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
