Forem: Lucas Lima

Decoupling with Laravel: Binding Interfaces to Implementations Using Service Providers

Lucas Lima — Mon, 03 Feb 2025 14:31:08 +0000

Do you know what are service providers and how they work on Laravel?

In this Article we'll provide a real world example creating an interface and using a service provider to bind it to an implementation.

What is a service provider in Laravel?

According to Laravel's docs:

Service providers are the central place of all Laravel application bootstrapping. Your own application, as well as all of Laravel's core services, are bootstrapped via service providers.

That means all core services on Laravel (Middlewares, Routes, Mailers, queues, etc) are "bootstraped" via service providers.

If you want to learn more about how service providers work, check out Laravel docs, in this tutorial we'll focus on using service providers and interfaces to implement dependency injection, and the adapter pattern.

Real-world example: Interface

So, let's supose you want to create a User Repository class, but you are not sure if you will change your project's ORM in the future.

That's the perfect scenario to use an interface + adapter pattern, right? This way you only create a UserRepository Interface and you can have multiple implementations like EloquentUserRepository, DoctrineUserRepository, PDOUserRepository, etc.

So our Interface would be like this:

interface UserRepository
{
    public function add(UserFormRequest $request): Users;
}

But when you inject the interface on the controller or service layer how do you bind the implementation you want to use to the interface?

Injecting the interface on the controller/service layer:

So, now we have a User controller that receives the UserRepository via Dependency injection, it looks like this:

class UserController extends Controller
{
    public function __construct(private UserRepository $repository)
    {
        // Dependency injection
    }

   public function store(UsersFormRequest $request)
    {
        $serie = $this->repository->add($request);
    }
}

How our application knows that we want specific EloquentUserRepository instead DoctrineUserRepository for example? That's how service provider work their magic.

Binding the interface to the chosen implementation

First, we'll create our service provider using the artisan command: php artisan make:provider UserRepositoryProvider. Now we have a new provider on app\Providers\UserRepositoryProvider.php.

class UserRepositoryProvider extends ServiceProvider
{
    /**
     * Register services.
     *
     * @return void
     */
    public function register()
    {
        $this->app->bind(\App\Repositories\UserRepository::class, \App\Repositories\EloquentUserRepository::class);
    }
}

The register() method will take charge to bind our interface to the chosen implementation (EloquentUserRepository), so in the future, if we want to change this implementation to Doctrine for example, we just need to change on our service provider!

App Config

Lastly, we need to add this provider to our Laravel's app.php config file, so it knows what to do. in app\config\app.php on providers array you will add this line:

App\Providers\UserRepositoryProvider::class,

And that's it! Now you have an interface binded to a real implementation using service providers. That's one use of case to this great feature of laravel, but you can explore more on Laravel docs to discover more possibilities.

Thanks for reading!

Check my new post!

Lucas Lima — Mon, 02 Dec 2024 14:26:47 +0000

Deploying a Laravel Breeze App on Render: Step-by-Step Guide (Part 1)

Lucas Lima ・ Dec 2

Deploying a Breeze Laravel app on Render - part 2

Lucas Lima — Mon, 02 Dec 2024 13:52:23 +0000

Now that we've successfully configured our Laravel app to be published on Render cloud, we'll access the admin panel to configure the environment and finally deploy our application!

First we'll login in our Render account and Create a new project, fill with you project's info:

Now, on our brand new project we'll first create our Postgresql database. Go to + New on top right and click PostgreSQL

After creating our database instance we'll need to copy the internal database URL. Access your database instance and copy it here:

Now we'll create our Web Service instance, on top right click `+ New -> Web Service

Select your laravel project on github

On language select choose Docker

Now, add this environment variables:

Now just click Deploy webservice and see the magic happening!

After that you'll see a success message and receive a link to access your project online, have fun!

Deploying a Laravel Breeze App on Render: Step-by-Step Guide (Part 1)

Lucas Lima — Mon, 02 Dec 2024 12:37:10 +0000

