dojolink/pocketbase-php-sdk
1
0
Fork 0
mirror of https://github.com/jonathan-martz/pocketbase-php-sdk.git synced 2026-04-03 07:27:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Martz
2023-02-05 20:50:25 +01:00
parent c586b4b9ff
commit 51c403abd0
1 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,26 +1,38 @@
### Php Sdk for Pocketbase
***
##### This Repository are in active Development
***
``` php
// Example init and use
use \Pb\Client as pb;
$pb = new pb('https://backend-shop.mkay.dev');
var_dump($pb->collection('countries'));
```
***
#### Crud adapted from js-sdk to php
```
``` php
// Returns a paginated records list.
🔓 pb.collection(collectionIdOrName).getList(int $page = 1, int $perPage = 30, array $queryParams = []);
$pb->collection(collectionIdOrName)->getList(int $page = 1, int $perPage = 30, array $queryParams = []);
// Returns a list with all records batch fetched at once.
🔓 pb.collection(collectionIdOrName).getFullList(int $batch = 200, array $queryParams = []);
$pb->collection(collectionIdOrName)->getFullList(int $batch = 200, array $queryParams = []);
// Returns the first found record matching the specified filter.
🔓 pb.collection(collectionIdOrName).getFirstListItem(string $filter, array $queryParams = []);
$pb->collection(collectionIdOrName)->getFirstListItem(string $filter, array $queryParams = []);
// Returns a single record by its id.
🔓 pb.collection(collectionIdOrName).getOne(string $recordId, array $queryParams = []);
$pb->collection(collectionIdOrName)->getOne(string $recordId, array $queryParams = []);
// Creates (aka. register) a new record.
🔓 pb.collection(collectionIdOrName).create(array $bodyParams = [], array $queryParams = []);
$pb->collection(collectionIdOrName)->create(array $bodyParams = [], array $queryParams = []);
// Updates an existing record by its id.
🔓 pb.collection(collectionIdOrName).update(string $recordId, array $bodyParams = [],array $queryParams = []);
$pb->collection(collectionIdOrName)->update(string $recordId, array $bodyParams = [],array $queryParams = []);
// Deletes a single record by its id.
🔓 pb.collection(collectionIdOrName).delete(string $recordId, array $queryParams = []);
$pb->collection(collectionIdOrName)->delete(string $recordId, array $queryParams = []);
```