How to add a controller to the package?

[JTD420]

Sorry for what's probably a very nooby question but I've looked online and read over the documentation and can't seem to find the answer!
How can I add a controller to my package that's published with the install command and added to the users App\Http\Controllers namespace?

[freekmurze]

You can just create a class anywhere you want for that. Usually, I pick src/Http/Controllers/

To learn more about package development, take a look at our course: https://laravelpackage.training

[askdkc]

@JTD420 Usually you don’t need to publish your view files unless you want to customize them.

But your package needs routes in order to show that view files.

For example:
In your ServiceProvider

$package
    ->name('urpackage')
    ->hasViews()
    ->hasRoute('web');

In your resources/views/index.blade.php

<h1>whatever</h1>

In your route/web.php

Route::get('/urpackage', function () {
    return view('urpackage::index');
});

Now install this package and access to URL/urpackage
Then you will see ‘whatever’.

If your package must need to publish view files, you should create package like Laravel Breeze which has breeze:install command that does it all. Still you need to run some command to publish your view files though.

[JTD420]

Hi @askdkc, thanks for the information and detailed response!

I did some digging and found that the routes are indeed being registered after installing the package in a test Laravel app. However, it appears that they are not being added to the main Routes/Web.php file. Upon running the command php artisan route:list, it confirms that the routes are registered.

Do you know if there is a further step required to publish the routes, so that they can be modified by users? Additionally, do you have any insight on what needs to be done in order to publish the controllers as well, and why the service provider is not automatically registering in the app.php file?

This is my current ServiceProvider code, which is successfully publishing the configuration and migration files. I am grateful for any assistance you may be able to provide!

<?php

namespace JTD420\PGP;

use Illuminate\Support\Facades\Route;
use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Commands\InstallCommand;
use JTD420\PGP\Commands\PGPCommand;
use JTD420\PGP\Http\Controllers\PGPController;

class PGPServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        /*
         * This class is a Package Service Provider
         *
         * More info: https://github.com/spatie/laravel-package-tools
         */
        $package
            ->name('PGP')
            ->hasConfigFile()
            ->hasViews()
            ->hasMigration('create_pgp_keys_table')
            ->hasMigration('create_pgp_messages_table')
            ->hasRoute('web')
            ->hasCommand(PGPCommand::class)
            ->hasInstallCommand(function (InstallCommand $command) {
                $command
                    ->publishConfigFile()
                    ->publishMigrations()
                    ->askToRunMigrations()
                    ->copyAndRegisterServiceProviderInApp()
                    ->askToStarRepoOnGitHub('JTD420/Laravel-PGP');
            });
    }
}

[askdkc]

@JTD420

However, it appears that they are not being added to the main Routes/Web.php file.

That’s expected behavior of the package.
If you want to publish everything and use them as a skeleton, then you should create something similar to Laravel Breeze.

Example from Laravel Breeze

• publishing controllers
  https://github.com/laravel/breeze/blob/c1b5986ed813eebc236de8c4ac51fe1e5b7b66d3/src/Console/InstallsBladeStack.php#L30

• publishing views
  https://github.com/laravel/breeze/blob/c1b5986ed813eebc236de8c4ac51fe1e5b7b66d3/src/Console/InstallsBladeStack.php#L38

• publishing routes
  https://github.com/laravel/breeze/blob/c1b5986ed813eebc236de8c4ac51fe1e5b7b66d3/src/Console/InstallsBladeStack.php#L56-L57

Hopefully that helps 😉

[JTD420]

@askdkc, Ohhh! That makes so much sense now! Thank you for your help. This information was exactly what I needed and has been extremely helpful!! 🙌 :D

[askdkc]

@JTD420

My pleasure. Glad to hear.

[JTD420]

Link to answer