nystudio107 / craft-vite

src/helpers/PluginConfig.php

<?php
/**
 * Vite plugin for Craft CMS
 *
 * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 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\vite\helpers;

use Craft;
use ReflectionClass;
use ReflectionException;
use ReflectionProperty;

/**

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   Vite

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

 * @since     4.0.3

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 PluginConfig
{
    // Public static methods
    // =========================================================================

    /**
     * Return a service config definition pre-populated with settings from the
     * $configHandle config/ file
     *
     * @param string $configHandle

Missing parameter comment

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

     * @param string $serviceClass

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

     */
    public static function serviceDefinitionFromConfig(string $configHandle, string $serviceClass): array
    {
        $serviceAttrs = [];

The assignment to $serviceAttrs is dead and can be removed.

        // Get the available attributes from the $serviceClass
        try {
            $serviceAttrs = self::getClassAttributes($serviceClass);
        } catch (ReflectionException $e) {
            // That's fine
        }
        // Intersect the settings from the config file with the available service attributes
        $serviceConfig = array_intersect_key(
            Craft::$app->getConfig()->getConfigFromFile($configHandle),
            $serviceAttrs
        );

        return array_merge(
            $serviceConfig,
            ['class' => $serviceClass]
        );
    }

    /**

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

     * Return the list of attribute names from a class name
     *
     * @return array list of attribute names.
     * @throws ReflectionException
     */
    public static function getClassAttributes(string $className): array
    {
        $class = new ReflectionClass($className);
        $names = [];
        foreach ($class->getProperties(ReflectionProperty::IS_PUBLIC) as $property) {
            if (!$property->isStatic()) {
                $name = $property->getName();
                $names[$name] = $name;
            }
        }

        return $names;
    }
}