On this tutorial I'll explain how to deploy a laravel app using Breeze starter kit on Render.

Render is a cloud application platform that allows users to perform automated deploys of their projects hosted on any git repository with many features like logs and metrics monitoring, scaling, automating and much more, check out all of their features on this link.

1. Configuring The docker environment

In order to deploy a Laravel app on our render workspace we'll first need to configure a docker environment with a Dockerfile, Nginx conf and a deploy bash script.

2. .Dockerignore

First, we'll need to create our .dockerignore file on the project root folder in order to specify wich files will not be included on the build ṕrocess, so our docker image become lighter.

/node_modules
/public/hot
/public/storage
/storage/*.key
/vendor
.env
.phpunit.result.cache
Homestead.json
Homestead.yaml
npm-debug.log
yarn-error.log

3. Creating the `Dockerfile`

On this step we'll create our dockerfile on the prioject root folder, specifying all the resources that we need to run our laravel app with breeze starter kit

FROM richarvey/nginx-php-fpm:latest
# Certifique-se de que o sistema está pronto para instalar pacotes
USER root
RUN apk update && \
    apk add --no-cache curl nodejs npm && \
    npm install -g npm@latest
COPY . .
# Image config
ENV SKIP_COMPOSER 1
ENV WEBROOT /var/www/html/public
ENV PHP_ERRORS_STDERR 1
ENV RUN_SCRIPTS 1
ENV REAL_IP_HEADER 1

# Laravel config
ENV APP_ENV production
ENV APP_DEBUG false
ENV LOG_CHANNEL stderr

# Allow composer to run as root
ENV COMPOSER_ALLOW_SUPERUSER 1
CMD ["/start.sh"]

On this file, we added this specific instruction:

RUN apk update && \
    apk add --no-cache curl nodejs npm && \
    npm install -g npm@latest

That will allow us to install nodejs on our image in order to run vite, which is included in laravel breeze.

4. Nginx configuration

Now we'll create a directory on our project root folder named conf/nginx and place the following ngix-site.conf file:

server {
  # Render provisions and terminates SSL
  listen 80;
  # Make site accessible from http://localhost/
  server_name _;
  root /var/www/html/public;
  index index.html index.htm index.php;
  # Disable sendfile as per https://docs.vagrantup.com/v2/synced-folders/virtualbox.html
  sendfile off;
  # Add stdout logging
  error_log /dev/stdout info;
  access_log /dev/stdout;
  # block access to sensitive information about git
  location /.git {
    deny all;
    return 403;
  }
  add_header X-Frame-Options "SAMEORIGIN";
  add_header X-XSS-Protection "1; mode=block";
  add_header X-Content-Type-Options "nosniff";
  charset utf-8;
  location / {
      try_files $uri $uri/ /index.php?$query_string;
  }
  location = /favicon.ico { access_log off; log_not_found off; }
  location = /robots.txt  { access_log off; log_not_found off; }
  error_page 404 /index.php;
  location ~* \.(jpg|jpeg|gif|png|css|js|ico|webp|tiff|ttf|svg)$ {
    expires 5d;
  }
  location ~ \.php$ {
    fastcgi_split_path_info ^(.+\.php)(/.+)$;
    fastcgi_pass unix:/var/run/php-fpm.sock;
    fastcgi_index index.php;
    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
    fastcgi_param SCRIPT_NAME $fastcgi_script_name;
    include fastcgi_params;
  }
  # deny access to . files
  location ~ /\. {
    log_not_found off;
    deny all;
  }
  location ~ /\.(?!well-known).* {
    deny all;
  }
}

5. Build sh script

Finally, on our project root folder we'll create a scripts directory and inside a sh build script named 00-laravel-deploy.sh used by render to run bootstrap laravel commands like migrations, composer install and also ou npm commands, needed by vite.

#!/usr/bin/env bash
echo "Running composer"
composer global require hirak/prestissimo
composer install --no-dev --working-dir=/var/www/html
echo "Caching config..."
php artisan config:cache
echo "Caching routes..."
php artisan route:cache
echo "Running npm install..."
npm install
echo "Running npm build..."
npm run build
echo "Running migrations..."
php artisan migrate --force

6. Oops, I almost forgot

There's a configuration in Laravel app Service provider so our app can run using https, let's add in to our app/Providers/AppServiceProvider.php file:

namespace App\Providers;

use Illuminate\Routing\UrlGenerator;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    // ...

    public function boot(UrlGenerator $url)
    {
        if (env('APP_ENV') == 'production') {
            $url->forceScheme('https');
        }
    }
}

Push to a github repository

Now, we have to push this project to a github repository, and in the next part of this tutorial we'll access Render admin panel and run our application on the cloud!

Part 2

How to Use Vultr Object Storage with Laravel (S3-Compatible)

Lucas Lima — Mon, 25 Nov 2024 15:07:20 +0000

First steps

In this tutorial I assume that you have already prepared your Laravel project environment and have begginer/intermediate knowledge in PHP/Laravel.

First of all, we need to prepare our object storage environment on Vultr's admin panel. If you don't have a Vultr account just create one here. As soon as you have created your account you'll need to create an object storage and then a bucket. For this tutorial focus on how to implement this feature on Laravel i'll just skip this steps and leave a link wich explain all of them here.

1. Installing required packages

To achieve our goal, we need to install flysystem. Flysystem is a well-known file storage library for PHP, it supports many filesystems and provides interfaces for all of them. In our case we'll specifically use aws-s3 but if you want to know more about the library feel free to visit their official documentation page here

composer require league/flysystem-aws-s3-v3

2. Configuration on Laravel

After we've successfully installed our dependency we need now to communicate Laravel that we have a new filesystem and it's credentials.

In config\filesystems.php on disks array you'll add the following:

'vultr' => [  
'driver' => 's3',  
'key'=> env('VULTR_ACCESS_KEY'),  
'secret' => env('VULTR_SECRET_KEY'),  
'region' => env('VULTR_REGION'),  
'bucket' => env('VULTR_BUCKET'),  
'endpoint' => env('VULTR_ENDPOINT'),  
],

obs: You can obtain all this information in vult's panel on object storage section.

3. Environment variables

Now we need to add our credentials to .env to authenticate and execute the proper functions.

VULTR_ACCESS_KEY=youraccesskey  
VULTR_SECRET_KEY=yoursecretkey  
VULTR_REGION=sjc1  
VULTR_BUCKET=yourbucket  
VULTR_ENDPOINT=https://sjc1.vultrobjects.com

4. And Voilà!

Now we can just call our storage class specifying the previously configured vultr disk:

Storage::disk('vultr')->putFile('uploads', request()->file, 'public');

Now we can perform all object storage action within our laravel application!

References

https://laravel.com/docs/11.x/filesystem
https://ecwebservices.medium.com/how-to-use-vultr-object-storage-with-laravel-8-a21256f1b4a1

Forem: Lucas Lima

Decoupling with Laravel: Binding Interfaces to Implementations Using Service Providers

What is a service provider in Laravel?

Real-world example: Interface

Injecting the interface on the controller/service layer:

Binding the interface to the chosen implementation

App Config

Check my new post!

Deploying a Laravel Breeze App on Render: Step-by-Step Guide (Part 1)

Lucas Lima ・ Dec 2

Deploying a Breeze Laravel app on Render - part 2

Deploying a Laravel Breeze App on Render: Step-by-Step Guide (Part 1)

1. Configuring The docker environment

2. .Dockerignore

3. Creating the Dockerfile

4. Nginx configuration

5. Build sh script

6. Oops, I almost forgot

Push to a github repository

How to Use Vultr Object Storage with Laravel (S3-Compatible)

First steps

1. Installing required packages

2. Configuration on Laravel

3. Environment variables

4. And Voilà!

References

3. Creating the `Dockerfile`