PHPackages larastash/options - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. larastash/options ActiveLibrary[Database & ORM](/categories/database) larastash/options ================= Global key-value storage for Laravel based on database. 1.0.2(2y ago)05MITPHPPHP ^8.1 Since Jul 16Pushed 2y ago1 watchersCompare [ Source](https://github.com/larastash/options)[ Packagist](https://packagist.org/packages/larastash/options)[ Docs](https://github.com/larastash)[ RSS](/packages/larastash-options/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (3)DependenciesVersions (4)Used By (0) 🧰 Laravel Options ================= [](#-laravel-options) The `Options` class provides a convenient way to interact with option values in a Laravel application. It allows you to set, get, remove, and check the existence of options. The class also includes methods to manage previously retrieved option values and provides a query builder for the option model. Requirements ------------ [](#requirements) - Laravel ^10 (other version not tested); - PHP ^8.1; To support JSON fields in a database, ensure that your chosen database meets the following requirements: - **MySQL:** Use MySQL version 5.7.8 or higher. JSON field support was introduced in MySQL starting from version 5.7.8; - **MariaDB:** Use MariaDB version 10.2 or higher. JSON field support was introduced in MariaDB starting from version 10.2. - **PostgreSQL:** Use PostgreSQL version 9.2 or higher. JSON field support was introduced in PostgreSQL starting from version 9.2; - **SQLite:** Use SQLite version 3.9.0 or higher. JSON support and functions were added in SQLite starting from version 3.9.0; - **SQL Server:** Use SQL Server 2016 or higher. JSON support was introduced in SQL Server 2016; - **Oracle Database:** Use Oracle Database 12c Release 2 (12.2) or higher. JSON support was added in Oracle Database 12c Release 2; Installation ------------ [](#installation) You can install it using Composer: ``` composer require larastash/options ``` Run database migration: ``` php artisan migrate ``` ✨ Get to work, you're done! Usage ----- [](#usage) To use the `Options` class, make sure to import it into your PHP file: ``` use Larastash\Options\Option; ``` Or get `Larastash\Options\Option` singletone class from app container: ``` $option = app('option'); $option = app(Option::class); ``` Also, you can use the [`option()`](#helpers) helper. ### Set an Option [](#set-an-option) You can set the value of an option using the `set` method: ``` Option::set('key', 'value'); ``` This method will update the value of the option with the specified key. If the option doesn't exist, it will be created. You can also specify a time-to-live (TTL) for the option. The TTL determines how long the option will be cached. If a TTL is specified, the option will be stored in the cache in addition to being persisted in the database: ``` // Set an option with a TTL of 1 hour Option::set('key', 'value', 3600); Option::set('key', 'value', now()->addHour()); ``` ### Get an Option [](#get-an-option) To retrieve the value of an option, use the `get()` method: ``` $value = Option::get('key'); ``` You can also specify a default value to return if the option is not found: ``` $value = Option::get('key', 'default'); ``` If a TTL is specified and the option is found in the cache, the cached value will be returned. Otherwise, the option will be retrieved from the database. ``` // Retrived value will be cached for 1 hour $value = Option::get('key', 'default', 3600); $value = Option::get('key', 'default', now()->addHour()); ``` If TTL is not null, then get the fresh value from the database, ignoring the cached value. ### Remove an Option [](#remove-an-option) You can remove an option using the `remove` method: ``` Option::remove('key'); ``` This will delete the option from the database and remove it from the cache, if it exists. ### Check if an Option Exists [](#check-if-an-option-exists) You can check if an option exists using the `exists()` method: ``` if (Option::exists('key')) { // Option exists } else { // Option does not exist } ``` The `exists` method returns `true` if the option with the specified key exists in the database; otherwise, it returns `false`. ### Get All Option Values [](#get-all-option-values) To retrieve all option values, you can use the `all` method: ``` $options = Option::all(); ``` The `all` method returns a `Illuminate\Database\Eloquent\Collection` of all option values. ### Querying the Option Model [](#querying-the-option-model) You can access the query builder of the option model using the `query` method: ``` $query = Option::query(); ``` The `query` method returns an instance of the `Illuminate\Database\Eloquent\Builder` class that can be used to build custom queries on the option model. ### Advanced Usage [](#advanced-usage) If you need more advanced querying capabilities, you can use the `query()` method to get a query builder instance for the option model. This allows you to perform complex database queries on the option model: ``` $query = Option::query(); $query->where('key', 'like', 'prefix%'); $options = $query->get(); ``` This example retrieves all options whose keys start with a specific prefix. Helpers ------- [](#helpers) ### `option()` [](#option) The `option()` function provides a convenient way to interact with option values in a Laravel application. It acts as a wrapper around the `Options` class methods and simplifies the retrieval and setting of options. #### Parameters: [](#parameters) - `$key` (string|array|null): The key of the option to retrieve or an array containing the key and value to set. If set to `null`, it will return an instance of the `Option` class. - `$default` (mixed): (Optional) The default value to return if the option does not exist. This parameter is only used when retrieving an option value. - `$ttl` (DateInterval|DateTimeInterface|int|null): (Optional) The default value to return if the option does not exist. This parameter is only used when retrieving an option value. #### Return Value: [](#return-value) The function returns the value of the option with the specified key if a key is provided. If an array is provided, it sets the value of the option with the specified key. If no arguments are provided, it returns an instance of the `Option` class. #### Usage Examples: [](#usage-examples) **Get an Option:** ``` $value = option('key', 'default value'); $value = option('key', 'default value', ttl: 3600); $value = option('key', 'default value', ttl: now()->addHour()); ``` This retrieves the value of the option with the specified key. If the option does not exist, it returns the provided default value. **Set an Option:** ``` option(['key' => 'new value']); option(['key' => 'new value'], ttl: 3600); option(['key' => 'new value'], ttl: now()->addHour()); // or as array list option(['key', 'new value']); option(['key', 'new value'], ttl: 3600); option(['key', 'new value'], ttl: now()->addHour()); ``` This sets the value of the option with the specified key. If the option does not exist, it will be created. **Access the `Option` class:** ``` $option = option(); option()->set(...); option()->get(...); option()->remove(...); option()->exists(...); option()->query(...); // and etc... ``` This returns an instance of the `Option` class, allowing you to perform advanced operations. Testing ------- [](#testing) ``` $ composer test ``` Contributing ------------ [](#contributing) If you find any issues or have suggestions for improvement, please feel free to contribute by creating a pull request or submitting an issue. Credits ------- [](#credits) - [chipslays](https://github.com/chipslays) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 24 — LowBetter than 32% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community7 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 3 Last Release 1036d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/19103498?v=4)[chipslays](/maintainers/chipslays)[@chipslays](https://github.com/chipslays) --- Top Contributors [![chipslays](https://avatars.githubusercontent.com/u/19103498?v=4)](https://github.com/chipslays "chipslays (11 commits)") --- Tags laravellaravel-optionsoptionslaraveloptionsdatabase ### Embed Badge ![Health badge](/badges/larastash-options/health.svg) ``` [![Health](https://phpackages.com/badges/larastash-options/health.svg)](https://phpackages.com/packages/larastash-options) ``` ### Alternatives [nunomaduro/laravel-optimize-database Publishes migrations that make your database production ready. 26123.0k](/packages/nunomaduro-laravel-optimize-database)[hpolthof/laravel-translations-db A database translations implementation for Laravel 5. 545.8k](/packages/hpolthof-laravel-translations-db)[cubettech/lacassa Cassandra based query builder for laravel. 358.5k](/packages/cubettech-lacassa)[codengine/laravel-custom-migrations Custom Migrations for Laravel 131.3k](/packages/codengine-laravel-custom-migrations) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)