webflo/drupal-finder

Helper class to locate a Drupal installation from a given path.

Maintainers

Details

github.com/webflo/drupal-finder

Source

Issues

Installs: 12 403 824

Dependents: 255

Suggesters: 0

Security: 0

Stars: 121

Watchers: 6

Forks: 22

Open Issues: 15

1.2.2 2020-10-27 09:42 UTC

Requires

  • ext-json: *

Requires (Dev)

GPL-2.0-or-later c8e5dbe65caef285fec8057a4c718a0d4138d1ee

  • Florian Weber <florian.woop@webflo.org>

This package is auto-updated.

Last update: 2021-05-24 22:28:14 UTC

README

GitHub Workflow Status Packagist

Drupal Finder provides a class to locate a Drupal installation in a given path.

Usage

$drupalFinder = new \DrupalFinder\DrupalFinder(getcwd());

$drupalRoot = $drupalFinder->getDrupalRoot();
$composerRoot = $drupalFinder->getComposerRoot();
$vendorDir = $drupalFinder->getVendorDir();

Environment variables

If a set of environment variables is specified, then Drupal Finder uses those values to determine the paths of the pertinent directories:

  • DRUPAL_FINDER_DRUPAL_ROOT
  • DRUPAL_FINDER_COMPOSER_ROOT
  • DRUPAL_FINDER_VENDOR_DIR

For example:

  • DRUPAL_FINDER_DRUPAL_ROOT=/var/www/web
  • DRUPAL_FINDER_COMPOSER_ROOT=/var/www
  • DRUPAL_FINDER_VENDOR_DIR=/var/www/vendor

This is useful for situations where you are containerizing an application, directories may be in odd places, or a composer.json might be missing since it is unneeded in a final build artifact.

You are not required to set all the environment variables to use this feature. If you set an environment variable, then its associated getter function will return the value assigned to the environment variable.

Examples

License

GPL-2.0+