Laravel wrapper for the Strapi headless CMS

Laravel-Strapi is a Laravel wrapper for the Strapi headless CMS.

Requirements

PHP ^8.2
Laravel ^9 || ^10
Strapi ^4

Note: to support Strapi v3.x use Laravel-Strapi v2.x.

Installation

1) Install the package via composer:

composer require dbfx/laravel-strapi

2) Publish the file config/strapi.php with:

php artisan vendor:publish --provider="Dbfx\LaravelStrapi\LaravelStrapiServiceProvider" --tag="strapi-config"

3) Define this mandatory configuration value in your .env file:

STRAPI_URL=https://api.example.com

Note: do not use /api at the end of STRAPI_URL.

Optionally you can also define these values:

STRAPI_TOKEN=abcd1234abcd1234
STRAPI_CACHE_TIME=3600
STRAPI_FULL_URLS=false

Note: do not include Bearer in STRAPI_TOKEN, only the token itself.

Usage

Laravel-Strapi provides these usefull methods:

// returns collection-types rows by `$name`
$strapi->collection(string $name, array $queryParams = [], bool $fullUrls = null, int $cacheTime = null);

// returns collection-types row by `$name` and `$id`
$strapi->entry(string $name, int $id, array $queryParams = [], bool $fullUrls = null, int $cacheTime = null);

// returns single-types values by `$name`
$strapi->single(string $name, array $queryParams = [], bool $fullUrls = null, int $cacheTime = null);

These are all the available parameters:

$name (string): name of the collection-types (e.g. blogs) or single-types (e.g. homepage)
$id (int): id of a collection-types entry
$queryParams (array): optional array of key-value pairs of REST API parameters (see here https://docs.strapi.io/dev-docs/api/rest/parameters)
$fullUrls (bool): optional boolean value to override the global value defined in STRAPI_FULL_URLS per-call
$cacheTime (int): optional value in seconds to override the global value defined in STRAPI_CACHE_TIME per-call

Examples

use Dbfx\LaravelStrapi\LaravelStrapi;

$strapi = new LaravelStrapi();

// returns the first 25 rows of the collection-types `blogs`
// sorted in descending order by `id`
$rows = $strapi->collection('blogs');

// same thing as before, but in `en` language,
// sorted descending by field `date` and ascending by field `title`
// and with population of nested collection-types `author` and `images`
$rows = $strapi->collection('blogs', [
    'locale' => 'en',
    'sort' => [
        'date:desc',
        'title:asc',
    ],
    'populate' => [
        'author',
        'images',
    ],
]);

// similar to before, but with pagination by page values
$rows = $strapi->collection('blogs', [
    'pagination' => [
        'page' => 2,
        'pageSize' => 50,
    ],
]);

// similar to before, but with pagination by offset values
$rows = $strapi->collection('blogs', [
    'pagination' => [
        'start' => 0,
        'limit' => 100,
    ],
]);

// returns all rows of the collection-types `blogs`
// where field `slug` is equal to `test-blog-post`
$rows = $strapi->collection('blogs', [
    'filters' => [
        'slug' => [
            '$eq' => 'test-blog-post',
        ],
    ],
    'pagination' => [
        'start' => 0,
        'limit' => 1,
    ],
]);

// returns the row of the collection-types `blogs`
// where field `id` is `1`
$row = $strapi->entry('blogs', 1);

// returns all values of the single-types `homepage`
$rows = $strapi->single('homepage');

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

frugan-dev/laravel-strapi