Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[11.x] Add support for installing Laravel passport on install:api artisan command #50386

Merged
merged 3 commits into from
Mar 6, 2024
Merged

[11.x] Add support for installing Laravel passport on install:api artisan command #50386

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b29f4fc
add passport installation to `install:api` command
hafezdivandari Mar 6, 2024
352caeb
formatting
hafezdivandari Mar 6, 2024
a3651f3
formatting
taylorotwell Mar 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 40 additions & 7 deletions src/Illuminate/Foundation/Console/ApiInstallCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,15 @@ class ApiInstallCommand extends Command
*/
protected $signature = 'install:api
{--composer=global : Absolute path to the Composer binary which should be used to install packages}
{--force : Overwrite any existing API routes file}';
{--force : Overwrite any existing API routes file}
{--passport : Install Laravel Passport instead of Laravel Sanctum}';

/**
* The console command description.
*
* @var string
*/
protected $description = 'Create an API routes file and install Laravel Sanctum';
protected $description = 'Create an API routes file and install Laravel Sanctum or Laravel Passport';

/**
* Execute the console command.
Expand All @@ -36,7 +37,11 @@ class ApiInstallCommand extends Command
*/
public function handle()
{
$this->installSanctum();
if ($this->option('passport')) {
$this->installPassport();
} else {
$this->installSanctum();
}

if (file_exists($apiRoutesPath = $this->laravel->basePath('routes/api.php')) &&
! $this->option('force')) {
Expand All @@ -46,14 +51,30 @@ public function handle()

copy(__DIR__.'/stubs/api-routes.stub', $apiRoutesPath);

if ($this->option('passport')) {
(new Filesystem)->replaceInFile(
'auth:sanctum',
'auth:api',
$apiRoutesPath,
);
}

$this->uncommentApiRoutesFile();
}

if ($this->confirm('One new database migration has been published. Would you like to run all pending database migrations?', false)) {
$this->call('migrate');
}
if ($this->option('passport')) {
$this->call('passport:install', [
'--uuids' => $this->confirm('Would you like to use UUIDs for all client IDs?'),
]);

$this->components->info('API scaffolding installed. Please add the [Laravel\Sanctum\HasApiTokens] trait to your User model.');
$this->components->info('API scaffolding installed. Please add the [Laravel\Passport\HasApiTokens] trait to your User model.');
} else {
if ($this->confirm('One new database migration has been published. Would you like to run all pending database migrations?', false)) {
$this->call('migrate');
}

$this->components->info('API scaffolding installed. Please add the [Laravel\Sanctum\HasApiTokens] trait to your User model.');
}
}

/**
Expand Down Expand Up @@ -111,4 +132,16 @@ protected function installSanctum()
]);
}
}

/**
* Install Laravel Passport into the application.
*
* @return void
*/
protected function installPassport()
{
$this->requireComposerPackages($this->option('composer'), [
'laravel/passport:^12.0',
]);
}
}
Loading