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

Breadcrumb

  1. Drupal Core 11.1.x
  2. AttributeParser.php

class AttributeParser

@no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit

@internal This class is not covered by the backward compatibility promise for PHPUnit

Hierarchy

  • class \PHPUnit\Metadata\Parser\AttributeParser implements \PHPUnit\Metadata\Parser\Parser

Expanded class hierarchy of AttributeParser

File

vendor/phpunit/phpunit/src/Metadata/Parser/AttributeParser.php, line 82

Namespace

PHPUnit\Metadata\Parser
View source
final class AttributeParser implements Parser {
    
    /**
     * @psalm-param class-string $className
     */
    public function forClass(string $className) : MetadataCollection {
        assert(class_exists($className));
        $result = [];
        foreach ((new ReflectionClass($className))->getAttributes() as $attribute) {
            if (!str_starts_with($attribute->getName(), 'PHPUnit\\Framework\\Attributes\\')) {
                continue;
            }
            if (!class_exists($attribute->getName())) {
                continue;
            }
            $attributeInstance = $attribute->newInstance();
            switch ($attribute->getName()) {
                case BackupGlobals::class:
                    assert($attributeInstance instanceof BackupGlobals);
                    $result[] = Metadata::backupGlobalsOnClass($attributeInstance->enabled());
                    break;
                case BackupStaticProperties::class:
                    assert($attributeInstance instanceof BackupStaticProperties);
                    $result[] = Metadata::backupStaticPropertiesOnClass($attributeInstance->enabled());
                    break;
                case CoversClass::class:
                    assert($attributeInstance instanceof CoversClass);
                    $result[] = Metadata::coversClass($attributeInstance->className());
                    break;
                case CoversFunction::class:
                    assert($attributeInstance instanceof CoversFunction);
                    $result[] = Metadata::coversFunction($attributeInstance->functionName());
                    break;
                case CoversNothing::class:
                    $result[] = Metadata::coversNothingOnClass();
                    break;
                case DoesNotPerformAssertions::class:
                    $result[] = Metadata::doesNotPerformAssertionsOnClass();
                    break;
                case ExcludeGlobalVariableFromBackup::class:
                    assert($attributeInstance instanceof ExcludeGlobalVariableFromBackup);
                    $result[] = Metadata::excludeGlobalVariableFromBackupOnClass($attributeInstance->globalVariableName());
                    break;
                case ExcludeStaticPropertyFromBackup::class:
                    assert($attributeInstance instanceof ExcludeStaticPropertyFromBackup);
                    $result[] = Metadata::excludeStaticPropertyFromBackupOnClass($attributeInstance->className(), $attributeInstance->propertyName());
                    break;
                case Group::class:
                    assert($attributeInstance instanceof Group);
                    $result[] = Metadata::groupOnClass($attributeInstance->name());
                    break;
                case Large::class:
                    $result[] = Metadata::groupOnClass('large');
                    break;
                case Medium::class:
                    $result[] = Metadata::groupOnClass('medium');
                    break;
                case IgnoreClassForCodeCoverage::class:
                    assert($attributeInstance instanceof IgnoreClassForCodeCoverage);
                    $result[] = Metadata::ignoreClassForCodeCoverage($attributeInstance->className());
                    break;
                case IgnoreDeprecations::class:
                    assert($attributeInstance instanceof IgnoreDeprecations);
                    $result[] = Metadata::ignoreDeprecationsOnClass();
                    break;
                case IgnoreMethodForCodeCoverage::class:
                    assert($attributeInstance instanceof IgnoreMethodForCodeCoverage);
                    $result[] = Metadata::ignoreMethodForCodeCoverage($attributeInstance->className(), $attributeInstance->methodName());
                    break;
                case IgnoreFunctionForCodeCoverage::class:
                    assert($attributeInstance instanceof IgnoreFunctionForCodeCoverage);
                    $result[] = Metadata::ignoreFunctionForCodeCoverage($attributeInstance->functionName());
                    break;
                case PreserveGlobalState::class:
                    assert($attributeInstance instanceof PreserveGlobalState);
                    $result[] = Metadata::preserveGlobalStateOnClass($attributeInstance->enabled());
                    break;
                case RequiresMethod::class:
                    assert($attributeInstance instanceof RequiresMethod);
                    $result[] = Metadata::requiresMethodOnClass($attributeInstance->className(), $attributeInstance->methodName());
                    break;
                case RequiresFunction::class:
                    assert($attributeInstance instanceof RequiresFunction);
                    $result[] = Metadata::requiresFunctionOnClass($attributeInstance->functionName());
                    break;
                case RequiresOperatingSystem::class:
                    assert($attributeInstance instanceof RequiresOperatingSystem);
                    $result[] = Metadata::requiresOperatingSystemOnClass($attributeInstance->regularExpression());
                    break;
                case RequiresOperatingSystemFamily::class:
                    assert($attributeInstance instanceof RequiresOperatingSystemFamily);
                    $result[] = Metadata::requiresOperatingSystemFamilyOnClass($attributeInstance->operatingSystemFamily());
                    break;
                case RequiresPhp::class:
                    assert($attributeInstance instanceof RequiresPhp);
                    $result[] = Metadata::requiresPhpOnClass(ConstraintRequirement::from($attributeInstance->versionRequirement()));
                    break;
                case RequiresPhpExtension::class:
                    assert($attributeInstance instanceof RequiresPhpExtension);
                    $versionConstraint = null;
                    $versionRequirement = $attributeInstance->versionRequirement();
                    if ($versionRequirement !== null) {
                        $versionConstraint = ConstraintRequirement::from($versionRequirement);
                    }
                    $result[] = Metadata::requiresPhpExtensionOnClass($attributeInstance->extension(), $versionConstraint);
                    break;
                case RequiresPhpunit::class:
                    assert($attributeInstance instanceof RequiresPhpunit);
                    $result[] = Metadata::requiresPhpunitOnClass(ConstraintRequirement::from($attributeInstance->versionRequirement()));
                    break;
                case RequiresSetting::class:
                    assert($attributeInstance instanceof RequiresSetting);
                    $result[] = Metadata::requiresSettingOnClass($attributeInstance->setting(), $attributeInstance->value());
                    break;
                case RunClassInSeparateProcess::class:
                    $result[] = Metadata::runClassInSeparateProcess();
                    break;
                case RunTestsInSeparateProcesses::class:
                    $result[] = Metadata::runTestsInSeparateProcesses();
                    break;
                case Small::class:
                    $result[] = Metadata::groupOnClass('small');
                    break;
                case TestDox::class:
                    assert($attributeInstance instanceof TestDox);
                    $result[] = Metadata::testDoxOnClass($attributeInstance->text());
                    break;
                case Ticket::class:
                    assert($attributeInstance instanceof Ticket);
                    $result[] = Metadata::groupOnClass($attributeInstance->text());
                    break;
                case UsesClass::class:
                    assert($attributeInstance instanceof UsesClass);
                    $result[] = Metadata::usesClass($attributeInstance->className());
                    break;
                case UsesFunction::class:
                    assert($attributeInstance instanceof UsesFunction);
                    $result[] = Metadata::usesFunction($attributeInstance->functionName());
                    break;
            }
        }
        return MetadataCollection::fromArray($result);
    }
    
