From 51c403abd0323c20e0953e7237e613698d2e4870 Mon Sep 17 00:00:00 2001 From: Martz Date: Sun, 5 Feb 2023 20:50:25 +0100 Subject: [PATCH] update readme --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a28c72b..93ef16a 100644 --- a/README.md +++ b/README.md @@ -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 = []); ``` \ No newline at end of file