https://github.com/amireshoon/jstorage
a Light non-framework JSON-BASED storage
https://github.com/amireshoon/jstorage
composer json key-value key-value-store php storage storage-engine
Last synced: about 2 months ago
JSON representation
a Light non-framework JSON-BASED storage
- Host: GitHub
- URL: https://github.com/amireshoon/jstorage
- Owner: amireshoon
- License: mit
- Created: 2020-05-17T13:31:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-19T13:30:10.000Z (about 6 years ago)
- Last Synced: 2025-02-18T03:06:21.725Z (over 1 year ago)
- Topics: composer, json, key-value, key-value-store, php, storage, storage-engine
- Language: PHP
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jStorage - a Light non-framework JSON-BASED storage
[](https://github.com/amireshoon/jStorage/issues/)
[](https://github.com/amireshoon/jStorage)
jStorage is JSON-BASED small key value storage for more porductive.
- No frameworks used
- .gitignore option
- Light and ready to go
### Installation
Install using composer:
```php
$ composer require amirhwsin/jstorage
```
it's highly recommended installing using composer but if you need other way to go you can download project from git or simply clone it.
```sh
$ git clone https://github.com/amireshoon/jStorage.git
```
### Methods
There is no index or primary key for fetching data.
jStorage uses `jStorage_key` for indexing data.
You will have custom `key` paramteres for customizing storage.
Some methods you have to know about:
| Methods | Description |
| ------ | ------ |
| add | Insert new data set in storage |
| update | Update exists data set by `key`|
| remove | Remove exists data set by `key` |
| get | Get exists data set by `key` |
| commit | Commit all changes that you made |
### Usage
Use this code to load class:
```php
use jStorage;
```
If you want to git ignore your storage then use like this:
First parameter is where storage(JSON file) stored.
And the second one is for `.gitignore` file path.
```php
$jStorage = new jStorage\App('storage_folder/db.json', __DIR__ . '/.gitignore');
```
Otherwise use this:
```php
$jStorage = new jStorage\App('storage_folder/db.json');
```
# Add
For adding object to storage use like this:
array usage (Will compiled to json):
```php
$jStorage->add('username',[
'password' => 'JG^RWY',
'first_last_name' => 'Amirhossein Meydani',
'email' => 'amirhwsin@outlook.com'
]);
```
string usage:
```php
$jStorage->add('username','amirhossein');
```
int usage:
```php
$jStorage->add('phone_number',19248124);
```
bool usage:
```php
$jStorage->add('is_prefect_day', true);
```
At the end **do not forget to commit** like this:
```php
$jStorage->commt();
```
# Get
To get a data set you have to use `key` that you used to store data set.
You can get data set like this:
```php
$is_prefect_day = $jStorage->get('is_prefect_day');
```
# Update
For update a data set you have to use `key` that you store data set.
```php
$jStorage->update('key','new value');
```
At the end **do not forget to commit** like this:
```php
$jStorage->commt();
```
# Remove
```php
$jStorage->remove('key');
```
At the end **do not forget to commit** like this:
```php
$jStorage->commt();
```
License
----
MIT License
Copyright (c) 2020 Amirhossein Meydani
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
**Feel free to contribute**
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)