nystudio107 / craft-routemap

src/services/Routes.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\services;

use Craft;
use craft\base\Component;
use craft\base\Element;
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\elements\Asset;

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

use craft\elements\Category;
use craft\elements\db\ElementQueryInterface;
use craft\elements\Entry;
use craft\fields\Assets as AssetsField;
use craft\fields\Matrix as MatrixField;
use nystudio107\routemap\helpers\Field as FieldHelper;
use yii\caching\TagDependency;
use function count;
use function in_array;
use function is_array;
use function is_int;
use function is_object;
use function is_string;

/**

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 Routes extends Component
{
    // Constants
    // =========================================================================
    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTE_FORMAT_CRAFT = 'Craft';

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTE_FORMAT_REACT = 'React';

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTE_FORMAT_VUE = 'Vue';

    /**

Missing short description in doc comment

     * @var null
     */
    public const ROUTEMAP_CACHE_DURATION = null;

    /**

Missing short description in doc comment

     * @var int
     */
    public const DEVMODE_ROUTEMAP_CACHE_DURATION = 30;

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTEMAP_CACHE_TAG = 'RouteMap';

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTEMAP_SECTION_RULES = 'Sections';

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTEMAP_CATEGORY_RULES = 'Categories';

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTEMAP_ELEMENT_URLS = 'ElementUrls';

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTEMAP_ASSET_URLS = 'AssetUrls';

    /**

Missing short description in doc comment

     * @var string
     */
    public const ROUTEMAP_ALL_URLS = 'AllUrls';

    // Public Methods
    // =========================================================================
    /**
     * Return the public URLs for all elements that have URLs
     *
     * @param array $criteria

Missing parameter comment

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

     * @param ?int $siteId

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @return array

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

     */
    public function getAllUrls(array $criteria = [], ?int $siteId = null): array
    {
        $urls = [];
        $elements = Craft::$app->getElements();
        $elementTypes = $elements->getAllElementTypes();
        foreach ($elementTypes as $elementType) {
            /** @noinspection SlowArrayOperationsInLoopInspection */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $urls = array_merge($urls, $this->getElementUrls($elementType, $criteria, $siteId));
        }

        return $urls;
    }

    /**
     * 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 array

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

     */
    public function getAllRouteRules(string $format = 'Craft', ?int $siteId = null): array
    {
        // Get all the sections
        $sections = $this->getAllSectionRouteRules($format, $siteId);
        $categories = $this->getAllCategoryRouteRules($format, $siteId);
        $rules = $this->getRouteRules($siteId);

        return [
            'sections' => $sections,
            'categories' => $categories,
            'rules' => $rules,
        ];
    }

    /**
     * Return the public URLs for a section
     *
     * @param string $section

Missing parameter comment

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

     * @param array $criteria

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 array

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

     */
    public function getSectionUrls(string $section, array $criteria = [], ?int $siteId = null): array
    {
        $criteria = array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'section' => $section,
            'status' => 'enabled',
        ], $criteria);

