https://github.com/mte90/berlindb-rest

Modded version of BerlinDB with example to study a integration
https://github.com/mte90/berlindb-rest

Last synced: about 2 months ago
JSON representation

Modded version of BerlinDB with example to study a integration

• Host: GitHub
• URL: https://github.com/mte90/berlindb-rest
• Owner: Mte90
• Created: 2022-07-07T09:36:01.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-20T15:59:07.000Z (over 2 years ago)
• Last Synced: 2024-10-09T04:41:17.280Z (3 months ago)
• Language: PHP
• Size: 78.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# BerlinDB Rest WIP

This code is based on a modded [WordPress-example](https://github.com/berlindb/wordpress-example) and [BerlinDB](https://github.com/berlindb/core).  

The discussion is on https://github.com/berlindb/core/issues/26.

When the prototype is working we can update both the repository with those changes with 2 different pull requests.

Changes are wrapped on `// EDIT New lines` and the Rest.php file is the integration.

## Changes

* Added a new array variable `rest/table_name/query_class` in [`Schema`](https://github.com/Mte90/BerlinDB-Rest/blob/master/core/src/Database/Schema.php) class to set the global proprierty for the table, it is used to create a new item

* A new class [`Rest`](https://github.com/Mte90/BerlinDB-Rest/blob/master/core/src/Database/Rest.php)that is executed once for the table and for every column, it will check if rest is enabled and will enable the various endpoints (check that file for all the features)

* Some changes to [`Schema`](https://github.com/Mte90/BerlinDB-Rest/blob/master/core/src/Database/Schema.php) to execute the new class and share those new variables

### New filters

**books** is the table name so it will be replaced.

* `berlindb_rest_books_create/delete/update/all/search_permission`: filter to use that request

* `berlindb_rest_books_create`: executed on creation, the parameter shared is the items data in this way can be sanitized etc, if it is a WP_Error boject the creation is blocked

* `berlindb_rest_books_delete/search/update`: return a boolean to execute the action, 2 variables shared, the whole request and the whole Rest object

* `berlindb_rest_books_update/search_value`: executed on update, the parameter shared is the items data in this way can be sanitized etc, if it is a WP_Error object the creation is blocked

## Other information

* It is used the CRUD acronym to enable all the 4 kind of actions supported create/read/update/delete

* Supports all the parameters of the `Query` class

* Include a pagination support with the `page` parameter

* `shows_all/create/enable_search` are global parameters that requires a new variable, check the [example](https://github.com/Mte90/BerlinDB-Rest/blob/master/class-books-schema.php)

* On search if it is used a column not enabled it will be removed, in case no columns is set it will use all the enabled ones

## Status

### Done (the url are just examples)

* `wp-json/books/`|GET: Read endpoint by column/key name

* `wp-json/books/`|DELETE: Delete item by column/key name

* `wp-json/books/`|PUT: Update item by column/key name

* `wp-json/books/create`|POST: Create endpoint

* `wp-json/books/all`|GET: List endpoint with pagination and offset

* `wp-json/books/search/?s=word&search_columns[]=`: Will search inside the `title` column that has that content

## Test

To view in the browser `http://domain.test/wp-json/books/1` or to search `http://domain.test/wp-json/books/?s=Moc&search_columns[]=title`.

```

# Create

curl -X POST -d books['isbn']=val -d books['title']=val2 -d books['author']=val2 -d books['date_created']=1657128891 -d value['date_published']=867283220 http://domain.test/wp-json/books/create

# Delete

curl -X DELETE  http://boilerplate.test/wp-json/books/1

# Update

curl -X PUT -d meta['isbn']=value -d meta['title']=val3  http://boilerplate.test/wp-json/books/11

```