You are here

Home » API reference » X Autoload 7.5 » Interface.php » xautoload_FinderPlugin_Interface

function xautoload_FinderPlugin_Interface::findFile in X Autoload 7.5

Same name and namespace in other branches
  1. 7.3 lib/FinderPlugin/Interface.php \xautoload_FinderPlugin_Interface::findFile()
  2. 7.4 legacy/lib/FinderPlugin/Interface.php \xautoload_FinderPlugin_Interface::findFile()

Find the file for a class that in PSR-0 or PEAR would be in $psr_0_root . '/' . $path_fragment . $path_suffix

E.g.:

  • The class we look for is Some\Namespace\Some\Class
  • The file is actually in "exotic/location.php". This is not following PSR-0 or PEAR standard, so we need a plugin.

-> The class finder will transform the class name to "Some/Namespace/Some/Class.php"

  • The plugin was registered for the namespace "Some\Namespace". This is because all those exotic classes all begin with Some\Namespace\

-> The arguments will be: ($api = the API object, see below) $logical_base_path = "Some/Namespace/" $relative_path = "Some/Class.php" $api->getClass() gives the original class name, if we still need it. -> We are supposed to: if ($api->suggestFile('exotic/location.php')) { return TRUE; }

Parameters

InjectedApiInterface $api: An object with a suggestFile() method. We are supposed to suggest files until suggestFile() returns TRUE, or we have no more suggestions.

string $logical_base_path: The key that this plugin was registered with. With trailing '/'.

string $relative_path: Second part of the canonical path, ending with '.php'.

Return value

bool|null TRUE, if the file was found. FALSE or NULL, otherwise.

5 methods override xautoload_FinderPlugin_Interface::findFile()
DrupalCoreRegistryPlugin::findFile in src/ClassFinder/Plugin/DrupalCoreRegistryPlugin.php
Find the file for a class that in PSR-0 or PEAR would be in $psr_0_root . '/' . $path_fragment . $path_suffix
DrupalExtensionNamespaceFinderPlugin::findFile in src/ClassFinder/Plugin/DrupalExtensionNamespaceFinderPlugin.php
Looks up a class starting with "Drupal\$extension_name\\".
LibrariesFinderPlugin::findFile in src/Libraries/LibrariesFinderPlugin.php
Find the file for a class that in PSR-0 or PEAR would be in $psr_0_root . '/' . $path_fragment . $path_suffix
Psr4FinderPlugin::findFile in src/ClassFinder/Plugin/Psr4FinderPlugin.php
xautoload_FinderPlugin_CheckIncludePath::findFile in legacy/lib/FinderPlugin/CheckIncludePath.php
Find the file for a class that in PSR-0 or PEAR would be in $psr_0_root . '/' . $path_fragment . $path_suffix

File

legacy/lib/FinderPlugin/Interface.php, line 50

Class

xautoload_FinderPlugin_Interface
X Autoload plugins are for:

Code

function findFile($api, $logical_base_path, $relative_path);