    /**
     * @psalm-param class-string $className
     * @psalm-param non-empty-string $methodName
     */
    public function forMethod(string $className, string $methodName) : MetadataCollection {
        assert(class_exists($className));
        assert(method_exists($className, $methodName));
        $result = [];
        foreach ((new ReflectionMethod($className, $methodName))->getAttributes() as $attribute) {
            if (!str_starts_with($attribute->getName(), 'PHPUnit\\Framework\\Attributes\\')) {
                continue;
            }
            if (!class_exists($attribute->getName())) {
                continue;
            }
            $attributeInstance = $attribute->newInstance();
            switch ($attribute->getName()) {
                case After::class:
                    $result[] = Metadata::after();
                    break;
                case AfterClass::class:
                    $result[] = Metadata::afterClass();
                    break;
                case BackupGlobals::class:
                    assert($attributeInstance instanceof BackupGlobals);
                    $result[] = Metadata::backupGlobalsOnMethod($attributeInstance->enabled());
                    break;
                case BackupStaticProperties::class:
                    assert($attributeInstance instanceof BackupStaticProperties);
                    $result[] = Metadata::backupStaticPropertiesOnMethod($attributeInstance->enabled());
                    break;
                case Before::class:
                    $result[] = Metadata::before();
                    break;
                case BeforeClass::class:
                    $result[] = Metadata::beforeClass();
                    break;
                case CoversNothing::class:
                    $result[] = Metadata::coversNothingOnMethod();
                    break;
                case DataProvider::class:
                    assert($attributeInstance instanceof DataProvider);
                    $result[] = Metadata::dataProvider($className, $attributeInstance->methodName());
                    break;
                case DataProviderExternal::class:
                    assert($attributeInstance instanceof DataProviderExternal);
                    $result[] = Metadata::dataProvider($attributeInstance->className(), $attributeInstance->methodName());
                    break;
                case Depends::class:
                    assert($attributeInstance instanceof Depends);
                    $result[] = Metadata::dependsOnMethod($className, $attributeInstance->methodName(), false, false);
                    break;
                case DependsUsingDeepClone::class:
                    assert($attributeInstance instanceof DependsUsingDeepClone);
                    $result[] = Metadata::dependsOnMethod($className, $attributeInstance->methodName(), true, false);
                    break;
                case DependsUsingShallowClone::class:
                    assert($attributeInstance instanceof DependsUsingShallowClone);
                    $result[] = Metadata::dependsOnMethod($className, $attributeInstance->methodName(), false, true);
                    break;
                case DependsExternal::class:
                    assert($attributeInstance instanceof DependsExternal);
                    $result[] = Metadata::dependsOnMethod($attributeInstance->className(), $attributeInstance->methodName(), false, false);
                    break;
                case DependsExternalUsingDeepClone::class:
                    assert($attributeInstance instanceof DependsExternalUsingDeepClone);
                    $result[] = Metadata::dependsOnMethod($attributeInstance->className(), $attributeInstance->methodName(), true, false);
                    break;
                case DependsExternalUsingShallowClone::class:
                    assert($attributeInstance instanceof DependsExternalUsingShallowClone);
                    $result[] = Metadata::dependsOnMethod($attributeInstance->className(), $attributeInstance->methodName(), false, true);
                    break;
                case DependsOnClass::class:
                    assert($attributeInstance instanceof DependsOnClass);
                    $result[] = Metadata::dependsOnClass($attributeInstance->className(), false, false);
                    break;
                case DependsOnClassUsingDeepClone::class:
                    assert($attributeInstance instanceof DependsOnClassUsingDeepClone);
                    $result[] = Metadata::dependsOnClass($attributeInstance->className(), true, false);
                    break;
                case DependsOnClassUsingShallowClone::class:
                    assert($attributeInstance instanceof DependsOnClassUsingShallowClone);
                    $result[] = Metadata::dependsOnClass($attributeInstance->className(), false, true);
                    break;
                case DoesNotPerformAssertions::class:
                    assert($attributeInstance instanceof DoesNotPerformAssertions);
                    $result[] = Metadata::doesNotPerformAssertionsOnMethod();
                    break;
                case ExcludeGlobalVariableFromBackup::class:
                    assert($attributeInstance instanceof ExcludeGlobalVariableFromBackup);
                    $result[] = Metadata::excludeGlobalVariableFromBackupOnMethod($attributeInstance->globalVariableName());
                    break;
                case ExcludeStaticPropertyFromBackup::class:
                    assert($attributeInstance instanceof ExcludeStaticPropertyFromBackup);
                    $result[] = Metadata::excludeStaticPropertyFromBackupOnMethod($attributeInstance->className(), $attributeInstance->propertyName());
                    break;
                case Group::class:
                    assert($attributeInstance instanceof Group);
                    $result[] = Metadata::groupOnMethod($attributeInstance->name());
                    break;
                case IgnoreDeprecations::class:
                    assert($attributeInstance instanceof IgnoreDeprecations);
                    $result[] = Metadata::ignoreDeprecationsOnMethod();
                    break;
                case PostCondition::class:
                    $result[] = Metadata::postCondition();
                    break;
                case PreCondition::class:
                    $result[] = Metadata::preCondition();
                    break;
                case PreserveGlobalState::class:
                    assert($attributeInstance instanceof PreserveGlobalState);
                    $result[] = Metadata::preserveGlobalStateOnMethod($attributeInstance->enabled());
                    break;
                case RequiresMethod::class:
                    assert($attributeInstance instanceof RequiresMethod);
                    $result[] = Metadata::requiresMethodOnMethod($attributeInstance->className(), $attributeInstance->methodName());
                    break;
                case RequiresFunction::class:
                    assert($attributeInstance instanceof RequiresFunction);
                    $result[] = Metadata::requiresFunctionOnMethod($attributeInstance->functionName());
                    break;
                case RequiresOperatingSystem::class:
                    assert($attributeInstance instanceof RequiresOperatingSystem);
                    $result[] = Metadata::requiresOperatingSystemOnMethod($attributeInstance->regularExpression());
                    break;
                case RequiresOperatingSystemFamily::class:
                    assert($attributeInstance instanceof RequiresOperatingSystemFamily);
                    $result[] = Metadata::requiresOperatingSystemFamilyOnMethod($attributeInstance->operatingSystemFamily());
                    break;
                case RequiresPhp::class:
                    assert($attributeInstance instanceof RequiresPhp);
                    $result[] = Metadata::requiresPhpOnMethod(ConstraintRequirement::from($attributeInstance->versionRequirement()));
                    break;
                case RequiresPhpExtension::class:
                    assert($attributeInstance instanceof RequiresPhpExtension);
                    $versionConstraint = null;
                    $versionRequirement = $attributeInstance->versionRequirement();
                    if ($versionRequirement !== null) {
                        $versionConstraint = ConstraintRequirement::from($versionRequirement);
                    }
                    $result[] = Metadata::requiresPhpExtensionOnMethod($attributeInstance->extension(), $versionConstraint);
                    break;
                case RequiresPhpunit::class:
                    assert($attributeInstance instanceof RequiresPhpunit);
                    $result[] = Metadata::requiresPhpunitOnMethod(ConstraintRequirement::from($attributeInstance->versionRequirement()));
                    break;
                case RequiresSetting::class:
                    assert($attributeInstance instanceof RequiresSetting);
                    $result[] = Metadata::requiresSettingOnMethod($attributeInstance->setting(), $attributeInstance->value());
                    break;
                case RunInSeparateProcess::class:
                    $result[] = Metadata::runInSeparateProcess();
                    break;
                case Test::class:
                    $result[] = Metadata::test();
                    break;
                case TestDox::class:
                    assert($attributeInstance instanceof TestDox);
                    $result[] = Metadata::testDoxOnMethod($attributeInstance->text());
                    break;
                case TestWith::class:
                    assert($attributeInstance instanceof TestWith);
                    $result[] = Metadata::testWith($attributeInstance->data());
                    break;
                case TestWithJson::class:
                    assert($attributeInstance instanceof TestWithJson);
                    $result[] = Metadata::testWith(json_decode($attributeInstance->json(), true, 512, JSON_THROW_ON_ERROR));
                    break;
                case Ticket::class:
                    assert($attributeInstance instanceof Ticket);
                    $result[] = Metadata::groupOnMethod($attributeInstance->text());
                    break;
                case WithoutErrorHandler::class:
                    assert($attributeInstance instanceof WithoutErrorHandler);
                    $result[] = Metadata::withoutErrorHandler();
                    break;
            }
        }
        return MetadataCollection::fromArray($result);
    }
    
    /**
     * @psalm-param class-string $className
     * @psalm-param non-empty-string $methodName
     */
    public function forClassAndMethod(string $className, string $methodName) : MetadataCollection {
        return $this->forClass($className)
            ->mergeWith($this->forMethod($className, $methodName));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
AttributeParser::forClass public function @psalm-param class-string $className Overrides Parser::forClass
AttributeParser::forClassAndMethod public function @psalm-param class-string $className
@psalm-param non-empty-string $methodName
Overrides Parser::forClassAndMethod
AttributeParser::forMethod public function @psalm-param class-string $className
@psalm-param non-empty-string $methodName
Overrides Parser::forMethod

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal