cerpus/cerpushelper

Base package for common components

v2.2.0 2023-03-15 09:34 UTC

Requires

• php: ^8.0
• ext-json: *
• auth0/auth0-php: ^8.4
• cerpus/cerpusauthlib-core: ^0.0
• guzzlehttp/guzzle: ^6.0|^7.0
• guzzlehttp/oauth-subscriber: ^0.6.0
• illuminate/support: ^8.0|^9.0|^10.0
• kamermans/guzzle-oauth2-subscriber: ^1.0

Requires (Dev)

• fakerphp/faker: ^1.16
• mockery/mockery: ^1.0
• phpunit/phpunit: ^9.5

GPL-3.0-only

• Thomas Horn Sivertsen
• Odd-Arne Johansen

README

This package contains some useful and common helper utilities for use in Laravel based projects.

Installation

$ composer require cerpus/cerpushelper

Models/Traits/UuidAsId

Let you use the primary key as UUID not the default auto incrementing value

Usage

In your model

namespace App;

use Cerpus\Helper\Models\Traits\UuidAsId;

...

class MyModel extends Authenticatable
{
    use UuidAsId;

    ...

Middleware/RequestId

Handle RequestId. Pick RequestId from request header and if that does not exist generate a new RequestId.

Adds the RequestId to response headers.

Include the RequestId when logging and requests to other systems to easily trace requests through different systems.

Installation

In the global middleware of your app app/Http/Kernel.php

  use Cerpus\Helper\Middleware\RequestId;
  ...
  protected $middleware = [
        RequestId::class,
        ...
    ];

You can also put it in front of API endpoints and the like to fine tune better.

Usage

To access the requestId in your app

$requestId = app("requestId")

Profile

Can support simple profiles in Laravel by adding subdirectories in the config folder and name it with the profile name as folder name. Add the config files(or only parts of it) in the profile folder to override the default values. The name of the files must be identical to the one you want to override.

|-- config
    |-- myprofile
        |-- setting.php
    |-- setting.php

Then import the "profile" function in the namespace area to use the logic.

use function Cerpus\Helper\Helpers\profile as config;

This will use the profile values, if found, instead of the default config values.

Will look for 'app.deploymentEnvironment' in app.php if the function is not provided with a profile

Releases

1.5.0 Updated to use auth0/auth0-php v7.5

License

This package is released under the GNU General Public License 3.0. See the LICENSE file for more information.