class MockFileFinder

Same name in other branches
  1. 9 core/lib/Drupal/Component/Annotation/Reflection/MockFileFinder.php \Drupal\Component\Annotation\Reflection\MockFileFinder
  2. 8.9.x core/lib/Drupal/Component/Annotation/Reflection/MockFileFinder.php \Drupal\Component\Annotation\Reflection\MockFileFinder
  3. 10 core/lib/Drupal/Component/Annotation/Reflection/MockFileFinder.php \Drupal\Component\Annotation\Reflection\MockFileFinder

Defines a mock file finder that only returns a single filename.

This can be used with Drupal\Component\Annotation\Doctrine\StaticReflectionParser if the filename is known and inheritance is not a concern (for example, if only the class annotation is needed).

Hierarchy

Expanded class hierarchy of MockFileFinder

7 files declare their use of MockFileFinder
AnnotatedClassDiscovery.php in core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php
AnnotatedClassDiscoveryAutomatedProviders.php in core/modules/migrate/src/Plugin/Discovery/AnnotatedClassDiscoveryAutomatedProviders.php
AttributeDiscoveryWithAnnotations.php in core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php
HookCollectorPass.php in core/lib/Drupal/Core/Hook/HookCollectorPass.php
MockFileFinderTest.php in core/tests/Drupal/Tests/Component/Annotation/MockFileFinderTest.php

... See full list

File

core/lib/Drupal/Component/Annotation/Reflection/MockFileFinder.php, line 15

Namespace

Drupal\Component\Annotation\Reflection
View source 
class MockFileFinder implements ClassFinderInterface {
    
    /**
     * The only filename this finder ever returns.
     *
     * @var string
     */
    protected $filename;
    
    /**
     * {@inheritdoc}
     */
    public function findFile($class) {
        return $this->filename;
    }
    
    /**
     * Creates new mock file finder objects.
     */
    public static function create($filename) {
        $object = new static();
        $object->filename = $filename;
        return $object;
    }

}

Members

Title Modifiers Object type Summary Overriden Title
MockFileFinder::$filename protected property The only filename this finder ever returns.
MockFileFinder::create public static function Creates new mock file finder objects.
MockFileFinder::findFile public function Overrides ClassFinderInterface::findFile

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.