Download the PHP package orchestra/memory without Composer
On this page you can find all versions of the php package orchestra/memory. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download orchestra/memory
More information about orchestra/memory
Files in orchestra/memory
Package memory
Short Description Memory Component for Orchestra Platform
License MIT
Homepage http://orchestraplatform.com/docs/latest/components/memory/
Informations about the package memory
Memory Component for Orchestra Platform
Memory Component handles runtime configuration either using "in memory" Runtime or database using Cache, Fluent Query Builder or Eloquent ORM. Instead of just allowing static configuration to be used, Memory Component allow those configuration to be persistent in between request by utilising multiple data storage option either through cache or database.
Version Compatibility
Laravel | Memory |
---|---|
5.5.x | 3.5.x |
5.6.x | 3.6.x |
5.7.x | 3.7.x |
5.8.x | 3.8.x |
6.x | 4.x |
7.x | 5.x |
8.x | 6.x |
Installation
To install through composer, run the following command from terminal:
Configuration
Next add the service provider in config/app.php
.
Aliases
You might want to add Orchestra\Support\Facades\Memory
to class aliases in config/app.php
:
Migrations
Before we can start using Memory Component, please run the following:
php artisan migrate
Publish Configuration
Optionally, you can also publish the configuration file if there any requirement to change the default:
Usage
Creating Instance
Below are list of possible ways to use Memory Component:
However, most of the time you wouldn't need to have additional memory instance other than the default which is using orchestra_options
table.
When using with Orchestra Platform,
Memory::make()
would be used throughout the application.
Storing Items
Storing items in the Memory Component is simple. Simply call the put method:
The first parameter is the key to the config item. You will use this key to retrieve the item from the config. The second parameter is the value of the item.
Retrieving Items
Retrieving items from Memory Component is even more simple than storing them. It is done using the get method. Just mention the key of the item you wish to retrieve:
By default, NULL
will be returned if the item does not exist. However, you may pass a different default value as a second parameter to the method:
Now, "Fred" will be returned if the "site.author" item does not exist.
Removing Items
Need to get rid of an item? No problem. Just mention the name of the item to the forget method:
Extending Memory
There might be requirement that a different type of storage engine would be use for memory instance, you can extending it by adding your own handler.
You can also extends
Orchestra\Memory\Handler
which add some boilerplate code on your custom handler.
All versions of memory with dependencies
illuminate/database Version ^8.37
orchestra/contracts Version ^6.0
orchestra/support Version ^6.0