bolivir/laravel-doctrine-sanctum

Laravel doctrine integration for the official laravel-sanctum package

5.0.0 2025-02-24 10:19 UTC

Requires

• php: ^8.2
• ext-json: *
• laravel-doctrine/orm: ^3.0.0
• laravel/sanctum: ^v4.0
• ramsey/uuid-doctrine: ^2.0.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.18 || ^3.0
• orchestra/testbench: ^v9.2.0
• phpstan/phpstan: ^1.0.0
• phpstan/phpstan-doctrine: ^1.0.0
• phpunit/phpunit: ^11.3.0
• rector/rector: ^1.2.2

MIT

• Ricardo Mosselman

README

The original Laravel Sanctum works via eloquent, this package makes it work with laravel-doctrine/orm package (https://github.com/laravel-doctrine/orm)

Versions

Version	Supported Sanctum Version	Supported Laravel-Doctrine ORM Version
~1.0	^2.0	^1.0
~2.0	^2.0	^2.0
~3.0	^3.0	^2.0
~4.0	^4.0	^2.0
~5.0	^4.0	^3.0

Installation

Start by installing the package with the following command:

composer require "bolivir/laravel-doctrine-sanctum"

To publish the config use:

php artisan vendor:publish --tag="config" --provider="Bolivir\LaravelDoctrineSanctum\LaravelDoctrineSanctumProvider"

Configuration / Setup

Creating the Access Token Model

Start by creating your accessTokenModel, and implement the interface IAccessToken.

class AccessToken implements IAccessToken
{
    use TAccessToken;
}

You can use the Trait TAccessToken or just implement the interface by your self.

class AccessToken implements IAccessToken
{
      protected string $id;
    
      protected string $name;
    
      protected string $token;
        
      .......
      .......
}

Updating the UserModel

Your user model should implement the interface ISanctumUser. You dont need to implement the Authenticable on your user model directly, it is required inside the ISanctumUser Now you can choose to use the trait TAccessToken or implement the interface yourself.

Creating the database table

Laravel sanctum uses the database to store the access tokens. There are multiple options available to generate the database table sql

• If you are using laravel migrations, run migrations:diff after the creation of your model and metadata (xml). Then execute the migration with migrations:migrate

Ready to use

Implement your login logic and start creating access tokens on succesfull login.

class MyLoginService
{       
      .......
      .......
      public function login() 
      {
        ....
        ....
        $accessToken = $this->tokenRepository->createToken($user, 'tokenName');
      }
}

See the WIKI for more detailed steps.

https://github.com/bolivir/laravel-doctrine-sanctum/wiki