nystudio107 / craft-retour

src/helpers/MultiSite.php

<?php
/**
 * Retour plugin for Craft CMS
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\retour\helpers;

use Craft;
use yii\web\ForbiddenHttpException;
use yii\web\NotFoundHttpException;
use function count;
use function in_array;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Retour

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     3.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class MultiSite
{
    // Constants
    // =========================================================================

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

    /**

Missing short description in doc comment

     * @param array $variables

Missing parameter comment

     */

Missing @return tag in function comment

    public static function setSitesMenuVariables(array &$variables): void
    {
        // Set defaults based on the section settings
        $variables['sitesMenu'] = [
            0 => Craft::t(
                'retour',
                'All Sites'
            ),
        ];
        // Enabled sites
        $sites = Craft::$app->getSites();
        if (Craft::$app->getIsMultiSite()) {
            $editableSites = $sites->getEditableSiteIds();
            foreach ($sites->getAllGroups() as $group) {
                $groupSites = $sites->getSitesByGroupId($group->id);
                $variables['sitesMenu'][$group->name]
                    = ['optgroup' => $group->name];
                foreach ($groupSites as $groupSite) {
                    if (in_array($groupSite->id, $editableSites, false)) {
                        $variables['sitesMenu'][$groupSite->id] = $groupSite->name;
                    }
                }
            }
        }
    }

    /**

Missing short description in doc comment

     * @param string $siteHandle

Missing parameter comment

     * @param        $siteId

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 1 spaces but found 8

     * @param        $variables

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 1 spaces but found 8

     *
     * @throws ForbiddenHttpException
     */

Missing @return tag in function comment

    public static function setMultiSiteVariables($siteHandle, &$siteId, array &$variables): void
    {
        // Enabled sites
        $sites = Craft::$app->getSites();
        if (Craft::$app->getIsMultiSite()) {
            // Set defaults based on the section settings
            $variables['enabledSiteIds'] = [];
            $variables['siteIds'] = [];

            foreach ($sites->getEditableSiteIds() as $editableSiteId) {
                $variables['enabledSiteIds'][] = $editableSiteId;
                $variables['siteIds'][] = $editableSiteId;
            }

            // Make sure the $siteId they are trying to edit is in our array of editable sites
            if (!in_array($siteId, $variables['enabledSiteIds'], false)) {
                if (!empty($variables['enabledSiteIds'])) {
                    if ($siteId !== 0) {
                        $siteId = reset($variables['enabledSiteIds']);
                    }
                } else {
                    self::requirePermission('editSite:' . $siteId);
                }
            }
        }
        // Set the currentSiteId and currentSiteHandle
        $variables['currentSiteId'] = empty($siteId) ? 0 : $siteId;
        $variables['currentSiteHandle'] = empty($siteHandle)
            ? Craft::$app->getSites()->currentSite->handle
            : $siteHandle;

        // Page title
        $variables['showSites'] = (
            Craft::$app->getIsMultiSite() &&
            count($variables['enabledSiteIds'])
        );

        if ($variables['showSites']) {
            if ($variables['currentSiteId'] === 0) {
                $variables['sitesMenuLabel'] = Craft::t(
                    'retour',
                    'All Sites'
                );
            } else {
                $variables['sitesMenuLabel'] = Craft::t(
                    'site',
                    $sites->getSiteById((int)$variables['currentSiteId'])->name
                );
            }
        } else {
            $variables['currentSiteId'] = 0;
            $variables['sitesMenuLabel'] = '';
        }
    }

    /**

Missing short description in doc comment

     * @param string $permissionName

Missing parameter comment

     *
     * @throws ForbiddenHttpException
     */

Missing @return tag in function comment

    public static function requirePermission(string $permissionName): void
    {
        if (!Craft::$app->getUser()->checkPermission($permissionName)) {
            throw new ForbiddenHttpException('User is not permitted to perform this action');
        }
    }

    /**
     * Return a siteId from a siteHandle
     *
     * @param ?string $siteHandle

Missing parameter comment

     *
     * @return int|null
     * @throws NotFoundHttpException
     */
    public static function getSiteIdFromHandle(?string $siteHandle): ?int
    {
        // Get the site to edit
        if ($siteHandle !== null) {
            $site = Craft::$app->getSites()->getSiteByHandle($siteHandle);
            if (!$site) {
                throw new NotFoundHttpException('Invalid site handle: ' . $siteHandle);
            }
            $siteId = $site->id;
        } else {
            $siteId = 0;
        }

        return $siteId;
    }

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