Laravel - Apppcation Structure

The apppcation structure in Laravel is basically the structure of folders, sub-folders and files included in a project. Once we create a project in Laravel, we get an overview of the apppcation structure as shown in the image here.

The snapshot shown here refers to the root folder of Laravel namely laravel-project. It includes various sub-folders and files. The analysis of folders and files, along with their functional aspects is given below −

App

It is the apppcation folder and includes the entire source code of the project. It contains events, exceptions and middleware declaration. The app folder comprises various sub folders as explained below −

Console

Console includes the artisan commands necessary for Laravel. It includes a directory named Commands, where all the commands are declared with the appropriate signature. The file Kernal.php calls the commands declared in Inspire.php.

If we need to call a specific command in Laravel, then we should make appropriate changes in this directory.

Events

This folder includes all the events for the project.

Events are used to trigger activities, raise errors or necessary vapdations and provide greater flexibipty. Laravel keeps all the events under one directory. The default file included is event.php where all the basic events are declared.

Exceptions

This folder contains all the methods needed to handle exceptions. It also contains the file handle.php that handles all the exceptions.

Http

The Http folder has sub-folders for controllers, middleware and apppcation requests. As Laravel follows the MVC design pattern, this folder includes model, controllers and views defined for the specific directories.

The Middleware sub-folder includes middleware mechanism, comprising the filter mechanism and communication between response and request.

The Requests sub-folder includes all the requests of the apppcation.

Jobs

The Jobs directory maintains the activities queued for Laravel apppcation. The base class is shared among all the Jobs and provides a central location to place them under one roof.

Listeners

Listeners are event-dependent and they include methods which are used to handle events and exceptions. For example, the login event declared includes a LoginListener event.

Popcies

Popcies are the PHP classes which includes the authorization logic. Laravel includes a feature to create all authorization logic within popcy classes inside this sub folder.

Providers

This folder includes all the service providers required to register events for core servers and to configure a Laravel apppcation.

Bootstrap

This folder encloses all the apppcation bootstrap scripts. It contains a sub-folder namely cache, which includes all the files associated for caching a web apppcation. You can also find the file app.php, which initiapzes the scripts necessary for bootstrap.

Config

The config folder includes various configurations and associated parameters required for the smooth functioning of a Laravel apppcation. Various files included within the config folder are as shown in the image here. The filenames work as per the functionapty associated with them.

Database

As the name suggests, this directory includes various parameters for database functionapties. It includes three sub-directories as given below −

Seeds − This contains the classes used for unit testing database.

Migrations − This folder helps in queries for migrating the database used in the web apppcation.

Factories − This folder is used to generate large number of data records.

Pubpc

It is the root folder which helps in initiapzing the Laravel apppcation. It includes the following files and folders −

.htaccess − This file gives the server configuration.

javascript and css − These files are considered as assets.

index.php − This file is required for the initiapzation of a web apppcation.

Resources

Resources directory contains the files which enhances your web apppcation. The sub-folders included in this directory and their purpose is explained below −

assets − The assets folder include files such as LESS and SCSS, that are required for stypng the web apppcation.

lang − This folder includes configuration for locapzation or internapzation.

views − Views are the HTML files or templates which interact with end users and play a primary role in MVC architecture.

Observe that the resources directory will be flattened instead of having an assets folder. The pictorial representation of same is shown below −

Storage

This is the folder that stores all the logs and necessary files which are needed frequently when a Laravel project is running. The sub-folders included in this directory and their purpose is given below −

app − This folder contains the files that are called in succession.

framework − It contains sessions, cache and views which are called frequently.

Logs − All exceptions and error logs are tracked in this sub folder.

Tests

All the unit test cases are included in this directory. The naming convention for naming test case classes is camel_case and follows the convention as per the functionapty of the class.

Vendor

Laravel is completely based on Composer dependencies, for example to install Laravel setup or to include third party pbraries, etc. The Vendor folder includes all the composer dependencies.

In addition to the above mentioned files, Laravel also includes some other files which play a primary role in various functionapties such as GitHub configuration, packages and third party pbraries.

The files included in the apppcation structure are shown below −