Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

ConstantHelper.php

Namespace

SlevomatCodingStandard\Helpers

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ConstantHelper.php

View source
<?php

declare (strict_types=1);
namespace SlevomatCodingStandard\Helpers;

use Generator;
use PHP_CodeSniffer\Files\File;
use function array_filter;
use function array_map;
use function array_reverse;
use function iterator_to_array;
use function sprintf;
use const T_CONST;
use const T_NAMESPACE;
use const T_STRING;

/**
 * @internal
 */
class ConstantHelper {
    public static function getName(File $phpcsFile, int $constantPointer) : string {
        $tokens = $phpcsFile->getTokens();
        return $tokens[TokenHelper::findNext($phpcsFile, T_STRING, $constantPointer + 1)]['content'];
    }
    public static function getFullyQualifiedName(File $phpcsFile, int $constantPointer) : string {
        $name = self::getName($phpcsFile, $constantPointer);
        $namespace = NamespaceHelper::findCurrentNamespaceName($phpcsFile, $constantPointer);
        return $namespace !== null ? sprintf('%s%s%s%s', NamespaceHelper::NAMESPACE_SEPARATOR, $namespace, NamespaceHelper::NAMESPACE_SEPARATOR, $name) : $name;
    }
    
    /**
     * @return list<string>
     */
    public static function getAllNames(File $phpcsFile) : array {
        $previousConstantPointer = 0;
        return array_map(static function (int $constantPointer) use ($phpcsFile) : string {
            return self::getName($phpcsFile, $constantPointer);
        }, array_filter(iterator_to_array(self::getAllConstantPointers($phpcsFile, $previousConstantPointer)), static function (int $constantPointer) use ($phpcsFile) : bool {
            foreach (array_reverse($phpcsFile->getTokens()[$constantPointer]['conditions']) as $conditionTokenCode) {
                return $conditionTokenCode === T_NAMESPACE;
            }
            return true;
        }));
    }
    
    /**
     * @return Generator<int>
     */
    private static function getAllConstantPointers(File $phpcsFile, int &$previousConstantPointer) : Generator {
        do {
            $nextConstantPointer = TokenHelper::findNext($phpcsFile, T_CONST, $previousConstantPointer + 1);
            if ($nextConstantPointer === null) {
                break;
            }
            $previousConstantPointer = $nextConstantPointer;
            (yield $nextConstantPointer);
        } while (true);
    }

}

Classes

Title Deprecated Summary
ConstantHelper @internal
RSS feed
Powered by Drupal