laragear/meta

A Laravel Package helper for Laravel Packages

v3.0.0 2024-03-04 02:09 UTC

Requires

• php: ^8.1

Requires (Dev)

• laragear/meta-testing: 2.*
• laravel/breeze: 1.*|2.*
• orchestra/testbench: 8.*|9.*

MIT

• Italo Israel Baeza Cabrera

• package
• laravel

README

A Laravel Package helper for Laravel Packages.

public function boot()
{
    $this->publishMigrations(__DIR__.'/../migrations');
    
    $this->withSchedule(fn($schedule) => $schedule->command('inspire')->hourly());
}

Become a sponsor

Your support allows me to keep this package free, up-to-date and maintainable. Alternatively, you can spread the word!

Requirements

• Laravel 10 or later.

Installation

Require this package into your project using Composer, along with the development-only testers:

composer require laragear/meta
composer require --dev laragear/meta-testing

Discoverer

The Discover class is a builder that allows discovering classes under a given path. It contains various fluent methods to filter the classes to discover, like methods, properties, interfaces and traits, among others.

It has been moved into its own repository. You may install it alongside this package, but is not required to.

composer require laragear/discover

Middleware declaration

When using withMiddleware() you will receive a MiddlewareDeclaration object with convenient methods to register the middleware globally or inside a group, set it as first/last in the global priority stack, and register an alias for it.

public function boot()
{
    $declaration = $this->withMiddleware(OnlyAdults::class);
    
    // Make it a shared instance.
    $declaration->shared();
    
    // Set an alias
    $declaration->as('adults');
    
    // Puts it inside a middleware group.
    $declaration->inGroup('web');
    
    // Sets the middleware in the global stack.
    $declaration->globally();
    
    // Makes the middleware run first or last in the priority stack.
    $declaration->first();
    $declaration->last();
}

Builder extender

The ExtendsBuilder trait allows a Global Scope to extend the instance of the Eloquent Builder with new methods. Simply start your builder methods extend, no matter wich visibility scope or if the method is static or not.

use Illuminate\Database\Eloquent\Scope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Laragear\Meta\Database\Eloquent\ExtendsBuilder;

class Cars implements Scope
{
    use ExtendsBuilder;
    
    public function apply(Builder $builder, Model $model)
    {
        // ...
    }
    
    private function extendWhereAvailable($builder)
    {
        return $builder->where('available_at', '>', now());
    }
    
    protected static function extendWhereColor($builder, string $color)
    {
        return $builder->where('base_color', $color);
    }
}

Tip

If you need the model being queried, you can always use getModel() over the Eloquent Builder instance.

Command Helpers

This meta package includes the WithEnvironmentFile helper trait to modify the environment file keys and values.

use Illuminate\Console\Command;
use Laragear\Meta\Console\Commands\WithEnvironmentFile;


class AddServiceKey extends Command
{
    use WithEnvironmentFile;
    
    public function handle()
    {
        // ...
        
        $this->putEnvKey('AWESOME_SERVICE', $this->argument('service_key'))
    }
}

Upgrading

Testing

Prior version of Laragear Meta contained testing helpers for packages. These have been migrated to Laragear MetaTesting separately. You can use these helpers in your project with Composer to install as development dependency:

composer require --dev laragear/meta-testing

PublishesMigrations trait

This trait has been eliminated.

This publishesMigration method has a signature collision on Laravel 11.x. If you plan to import it to a multi-version Laravel package, consider using your own publishing logic.

Laravel Octane compatibility

• There are no singletons using a stale application instance.
• There are no singletons using a stale config instance.
• There are no singletons using a stale request instance.
• ExtendsBuilder only initializes its static property once per Scope.

There should be no problems using this package with Laravel Octane.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

This specific package version is licensed under the terms of the MIT License, at time of publishing.

Laravel is a Trademark of Taylor Otwell. Copyright © 2011-2024 Laravel LLC.