nystudio107 / craft-routemap

src/controllers/RoutesController.php

<?php
/**
 * Route Map plugin for Craft CMS
 *
 * Returns a list of public routes for elements with URLs
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 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\routemap\controllers;

use craft\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\web\Controller;
use nystudio107\routemap\RouteMap;
use yii\web\Response;

/**

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   RouteMap

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

 * @since     1.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 RoutesController extends Controller
{
    // Protected Properties
    // =========================================================================

    protected array|bool|int $allowAnonymous = [
        'get-all-urls',
        'get-section-urls',
        'get-all-route-rules',
        'get-section-route-rules',
        'get-url-asset-urls',
        'get-element-urls',
    ];

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

Parameter $criteria should have a doc-comment as per coding-style.

Parameter $siteId should have a doc-comment as per coding-style.

     * Return the public URLs for all elements that have URLs
     */

Missing @return tag in function comment

    public function actionGetAllUrls(array $criteria = [], ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getAllUrls($criteria, $siteId));
    }

    /**

Parameter $section should have a doc-comment as per coding-style.

Parameter $criteria should have a doc-comment as per coding-style.

Parameter $siteId should have a doc-comment as per coding-style.

     * Return the public URLs for a section
     */

Missing @return tag in function comment

    public function actionGetSectionUrls(string $section, array $criteria = [], ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getSectionUrls($section, $criteria, $siteId));
    }

    /**

Parameter $category should have a doc-comment as per coding-style.

Parameter $criteria should have a doc-comment as per coding-style.

Parameter $siteId should have a doc-comment as per coding-style.

     * Return the public URLs for a category
     */

Missing @return tag in function comment

    public function actionGetCategoryUrls(string $category, array $criteria = [], ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getCategoryUrls($category, $criteria, $siteId));
    }

    /**
     * Return all the section route rules
     *
     * @param string $format 'Craft'|'React'|'Vue'

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

     * @param ?int $siteId

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

     * @return Response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function actionGetAllRouteRules(string $format = 'Craft', ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getAllRouteRules($format, $siteId));
    }

    /**
     * Return the route rules for a specific section
     *
     * @param string $section

Missing parameter comment

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

     * @param string $format 'Craft'|'React'|'Vue'

Expected 2 spaces after parameter name; 1 found

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

     * @param ?int $siteId

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

     * @return Response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function actionGetSectionRouteRules(string $section, string $format = 'Craft', ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getSectionRouteRules($section, $format, $siteId));
    }

    /**
     * Return the route rules for a specific category
     *
     * @param string $category

Missing parameter comment

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

     * @param string $format 'Craft'|'React'|'Vue'

Expected 3 spaces after parameter name; 1 found

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

     * @param ?int $siteId

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

     * @return Response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function actionGetCategoryRouteRules(string $category, string $format = 'Craft', ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getCategoryRouteRules($category, $format, $siteId));
    }

    /**
     * Return the Craft Control Panel and `routes.php` rules
     *
     * @param ?int $siteId

Missing parameter comment

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

     * @param bool $includeGlobal

Missing parameter comment

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

     * @return Response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function actionGetRouteRules(?int $siteId = null, bool $includeGlobal = true): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getRouteRules($siteId, $includeGlobal));
    }

    /**
     * Get all the assets of the type $assetTypes that are used in the Entry
     * that matches the $url
     *
     * @param string $url

Missing parameter comment

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

     * @param array $assetTypes

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @param ?int $siteId

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

     * @return Response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function actionGetUrlAssetUrls(string $url, array $assetTypes = ['image'], ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getUrlAssetUrls($url, $assetTypes, $siteId));
    }

    /**
     * Returns all of the URLs for the given $elementType based on the passed in
     * $criteria and $siteId
     *
     * @param string|ElementInterface $elementType

Missing parameter comment

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

     * @param array $criteria

Missing parameter comment

Expected 19 spaces after parameter type; 1 found

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

     * @param ?int $siteId

Missing parameter comment

Expected 20 spaces after parameter type; 1 found

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

     * @return Response

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function actionGetElementUrls(string|ElementInterface $elementType, array $criteria = [], ?int $siteId = null): Response
    {
        return $this->asJson(RouteMap::$plugin->routes->getElementUrls($elementType, $criteria, $siteId));
    }
}