nystudio107\seomatic\console\controllers\SitemapController

Complexity

Total Complexity

14

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	options()	0	5	1
C	actionGenerate()	0	62	13

<?php
/**
 * SEOmatic plugin for Craft CMS
 *
 * @link      https://nystudio107.com/
 * @copyright Copyright (c) 2017 nystudio107
 * @license   https://nystudio107.com/license
 */

namespace nystudio107\seomatic\console\controllers;

use Craft;
use craft\helpers\App;
use nystudio107\seomatic\models\MetaBundle;
use nystudio107\seomatic\models\SitemapTemplate;
use nystudio107\seomatic\Seomatic;
use yii\console\Controller;

/**
 * SEOmatic Sitemap command
 *
 * @author    nystudio107
 * @package   Seomatic
 * @since     3.0.0
 */
class SitemapController extends Controller
{
    // Public Properties
    // =========================================================================

    /**
     * @var null|string The handle of the section to generate a sitemap for
     */
    public $handle;

    /**
     * @var null|int The siteId to generate a sitemap for
     */
    public $siteId;

    // Protected Properties
    // =========================================================================

    /**
     * @var    bool|array
     */
    protected array|bool|int $allowAnonymous = [
    ];

    // Public Methods
    // =========================================================================

    /**
     * @param string $actionID
     *
     * @return array|string[]
     */
    public function options($actionID): array
    {
        return [
            'handle',
            'siteId',
        ];
    }

    /**
     * Generate a sitemap. You can pass in a --handle and/or a --siteId
     */
    public function actionGenerate()
    {
        echo 'Generating sitemap' . PHP_EOL;
        if ($this->siteId !== null) {
            $siteIds[] = $this->siteId;

$siteIds was never initialized. Although not strictly required by PHP, it is generally a good practice to add $siteIds = array(); before regardless.

        } else {
            $siteIds = Craft::$app->getSites()->getAllSiteIds();
            if (!\is_array($siteIds)) {
                $siteIds = [$siteIds];
            }
        }
        // This might take a while
        App::maxPowerCaptain();
        // Process the sitemap generation
        foreach ($siteIds as $siteId) {
            $metaBundles = Seomatic::$plugin->metaBundles->getContentMetaBundlesForSiteId($siteId);
            Seomatic::$plugin->metaBundles->pruneVestigialMetaBundles($metaBundles);

            /** @var MetaBundle $metaBundle */
            foreach ($metaBundles as $metaBundle) {
                $process = false;
                if ($this->handle === null || $this->handle === $metaBundle->sourceHandle) {
                    $process = true;
                }
                if ($metaBundle->metaSitemapVars->sitemapUrls && $process) {
                    echo 'Generating sitemap for '
                        . $metaBundle->sourceType
                        . ' '
                        . $metaBundle->sourceName
                        . ', siteId '
                        . $siteId
                        . PHP_EOL;

                    $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($metaBundle->sourceBundleType);
                    $elementQuery = $seoElement::sitemapElementsQuery($metaBundle);
                    $pageSize = (int) $metaBundle->metaSitemapVars->sitemapPageSize;
                    $sitemapLimit = (int) $metaBundle->metaSitemapVars->sitemapLimit;

                    if (!empty($pageSize)) {
                        $total = empty($sitemapLimit) ? $elementQuery->count() : min($elementQuery->count(), $sitemapLimit);
                        $pageCount = ceil($total / $pageSize);
                    } else {
                        $pageCount = 1;
                    }

                    $site = Craft::$app->getSites()->getSiteById($metaBundle->sourceSiteId);
                    $sitemap = SitemapTemplate::create();
                    if ($site) {
                        for ($pageNum = 1; $pageNum <= $pageCount; $pageNum++) {
                            echo sprintf('Generating page %d of %d' . PHP_EOL, $pageNum, $pageCount);
                            $sitemap->render([
                                'groupId' => $site->groupId,
                                'siteId' => $metaBundle->sourceSiteId,
                                'handle' => $metaBundle->sourceHandle,
                                'type' => $metaBundle->sourceBundleType,
                                'page' => $pageNum,
                            ]);
                        }
                        // Generate the sitemap so it is in the cache
                    }

                    echo '---' . PHP_EOL;
                }
            }
        }
    }

    // Protected Methods
    // =========================================================================
}