How to Build Laravel Package Using Composer.pdf

How to Build
Laravel
Package
Using
Composer?
https://www.bacancytechnology.com

A Laravel package is a set of reusable classes
that improve the functionality of a Laravel
website. To put it another way, a package is
what WordPress plugins are. Laravel
packages are designed to reduce
development time by encapsulating
reusable functionality in a set of stand-
alone classes that can be used in any Laravel
project.

In this tutorial: How to Build Laravel
Package using Composer, we’ll construct a
Laravel package for a contact form. Let’s get
this party started.

Prerequisite to
Build Laravel
Package using
Composer

Laravel v 5.5 or above is required.
Composer installed on your system. You
may get Composer here if you don’t
already have it.
Here are the prerequisites to build Laravel
package using Composer:

Because a package is designed to give more
functionality to a Laravel website, the first
step is to construct a Laravel website. We’ll
use Composer to set it up. Check out the
official Laravel documentation for more
installation options.
$ composer create-project —prefer-dist
laravel/laravel packagetestapp
You’ll need to configure your env file and
specify your app key and other relevant
data after that’s done. Use the following
command in your terminal or manually
transfer the contents of the .env.example to
a new file and save it as .env.
$ cp .env.example .env

$ php artisan key:generate
Once done, use the below command.
Your .env should look like this once you’ve
generated your app key and configured
your database details

Our basic Laravel app is now set up. It’s
time to start working on our package.
Develop high-performance Laravel
applications with Bacancy!
Hire Laravel Developer and witness the
building of your dream product with us. We
have dedicated developers with
extraordinary problem skills. Contact us
today!

Manually generating individual files and
folders
Utilizing a package such as this CLI
utility.
We’ll set up the fundamental essentials of
our package. There are essentially two
methods for accomplishing this:

Here, we will manually generate the files
and directories to understand how each
component fits together.

Here is our package’s folder structure.

Create folders with the following structure
from your root directory.

$ packages/YourVendor/YourPackage/

Because it’s not a good practice to update
the code in the vendor folder, we’ll perform
all of our work outside in the
packages/YourVendor/YourPackage/
directory instead of
vendor/YourVendor/YourPackage/.

When we’re finished releasing our package,
it’ll be available for download under the
vendor folder.

YourVendor is the name of the vendor,
which might be your name or the name of
the customer or business for whom you are
generating the package
.
The package name is represented by
YourPackage. It will be contactform in our
instance.
Let’s begin creating the files and folders
that will comprise our package.

YourVendor
└──contactform
└──src
├──Database
│ └──migrations
├──Http
│ └──controllers
├──Models
├──resources
│ └──views
└──routes

We’ll initialize the Composer now. Use the
below command to generate composer.json
$ composer init
Because it is interactive, it will ask you a
series of questions to fill up your
composer.json file. If you’re unsure, click
enter to use the default response; if you’re
not sure, you may update it later directly
from the composer.json file.
The composer.json file should now look like
this.

{
"name": "YourVendor/Contactform",
"description": "A contact form package
for laravel",
"authors": [{
"name": "Usama Patel",
"email": "john.doe@email.com"
}],
"require": {}
}

We need to inform composer.json to
autoload our files, so add this code to your
composer.json.
"autoload": {
"psr-4": {
"YourVendorcontactform": "src/"
}
}

Our composer.json file should now look
something like this.
{
"name": "YourVendor/Contactform",
"description": "A contact form package
for laravel",
"authors": [{
"name": "Usama Patel",
"email": "john.doe@email.com"
}],
"require": {},
"autoload": {
"psr-4": {
"YourVendorContactform": "src/"
}
}
}

Create an empty git repository to keep
track of modifications after that (we’ll add
the remote repo later). Use the below
command.
$ git init

Let’s start by adding some files to our
package. To begin, we must identify a
service provider for our package. Laravel
utilizes a service provider to figure out
which files will be loaded and accessible by
your package.
Create a ContactFormServiceProvider.php
file in your src/subdirectory
$ src/ContactFormServiceProvider.php
We need to define a few items within our
service provider:
1. The namespace (which we defined in
our composer.json autoload).
2. The extension (the Laravel class which
our service provider extends)
3. The two mandatory methods that every
service provider must have (at least two
methods are required for every Laravel
package service provider: boot() and
register()).

Add the following lines of code to your
service provider class.
Note: You may replace YourVendor with
your own vendor name in the code below.

// ContactFormServiceProvider.php

<?php namespace
YourVendorcontactform; use
IlluminateSupportServiceProvider; class
ContactFormServiceProvider extends
ServiceProvider { public function boot() { }
public function register() { } } ?>

We need to inform Laravel how to load our
package and utilize its functionalities
because we haven’t deployed it and it isn’t
yet within our vendor folder, so inside the
root of your Laravel project in the
composer. Add the following code to your
JSON.
"autoload": {
"classmap": [
"database/seeds",
"database/factories"
],
"psr-4": {
"YourVendorContactform":
"packages/YourVendor/contactform/src",
"App": "app/"
}

},
"autoload-dev": {
"psr-4": {
"YourVendorContactform":
"packages/YourVendor/contactform/src",
"Tests": "tests/"
}
},

Depending on your Laravel version, Laravel
may add it for you automatically. If it does,
be sure to skip it.
Then, on your terminal, run the following
command at the root of your app.
$ composer dump-autoload

Let’s check to verify if our package is loaded
appropriately now. Let’s create a route and
load it in the startup method of the
ContactFormServiceProvider.php file
// ContactFormServiceProvider.php
$this-
>loadRoutesFrom(__DIR__.'/routes/web.
php');
The current directory where the file is
located is referred to as __DIR__.
The routes folder we’ll construct for our
package, which will exist in our src
folder, not the default Laravel routes, is
referenced in routes/web.php.
Please take notice of the following:

Add the following code to the web.php file
in our package routes folder.
<?php //
YourVendorcontactformsrcroutesweb.
php Route::get('contact', function(){ return
'Hello from the contact form package'; }); ?
>
Then, in our root config/app.php, we need
to add our new service provider to the
providers’ array as shown below.

// config/app.php
'providers' => [
...,
AppProvidersRouteServiceProvider::cla
ss,
// Our new package class
YourVendorContactformContactFormS
erviceProvider::class,
],

php artisan serve
Start your Laravel app now by using the
command.
Go to localhost:8000/contact in your
browser and you should see something
like this:
You might want to know
Top Laravel Packages To Install

Github
Repository:
Laravel Package
Example

Now we know our package is loading
properly we need to create our contact
form. You can find the rest of the code on
this Github Repository.

Conclusion
This was a basic tutorial to get started with
how can you build Laravel package using
Composer. With your newfound
understanding, you can create even more
amazing packages.

Thank you
https://www.bacancytechnology.com

How to Build Laravel Package Using Composer.pdf

More Related Content

Similar to How to Build Laravel Package Using Composer.pdf

Similar to How to Build Laravel Package Using Composer.pdf (20)

More from Katy Slemon

More from Katy Slemon (20)

Recently uploaded

Recently uploaded (20)

How to Build Laravel Package Using Composer.pdf