For multi-line function calls, the closing parenthesis should be on a new line.

        return $this->getElementUrls(Entry::class, $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 array

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

     */
    public function getAllSectionRouteRules(string $format = 'Craft', ?int $siteId = null): array
    {
        $routeRules = [];
        // Get all the sections
        $sections = Craft::$app->getEntries()->getAllSections();
        foreach ($sections as $section) {
            $routes = $this->getSectionRouteRules($section->handle, $format, $siteId);
            if (!empty($routes)) {
                $routeRules[$section->handle] = $routes;
            }
        }

        return $routeRules;
    }

    /**
     * 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 array

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

     */
    public function getSectionRouteRules(string $section, string $format = 'Craft', ?int $siteId = null): array
    {
        $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
        $cache = Craft::$app->getCache();

        // Set up our cache criteria
        $cacheKey = $this->getCacheKey($this::ROUTEMAP_SECTION_RULES, [$section, $format, $siteId]);
        $duration = $devMode ? $this::DEVMODE_ROUTEMAP_CACHE_DURATION : $this::ROUTEMAP_CACHE_DURATION;
        $dependency = new TagDependency([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'tags' => [
                $this::ROUTEMAP_CACHE_TAG,
            ],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Just return the data if it's already cached
        return $cache->getOrSet($cacheKey, function() use ($section, $format, $siteId): array {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            Craft::info(
                'Route Map cache miss: ' . $section,
                __METHOD__
            );
            $resultingRoutes = [];

            $section = Craft::$app->getEntries()->getSectionByHandle($section);
            if ($section) {
                $sites = $section->getSiteSettings();

                foreach ($sites as $site) {
                    if ($site->hasUrls && ($siteId === null || (int)$site->siteId === $siteId)) {
                        // Get section data to return
                        $route = [
                            'handle' => $section->handle,
                            'siteId' => $site->siteId,
                            'type' => $section->type,
                            'url' => $site->uriFormat,
                            'template' => $site->template,
                        ];

                        // Normalize the routes based on the format
                        $resultingRoutes[$site->siteId] = $this->normalizeFormat($format, $route);
                    }
                }
            }

            // If there's only one siteId for this section, just return it
            if (count($resultingRoutes) === 1) {
                $resultingRoutes = reset($resultingRoutes);
            }

            return $resultingRoutes;
        }, $duration, $dependency);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Return the public URLs for a category
     *
     * @param string $category

Missing parameter comment

     * @param array $criteria

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param ?int $siteId

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return array
     */
    public function getCategoryUrls(string $category, array $criteria = [], ?int $siteId = null): array
    {
        $criteria = array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'group' => $category,
        ], $criteria);

For multi-line function calls, the closing parenthesis should be on a new line.

        return $this->getElementUrls(Category::class, $criteria, $siteId);
    }

    /**
     * Return all the cateogry group 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 array

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

     */
    public function getAllCategoryRouteRules(string $format = 'Craft', ?int $siteId = null): array
    {
        $routeRules = [];
        // Get all the sections
        $groups = Craft::$app->getCategories()->getAllGroups();
        foreach ($groups as $group) {
            $routes = $this->getCategoryRouteRules($group->handle, $format, $siteId);
            if (!empty($routes)) {
                $routeRules[$group->handle] = $routes;
            }
        }

        return $routeRules;
    }

    /**
     * Return the route rules for a specific category
     *
     * @param int|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 5 spaces after parameter type; 1 found

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 7 spaces after parameter type; 1 found

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

     * @return array

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

     */
    public function getCategoryRouteRules(int|string $category, string $format = 'Craft', ?int $siteId = null): array
    {
        $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
        $cache = Craft::$app->getCache();

        if (is_int($category)) {
            $categoryGroup = Craft::$app->getCategories()->getGroupById($category);
            if ($categoryGroup === null) {
                return [];
            }

            $handle = $categoryGroup->handle;
        } else {
            $handle = $category;
        }

        if ($handle === null) {
            return [];
        }

        // Set up our cache criteria
        $cacheKey = $this->getCacheKey($this::ROUTEMAP_CATEGORY_RULES, [$category, $handle, $format, $siteId]);
        $duration = $devMode ? $this::DEVMODE_ROUTEMAP_CACHE_DURATION : $this::ROUTEMAP_CACHE_DURATION;
        $dependency = new TagDependency([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'tags' => [
                $this::ROUTEMAP_CACHE_TAG,
            ],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Just return the data if it's already cached
        return $cache->getOrSet($cacheKey, function() use ($category, $handle, $format, $siteId): array {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            Craft::info(
                'Route Map cache miss: ' . $category,
                __METHOD__
            );
            $resultingRoutes = [];
            $category = Craft::$app->getCategories()->getGroupByHandle($handle);
            if ($category) {
                $sites = $category->getSiteSettings();

                foreach ($sites as $site) {
                    if ($site->hasUrls && ($siteId === null || (int)$site->siteId === $siteId)) {
                        // Get section data to return
                        $route = [
                            'handle' => $category->handle,
                            'siteId' => $site->siteId,
                            'url' => $site->uriFormat,
                            'template' => $site->template,
                        ];

                        // Normalize the routes based on the format
                        $resultingRoutes[$site->siteId] = $this->normalizeFormat($format, $route);
                    }
                }
            }

            // If there's only one siteId for this section, just return it
            if (count($resultingRoutes) === 1) {
                $resultingRoutes = reset($resultingRoutes);
            }

            return $resultingRoutes;
        }, $duration, $dependency);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * 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 array

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

     */
    public function getUrlAssetUrls(string $url, array $assetTypes = ['image'], ?int $siteId = null): array
    {
        $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
        $cache = Craft::$app->getCache();

        // Extract a URI from the URL
        $uri = parse_url($url, PHP_URL_PATH);
        $uri = ltrim($uri, '/');
        // Set up our cache criteria
        $cacheKey = $this->getCacheKey($this::ROUTEMAP_ASSET_URLS, [$uri, $assetTypes, $siteId]);
        $duration = $devMode ? $this::DEVMODE_ROUTEMAP_CACHE_DURATION : $this::ROUTEMAP_CACHE_DURATION;
        $dependency = new TagDependency([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'tags' => [
                $this::ROUTEMAP_CACHE_TAG,
            ],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Just return the data if it's already cached
        return $cache->getOrSet($cacheKey, function() use ($uri, $assetTypes, $siteId): array {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            Craft::info(
                'Route Map cache miss: ' . $uri,
                __METHOD__
            );
            $resultingAssetUrls = [];

            // Find the element that matches this URI
            /** @var ?Entry $element */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $element = Craft::$app->getElements()->getElementByUri($uri, $siteId, true);
            if ($element) {
                // Iterate any Assets fields for this entry
                $assetFields = FieldHelper::fieldsOfType($element, AssetsField::class);
                foreach ($assetFields as $assetField) {
                    /** @var Asset[] $assets */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                    $assets = $element[$assetField]->all();
                    foreach ($assets as $asset) {
                        /** @var $asset Asset */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                        if (in_array($asset->kind, $assetTypes, true)
                            && !in_array($asset->getUrl(), $resultingAssetUrls, true)) {

Closing parenthesis of a multi-line IF statement must be on a new line

                            $resultingAssetUrls[] = $asset->getUrl();
                        }
                    }
                }

                // Iterate through any Assets embedded in Matrix fields
                $matrixFields = FieldHelper::fieldsOfType($element, MatrixField::class);
                foreach ($matrixFields as $matrixField) {
                    /** @var Entry[] $matrixEntries */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                    $matrixEntries = $element[$matrixField]->all();
                    foreach ($matrixEntries as $matrixEntry) {
                        $assetFields = FieldHelper::matrixFieldsOfType($matrixEntry, AssetsField::class);
                        foreach ($assetFields as $assetField) {
                            foreach ($matrixEntry[$assetField] as $asset) {
                                /** @var $asset Asset */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                                if (in_array($asset->kind, $assetTypes, true)
                                    && !in_array($asset->getUrl(), $resultingAssetUrls, true)) {

Closing parenthesis of a multi-line IF statement must be on a new line

                                    $resultingAssetUrls[] = $asset->getUrl();
                                }
                            }
                        }
                    }
                }
            }

            return $resultingAssetUrls;
        }, $duration, $dependency);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Returns all 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 array

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

     */
    public function getElementUrls(string|ElementInterface $elementType, array $criteria = [], ?int $siteId = null): array
    {
        $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
        $cache = Craft::$app->getCache();

        // Merge in the $criteria passed in
        $criteria = array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'siteId' => $siteId,
            'limit' => null,
        ], $criteria);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Set up our cache criteria
        /* @var ElementInterface $elementInterface */
        $elementInterface = is_object($elementType) ? $elementType : new $elementType();
        $cacheKey = $this->getCacheKey($this::ROUTEMAP_ELEMENT_URLS, [$elementInterface, $criteria, $siteId]);
        $duration = $devMode ? $this::DEVMODE_ROUTEMAP_CACHE_DURATION : $this::ROUTEMAP_CACHE_DURATION;
        $dependency = new TagDependency([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'tags' => [
                $this::ROUTEMAP_CACHE_TAG,
            ],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Just return the data if it's already cached
        return $cache->getOrSet($cacheKey, function() use ($elementInterface, $criteria): array {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            Craft::info(
                'Route Map cache miss: ' . $elementInterface::class,
                __METHOD__
            );
            $resultingUrls = [];

            // Get all of the entries in the section
            $query = $this->getElementQuery($elementInterface, $criteria);
            $elements = $query->all();

            // Iterate through the elements and grab their URLs
            foreach ($elements as $element) {
                if ($element instanceof Element
                    && $element->uri !== null
                    && !in_array($element->uri, $resultingUrls, true)
                ) {
                    $uri = $this->normalizeUri($element->uri);
                    $resultingUrls[] = $uri;
                }
            }

            return $resultingUrls;
        }, $duration, $dependency);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Invalidate the RouteMap caches
     */

Missing @return tag in function comment

    public function invalidateCache(): void
    {
        $cache = Craft::$app->getCache();
        TagDependency::invalidate($cache, self::ROUTEMAP_CACHE_TAG);
        Craft::info(
            'Route Map cache cleared',
            __METHOD__
        );
    }

    /**

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

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

     * Get all routes rules defined in the config/routes.php file and CMS
     *
     * @return array

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

     * @property ?int $siteId
     *
     * @property bool $includeGlobal - merge global routes with the site rules
     */
    public function getRouteRules(?int $siteId = null, bool $includeGlobal = true): array
    {
        $globalRules = [];

        $siteRoutes = $this->getDbRoutes($siteId);

        return array_merge(
            Craft::$app->getRoutes()->getConfigFileRoutes(),
            $globalRules,
            $siteRoutes
        );
    }

    // Protected Methods
    // =========================================================================
    /**
     * Query the database for db routes
     *
     * @param ?int $siteId

Missing parameter comment

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

     * @return array

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

     */
    protected function getDbRoutes(?int $siteId = null): array
    {
        return Craft::$app->getRoutes()->getProjectConfigRoutes();
    }

    /**
     * Normalize the routes based on the format
     *
     * @param string $format 'Craft'|'React'|'Vue'

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

     * @param array $route

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @return array

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

     */
    protected function normalizeFormat(string $format, array $route): array
    {
        // Normalize the URL
        $route['url'] = $this->normalizeUri($route['url']);
        // Transform the URLs depending on the format requested
        switch ($format) {
            // React & Vue routes have a leading / and {slug} -> :slug
            case $this::ROUTE_FORMAT_REACT:

Line indented incorrectly; expected 8 spaces, found 12

            case $this::ROUTE_FORMAT_VUE:

Line indented incorrectly; expected 8 spaces, found 12

                $matchRegEx = '`{(.*?)}`';
                $replaceRegEx = ':$1';
                $route['url'] = preg_replace($matchRegEx, $replaceRegEx, $route['url']);
                // Add a leading /
                $route['url'] = '/' . ltrim($route['url'], '/');
                break;

            // Craft-style URLs don't need to be changed
            case $this::ROUTE_FORMAT_CRAFT:

Line indented incorrectly; expected 8 spaces, found 12

            default:

Line indented incorrectly; expected 8 spaces, found 12

                // Do nothing
                break;
        }

        return $route;
    }

    /**
     * Normalize the URI
     *
     * @param string $url

Missing parameter comment

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

     * @return string

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

     */
    protected function normalizeUri(string $url): string
    {
        // Handle the special '__home__' URI
        if ($url === '__home__') {
            $url = '/';
        }

        return $url;
    }

    /**

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

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

     * Generate a cache key with the combination of the $prefix and an md5()
     * hashed version of the flattened $args array
     */

Missing @return tag in function comment

    protected function getCacheKey(string $prefix, array $args = []): string
    {
        $cacheKey = $prefix;
        $flattenedArgs = '';
        // If an array of $args is passed in, flatten it into a concatenated string
        if (!empty($args)) {
            foreach ($args as $arg) {
                if ((is_object($arg) || is_array($arg)) && !empty($arg)) {
                    $flattenedArgs .= http_build_query($arg);
                }

                if (is_string($arg)) {
                    $flattenedArgs .= $arg;
                }
            }

            // Make an md5 hash out of it
            $flattenedArgs = md5($flattenedArgs);
        }

        return $cacheKey . $flattenedArgs;
    }

    /**
     * Returns the element query based on $elementType and $criteria
     *
     * @param array $criteria

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

Doc comment for parameter $criteria does not match actual variable name $elementType

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

     * @param ElementInterface $elementType

Missing parameter comment

Doc comment for parameter $elementType does not match actual variable name $criteria

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

     * @return ElementQueryInterface

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

     */
    protected function getElementQuery(ElementInterface $elementType, array $criteria): ElementQueryInterface
    {
        $query = $elementType::find();
        Craft::configure($query, $criteria);

        return $query;
    }
}