hylianshield/vendor-locator-bundle

This bundle allows to locate vendor packages inside a Symfony project.

Introduction

This bundle allows to locate composer vendor packages inside a Symfony project. It interprets the composer.json in your project root to find the correct vendor base directory., _(*1)

The vendor location is configured with a compiler pass, so the path lookup is stored in DI definition cache., _(*2)

Installation

composer require hylianshield/vendor-locator-bundle:^1.0

Add the following bundle to the app kernel., _(*3)

<?php
use HylianShield\VendorLocatorBundle\HylianShieldVendorLocatorBundle;

//...
class AppKernel extends Kernel
{
    // ...
    public function registerBundles()
    {
        $bundles = [
            // ...
            new HylianShieldVendorLocatorBundle()
        ];
        // ...
    }
    // ...
}

Make sure to flush the cache, to activate the compiler pass., _(*4)

Usage

The file locator service is available as service hylianshield.file_locator.vendor., _(*5)

With this service, one can find files relative to the vendor directory:, _(*6)

<?php
/** @var \Symfony\Component\Config\FileLocatorInterface $locator */
$locator = $this->get('hylianshield.file_locator.vendor');

echo $locator->locate('hylianshield/vendor-locator-bundle');

Outputs:, _(*7)

/path/to/symfony/vendor/hylianshield/vendor-locator-bundle