add User Collection, adapt crud, refactor crud, add readme

This commit is contained in:
Martz
2023-02-05 20:06:44 +01:00
parent 1d1beef82a
commit c586b4b9ff
5 changed files with 105 additions and 13 deletions

26
README.md Normal file
View File

@@ -0,0 +1,26 @@
### Php Sdk for Pocketbase
#### Crud adapted from js-sdk to php
```
// Returns a paginated records list.
🔓 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 = []);
// Returns the first found record matching the specified filter.
🔓 pb.collection(collectionIdOrName).getFirstListItem(string $filter, array $queryParams = []);
// Returns a single record by its id.
🔓 pb.collection(collectionIdOrName).getOne(string $recordId, array $queryParams = []);
// Creates (aka. register) a new record.
🔓 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 = []);
// Deletes a single record by its id.
🔓 pb.collection(collectionIdOrName).delete(string $recordId, array $queryParams = []);
```