Forem: faisal ahmed

Laravel 11 : Custom package does not generate CSRF token.

faisal ahmed — Wed, 08 May 2024 13:31:02 +0000

I encountered this problem while trying to generate csrf token in form on a laravel 11 based custom package.

The routes in my custom package already included the default web middleware but still it was not generating the needed csrf token for routes and views which belonged to the custom laravel package.

The solution was to include StartSession and VerifyCsrfToken middleware manually inside the app.php file to be used as a global middleware.

<?php

use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )
    ->withMiddleware(function (Middleware $middleware) {
        $middleware->append(\Illuminate\Session\Middleware\StartSession::class);
        $middleware->append(\Illuminate\Foundation\Http\Middleware\VerifyCsrfToken::class);
    })
    ->withExceptions(function (Exceptions $exceptions) {
        //
    })->create();

Loading custom laravel packages locally

faisal ahmed — Mon, 28 Aug 2023 14:06:38 +0000

I normally store my locally developed packages inside the packages folder in my laravel projects root.

To ensure your core laravel application recognizes these customer packages we have to update our main composer.json file and add the following line :-

    "repositories": [
        {
          "type": "path",
          "url": "packages/thephpx/*"
        }
    ]

Notice I have used * in the package url, that is because i want composer to load all available packages inside the packages folder with the given namespace.

Custom Packages:

Before creating any new custom package I create my namespace folder first inside the packages folder. In my case it's thephpx folder.

Then i create the package folder inside the namespace folder. For example if I am creating a demo package, I will create a demo folder inside the thephpx folder and then create a composer.json file inside the demo folder.

The composer.json file content looks as follows:

{
    "name": "guestguide/demo",
    "type": "library",
    "description": "Demo package from thephpx",
    "license": "MIT",
    "autoload": {
        "psr-4": {
            "Guestguide\\Demo\\": "src/"
        }
    },
    "authors": [
        {
            "name": "Faisal Ahmed",
            "email": "thephpx@gmail.com"
        }
    ],
    "extra": {
        "laravel": {
            "providers": [                "Thephpx\\Demo\\DemoServiceProvider"
            ]
        }
    },
    "require-dev": {
        "orchestra/testbench": "^8.0"
    }
}

Once the composer.json file is created, then I create the src folder and inside the src folder create Http\Controllers folder. In a custom package the src folder can have same folders as there are in the core laravel applications app folder.

Also inside the src folder I create the DemoServiceProvider.php class. Which is the custom service provider class for this custom package.

The content of the DemoServiceProvider.php class is as follows:

<?php

namespace Thephpx\Dashboard;

use Illuminate\Support\ServiceProvider;

class DemoServiceProvider extends ServiceProvider
{
  public function register()
  {
    //
  }

  public function boot()
  {
    //
    $this->loadRoutesFrom(__DIR__.'/../routes/web.php');

    $this->loadViewsFrom(__DIR__.'/../resources/views', 'dashboard');

    if ($this->app->runningInConsole()) {
      $this->publishes([
        __DIR__.'/../resources/assets' => public_path('dashboard'),
      ],'assets');
    }
  }
}

Then, I go on to create the other related folders such as \resources\views, \resources\assets, routes etc.

Inside the routes folder I then create web.php route file. The content of the file is as follows:

<?php

use Illuminate\Support\Facades\Route;

Route::group(['middleware'=>'web'], function () {
    Route::get('/demo', \Thephpx\Demo\Http\Controllers\DemoController::class)->middleware('auth');
});

Note: here in the web.php I have used web middleware which never had to be mentioned explicitly in the core laravel web.php route file. But, in order for your package to get session data you need to include it in your package route file. Otherwise auth() helper or other Auth related methods does not work as expected.

Once everything is in place run composer install inside the package folder where you have created it's own composer.json file and install the required testbench library. Now you are ready to start developing your custom package.

This is suppose to be a basic startup document for further in-depth details you can visit https://www.laravelpackage.com/

Auto translate page based on subdomain in a Laravel application

faisal ahmed — Mon, 21 Aug 2023 13:08:15 +0000

Scenario:
I have a web application which is mainly built in english but the client required a functionality where the the website could be loaded in multiple subdomains based on country. For example; the main website is at www.domain.com which will show content in english but if the website is accessed in bd.domain.com then the same english content needed to be translated seamlessly using google translate.

Solution:
I have already created a writeup where I toggled laravel locale based on subdomain by identifying the subdomain in AppServiceProvider. As an extension to that work I also introduced two variables that got passed to all available views using view::share() method. The resulting code looks something like this -

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\View;
class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        //
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        if(!empty($_SERVER['HTTP_HOST'])){
            //subdomain specific locale
            $subdomain = current(explode('.', $_SERVER['HTTP_HOST']));

            if (in_array($subdomain, ["www","in"])) {
                if($subdomain !== 'www'){
                    app()->setLocale($subdomain);
                    config('app.url',$subdomain.'.domain.com');
                    View::share('translate',true);
                    if($subdomain == 'in') View::share('translate_lang','hi');
                    if($subdomain == 'bd') View::share('translate_lang','bn');                    
                } else {
                    app()->setLocale('en');
                    config('app.url','www.domain.com');
                    View::share('translate',false);
                    View::share('translate_lang','en');
                }            
            } else {
                app()->setLocale('en');
                config('app.url','www.domain.com');
            }
        }
    }
}

This meant now I had two variable available which I could check in the blade templates to load the google translate JavaScript code block and initialize the translation on page load. The blade layout file looked as follows -

   <html>
    <head>
    </head>
    <body>
      @if($data['translate'] == true)<div id="google_translate_element" style="display:none;"></div>@endif
      <div class="container">
        <p>Your content goes here.</p>
      </div>
      @if(view()->shared('translate') == true)
      <script type="text/javascript">
      function setCookie(key, value, expiry) {
          var expires = new Date();
          expires.setTime(expires.getTime() + (expiry * 24 * 60 * 60 * 1000));
          document.cookie = key + '=' + value + ';expires=' + expires.toUTCString();
      }

      function googleTranslateElementInit() {
          setCookie('googtrans', '/en/{{view()->shared("translate_lang")}}',1);
          new google.translate.TranslateElement({
              pageLanguage: 'en'
          }, 'google_translate_element');
      }
      </script>
      <script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit">
      </script>
      @endif
    </body>
  </html>

So, now when the website is accessed via www.domain.com it loads the regular english language content but if the same page is visited via bd.domain.com then the same english content is translated to bengali language on page load. Further more; if there are certain content that needs to be loaded using local language file that also works as laravel sets the local to appropriate language based on subdomain.

Laravel subdomain specific locale

faisal ahmed — Mon, 21 Aug 2023 13:03:10 +0000

I needed to change the locale of one of my laravel based projects based on the subdomain. The setup was as follows -

www.domain.com (en)
de.domain.com (de)
es.domain.com (es)

I implemented the following inside AppServiceProvider to get the job done:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        //
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        //subdomain specific locale
        $subdomain = current(explode('.', $_SERVER['HTTP_HOST']));

        if (in_array($subdomain, ["www","fr","de"])) {
            if($subdomain !== 'www'){
                app()->setLocale($subdomain);
                config('app.url',$subdomain.'.domain.com');
            } else {
                app()->setLocale('en');
                config('app.url','www.domain.com');
            }            
        } else {
            app()->setLocale('en');
            config('app.url','www.domain.com');
        }
    }
}

Hope this helps someone in future!