nystudio107 / craft-units

src/helpers/ClassHelper.php

<?php
/**
 * Units plugin for Craft CMS
 *
 * A plugin for handling physical quantities and the units of measure in which they're represented.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

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

use Craft;
use ReflectionClass;
use ReflectionException;
use function dirname;

/**

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   Units

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 ClassHelper
{
    // Public Static Methods
    // =========================================================================

    /**
     * Return an array of classes in the same namespace as $className, in an
     * array of shortName => fullyQualifiedName
     *
     * @param string $className

Missing parameter comment

     *
     * @return array
     */
    public static function getClassesInNamespace(string $className): array
    {
        $result = [];
        $loader = include Craft::getAlias('@vendor/autoload.php');
        $filePath = $loader->findFile($className);
        if ($filePath) {
            $dir = realpath(dirname($filePath));
            $classesMap = ClassMapGenerator::createMap($dir);
            foreach ($classesMap as $class => $path) {
                try {
                    $reflect = new ReflectionClass($class);
                    $shortName = $reflect->getShortName();
                    $result[$shortName] = $class;
                } catch (ReflectionException $e) {
                    Craft::error($e->getMessage(), __METHOD__);
                }
            }
        }
        ksort($result);

        return $result;
    }
}