Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darkterminal/gitlabdb
A PHP Class that reads JSON file as a database. Use for sample DBs using Gitlab API inspire from donjajo/jsondb
https://github.com/darkterminal/gitlabdb
gitlab json php
Last synced: about 2 months ago
JSON representation
A PHP Class that reads JSON file as a database. Use for sample DBs using Gitlab API inspire from donjajo/jsondb
- Host: GitHub
- URL: https://github.com/darkterminal/gitlabdb
- Owner: darkterminal
- Created: 2021-11-24T08:43:06.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-14T06:13:03.000Z (almost 3 years ago)
- Last Synced: 2024-04-27T09:33:16.442Z (8 months ago)
- Topics: gitlab, json, php
- Language: PHP
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitlabDB
A PHP Class that reads JSON file as a database. Use for sample DBs using Gitlab API inspire from [donjajo/php-jsondb](https://github.com/donjajo/php-jsondb)
### Usage
Install package
```bash
composer require darkterminal/GitlabDB
```
#### Initialize
```php
insert( 'users.json',
[
'name' => 'Thomas',
'state' => 'Nigeria',
'age' => 22
]
);
```
#### Get
Get back data, just like MySQL in PHP
##### All columns:
```php
select( '*' )
->from( 'users.json' )
->get();
print_r( $users );
```
##### Custom Columns:
```php
select( 'name, state' )
->from( 'users.json' )
->get();
print_r( $users );
```
##### Where Statement:
This WHERE works as AND Operator at the moment or OR
```php
select( 'name, state' )
->from( 'users.json' )
->where( [ 'name' => 'Thomas' ] )
->get();
print_r( $users );
// Defaults to Thomas OR Nigeria
$users = $json_db->select( 'name, state' )
->from( 'users.json' )
->where( [ 'name' => 'Thomas', 'state' => 'Nigeria' ] )
->get();
print_r( $users );
// Now is THOMAS AND Nigeria
$users = $json_db->select( 'name, state' )
->from( 'users.json' )
->where( [ 'name' => 'Thomas', 'state' => 'Nigeria' ], 'AND' )
->get();
print_r( $users );
```
##### Where Statement with regex:
By passing`GitlabDB::regex` to where statement, you can apply regex searching. It can be used for implementing `LIKE` or `REGEXP_LIKE` clause in SQL.
```php
$users = $json_db->select( 'name, state' )
->from( "users" )
->where( array( "state" => GitlabDB::regex( "/ria/" )), GitlabDB::AND )
->get();
print_r( $users );
// Outputs are rows which contains "ria" string in "state" column.
```
##### Order By:
Thanks to [Tarun Shanker](http://in.linkedin.com/in/tarunshankerpandey) for this feature. By passing the `order_by()` method, the result is sorted with 2 arguments of the column name and sort method - `GitlabDB::ASC` and `GitlabDB::DESC`
```php
select( 'name, state' )
->from( 'users.json' )
->where( [ 'name' => 'Thomas' ] )
->order_by( 'age', GitlabDB::ASC )
->get();
print_r( $users );
```
#### Updating Row
You can also update same JSON file with these methods
```php
update( [ 'name' => 'Oji', 'age' => 10 ] )
->from( 'users.json' )
->where( [ 'name' => 'Thomas' ] )
->trigger();
```
*Without the **where()** method, it will update all rows*
#### Deleting Row
```php
delete()
->from( 'users.json' )
->where( [ 'name' => 'Thomas' ] )
->trigger();
```
*Without the **where()** method, it will deletes all rows*
#### Exporting to MySQL
You can export the JSON back to SQL file by using this method and providing an output
```php
to_mysql( 'users.json', 'users.sql' );
```
Disable CREATE TABLE
```php
to_mysql( 'users.json', 'users.sql', false );
```
#### Exporting to XML
[Tarun Shanker](http://in.linkedin.com/in/tarunshankerpandey) also provided a feature to export data to an XML file
```php
to_xml( 'users.json', 'users.xml' ) ) {
echo 'Saved!';
}