amirhwsin/jstorage

Light non-framework JSON-BASED storage.

v1.1.2 2020-05-19 13:26 UTC

Requires

• php: ^7.1

MIT

• Amirhossein Meydani

• jstorage
• json-db
• json-storage
• json-based-storage

README

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:

$ 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.

$ 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:

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.

$jStorage = new jStorage\App('storage_folder/db.json', __DIR__ .  '/.gitignore');

Otherwise use this:

 $jStorage = new jStorage\App('storage_folder/db.json');

Add

For adding object to storage use like this:

array usage (Will compiled to json):

 $jStorage->add('username',[
     'password' => 'JG^RWY',
     'first_last_name' => 'Amirhossein Meydani',
     'email' => '[e-mail]'
 ]);

string usage:

$jStorage->add('username','amirhossein');

int usage:

$jStorage->add('phone_number',19248124);

bool usage:

$jStorage->add('is_prefect_day', true);

At the end do not forget to commit like this:

$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:

$is_prefect_day = $jStorage->get('is_prefect_day');

Update

For update a data set you have to use key that you store data set.

$jStorage->update('key','new value');

At the end do not forget to commit like this:

$jStorage->commt();

Remove

$jStorage->remove('key');

At the end do not forget to commit like this:

$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