symplify/package-builder

Dependency Injection, Console and Kernel toolkit for Symplify packages.

11.3.2 2023-02-22 19:16 UTC

Requires

• php: >=8.1
• nette/utils: ^3.2
• sebastian/diff: ^5.0
• symfony/config: ^6.2
• symfony/console: ^6.2
• symfony/dependency-injection: ^6.2
• symfony/finder: ^6.2
• symfony/http-kernel: ^6.2

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.2
• phpunit/phpunit: ^10.0
• rector/rector: ^0.15.10
• symplify/easy-ci: ^11.2.0
• symplify/easy-coding-standard: ^11.2
• symplify/phpstan-extensions: ^11.1
• symplify/phpstan-rules: ^11.2
• symplify/symplify-kernel: ^11.1
• tomasvotruba/unused-public: ^0.0.34

MIT

README

This tools helps you with Collectors in DependecyInjection, Console shortcuts, ParameterProvider as service and many more.

Install

composer require symplify/package-builder

Use

Get All Parameters via Service

1. Register ParameterProvider service in your config:

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symplify\PackageBuilder\Parameter\ParameterProvider;
use function Symfony\Component\DependencyInjection\Loader\Configurator\service;

return static function (ContainerConfigurator $containerConfigurator): void {
    $services = $containerConfigurator->services();

    $services->defaults()
        ->autowire()
        ->autoconfigure();

    $services->set(ParameterProvider::class)
        ->args([service('service_container')]);

    $parameter = $containerConfigurator->parameters();
    // will be used later
    $parameter->set('source', 'src');
};

1. Require ParameterProvider in __construct() where needed:

namespace App\Configuration;

use Symplify\PackageBuilder\Parameter\ParameterProvider;

final class ProjectConfiguration
{
    /**
     * @var ParameterProvider
     */
    private $parameterProvider;

    public function __construct(ParameterProvider $parameterProvider)
    {
        $this->parameterProvider = $parameterProvider;
    }

    public function getSource(): string
    {
        // returns "src"
        return $this->parameterProvider->provideParameter('source');

        // use specific typed method to avoid `mixed`
        return $this->parameterProvider->provideStringParameter('source');
    }
}

Get Vendor Directory from Anywhere

use Symplify\PackageBuilder\Composer\VendorDirProvider;

$vendorDirProvider = new VendorDirProvider();
// returns path to vendor directory
$vendorDirProvider->provide();

Smart Compiler Passes for Lazy Programmers ↓

How to add compiler pass?

Always Autowire this Type

Do you want to allow users to register services without worrying about autowiring? After all, they might forget it and that would break their code. Set types to always autowire:

namespace App;

use PhpCsFixer\Fixer\FixerInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Kernel;
use Symplify\PackageBuilder\DependencyInjection\CompilerPass\AutowireInterfacesCompilerPass;

final class AppKernel extends Kernel
{
    protected function build(ContainerBuilder $containerBuilder): void
    {
        $containerBuilder->addCompilerPass(new AutowireInterfacesCompilerPass([FixerInterface::class]));
    }
}

This will make sure, that PhpCsFixer\Fixer\FixerInterface instances are always autowired.

That's all :)

Show Diff in Console Colors

use Symplify\PackageBuilder\Console\Output\ConsoleDiffer;

final class SomeCommand
{
    public function __construct(
        private ConsoleDiffer $consoleDiffer
    ) {
    }

    public function run(): void
    {
        // prints colored diff to the console output
        $this->consoleDiffer->diff('oldContent', 'newContent');
    }
}

Report Issues

In case you are experiencing a bug or want to request a new feature head over to the Symplify monorepo issue tracker

Contribute

The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on symplify/symplify.