sunaoka / laravel-facade-generator
Provide command line generation of facade layer files.
Installs: 1 313
Dependents: 0
Suggesters: 0
Security: 0
Stars: 14
Watchers: 4
Forks: 1
Open Issues: 0
Requires
- php: ^7.1.3 || ^8.0
- illuminate/support: ^5.8 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
Requires (Dev)
- orchestra/testbench: ^3.8 || ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0
README
It is an artisan console command that generates services, service providers and facades.
Installation
composer require --dev sunaoka/laravel-facade-generator
Usage
php artisan make:facade [Facade Name]
Configurations
php artisan vendor:publish --tag=facade-generator-config
<?php return [ /* |-------------------------------------------------------------------------- | Class names suffix | | Sets the string to be suffixed to the class name. |-------------------------------------------------------------------------- */ 'suffix' => [ 'facade' => '', 'service' => 'Service', 'provider' => 'ServiceProvider', ], /* |-------------------------------------------------------------------------- | Generate test | | If `false`, no test will be generated. |-------------------------------------------------------------------------- */ 'test' => true, ];
Example
php artisan make:facade Foo
Generated: app/Facades/Foo.php
<?php namespace App\Facades; use Illuminate\Support\Facades\Facade; /** * Class Foo * * @method static \Mockery\MockInterface spy() Convert the facade into a Mockery spy. * @method static \Mockery\MockInterface partialMock() Initiate a partial mock on the facade. * @method static \Mockery\Expectation shouldReceive(string|array ...$methodNames) Initiate a mock expectation on the facade. * @method static void swap($instance) Hotswap the underlying instance behind the facade. * @method static void clearResolvedInstance(string $name) Clear a resolved facade instance. * @method static void clearResolvedInstances() Clear all of the resolved instances. * * @see \App\Services\FooService */ class Foo extends Facade { /** * Get the registered name of the component. * * @return string */ protected static function getFacadeAccessor() { return 'Foo'; } }
Generated: app/Providers/FooServiceProvider.php
<?php namespace App\Providers; use App\Services\FooService; use Illuminate\Support\ServiceProvider; class FooServiceProvider extends ServiceProvider { /** * Register services. * * @return void */ public function register() { $this->app->bind('Foo', FooService::class); } }
Generated: app/Services/FooService.php
<?php namespace App\Services; class FooService { }
and called artisan make:test
to create tests/Feature/FooServiceTest.php
.
Laravel 5.8 to 10.x
You must add a providers and an aliases in config/app.php
.
'providers' => [ App\Providers\FooServiceProvider::class, ], 'aliases' => [ 'Foo' => App\Facades\Foo::class, ],
Laravel 11.x
You must add a providers in bootstrap/providers.php
.
return [ App\Providers\FooServiceProvider::class, ];
and, You must add an aliases in config/app.php
.
'aliases' => [ 'Foo' => App\Facades\Foo::class, ],