public function Kernel::locateResource

Returns the file path for a given resource.

A Resource can be a file or a directory.

The resource name must follow the following pattern:

@<BundleName>/path/to/a/file.something

where BundleName is the name of the bundle and the remaining part is the relative path in the bundle.

If $dir is passed, and the first segment of the path is "Resources", this method will look for a file named:

$dir/<BundleName>/path/without/Resources

before looking in the bundle resource folder.

@api

Parameters

string $name A resource name to locate:

string $dir A directory where to look for the resource first:

Boolean $first Whether to return the first path or paths for all matching bundles:

Return value

string|array The absolute path of the resource or an array if $first is false

Throws

\InvalidArgumentException if the file cannot be found or the name is not valid

\RuntimeException if the name contains invalid/unsafe

\RuntimeException if a custom resource is hidden by a resource in a derived bundle

Overrides KernelInterface::locateResource

File

drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Kernel.php, line 278

Class

Kernel

The Kernel is the heart of the Symfony system.

Namespace

Code

public function locateResource($name, $dir = null, $first = true) {
  if ('@' !== $name[0]) {
    throw new \InvalidArgumentException(sprintf('A resource name must start with @ ("%s" given).', $name));
  }
  if (false !== strpos($name, '..')) {
    throw new \RuntimeException(sprintf('File name "%s" contains invalid characters (..).', $name));
  }
  $bundleName = substr($name, 1);
  $path = '';
  if (false !== strpos($bundleName, '/')) {
    list($bundleName, $path) = explode('/', $bundleName, 2);
  }
  $isResource = 0 === strpos($path, 'Resources') && null !== $dir;
  $overridePath = substr($path, 9);
  $resourceBundle = null;
  $bundles = $this
    ->getBundle($bundleName, false);
  $files = array();
  foreach ($bundles as $bundle) {
    if ($isResource && file_exists($file = $dir . '/' . $bundle
      ->getName() . $overridePath)) {
      if (null !== $resourceBundle) {
        throw new \RuntimeException(sprintf('"%s" resource is hidden by a resource from the "%s" derived bundle. Create a "%s" file to override the bundle resource.', $file, $resourceBundle, $dir . '/' . $bundles[0]
          ->getName() . $overridePath));
      }
      if ($first) {
        return $file;
      }
      $files[] = $file;
    }
    if (file_exists($file = $bundle
      ->getPath() . '/' . $path)) {
      if ($first && !$isResource) {
        return $file;
      }
      $files[] = $file;
      $resourceBundle = $bundle
        ->getName();
    }
  }
  if (count($files) > 0) {
    return $first && $isResource ? $files[0] : $files;
  }
  throw new \InvalidArgumentException(sprintf('Unable to find file "%s".', $name));
}