karriereat / state by fetzi

Laravel package for storing current application state in cache/session
14,527
17
4
Package Data
Maintainer Username: fetzi
Maintainer Contact: alexander.lentner@karriere.at (Alexander Lentner)
Package Create Date: 2016-11-24
Package Last Update: 2024-02-27
Home Page: https://packagist.org/packages/karriere/state
Language: PHP
License: Apache-2.0
Last Refreshed: 2024-11-22 03:13:17
Package Statistics
Total Downloads: 14,527
Monthly Downloads: 213
Daily Downloads: 11
Total Stars: 17
Total Watchers: 4
Total Forks: 1
Total Open Issues: 0

    Build Status Codecov StyleCI SensioLabs Insight Packagist Packagist Downloads

State package for Laravel

This laravel package allows to store a certain application state in either the session or inside a cache.

Installation

Run composer require karriere/state to install this package.

Usage

To enable the package you need to reference the StoreServiceProvider class inside your config/app.php file in the providers section:

'providers' => [
    ...
    Karriere\State\StateServiceProvider::class,
    ...
];

To store the application state you create a state object and store it:

$state = $stateFactory->build('state-name', ['key' => 'value']);
$store->put($state);

// pass on $state->identifier()

In a later situation where you have the state identifier you can access the states data by:

$state = $store->get($identifier);

if(!$state->isEmpty()) {
  // use either $state->collection() or $state->raw() to access the state data
}

Configuration

To install the configuration file you simply use:

php artisan vendor:publish

Options

  • storage: session|cache
  • storage-prefix: prefix that is added to the store identifier
  • expires-after: defines the expires after time in seconds, only used for CacheStore

License

Apache License 2.0 Please see LICENSE for more information.