From 21da9e3d89f298c459a2b19aa0efda04517a9466 Mon Sep 17 00:00:00 2001 From: Damodar Lohani Date: Tue, 16 Mar 2021 19:03:08 +0545 Subject: [PATCH 1/3] PHP SDK getting started --- docs/sdks/php/GETTING_STARTED.md | 48 ++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/sdks/php/GETTING_STARTED.md diff --git a/docs/sdks/php/GETTING_STARTED.md b/docs/sdks/php/GETTING_STARTED.md new file mode 100644 index 0000000000..16f12896c4 --- /dev/null +++ b/docs/sdks/php/GETTING_STARTED.md @@ -0,0 +1,48 @@ +## Getting Started + +### Init your SDK +Initialize your SDK code with your project ID which can be found in your project settings page and your new API secret Key from previous phase. + +```php +$client = new Client(); + +$client + ->setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint + ->setProject('5df5acd0d48c2') // Your project ID + ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key +; +``` + +### Make Your First Request +Once your SDK object is set, create any of the Appwrite service project objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section. + +```php +$users = new Users($client); + +$result = $users->create('email@example.com', 'password'); +``` + +### Full Example +```php +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = new Client(); + +$client + ->setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint + ->setProject('5df5acd0d48c2') // Your project ID + ->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key +; + +$users = new Users($client); + +$result = $users->create('email@example.com', 'password'); +``` + +### Learn more +You can use followng resources to learn more and get help +- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server) +- 📜 [Appwrite Docs](https://appwrite.io/docs) +- 💬 [Discord Community](https://appwrite.io/discord) +- 🚂 [Appwrite PHP Playground](https://github.com/appwrite/playground-for-php) From db7b7f537415320f3f88d134483ccacf98a754ae Mon Sep 17 00:00:00 2001 From: Damodar Lohani Date: Wed, 17 Mar 2021 10:36:02 +0545 Subject: [PATCH 2/3] text corrections --- docs/sdks/php/GETTING_STARTED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sdks/php/GETTING_STARTED.md b/docs/sdks/php/GETTING_STARTED.md index 16f12896c4..d467dabac0 100644 --- a/docs/sdks/php/GETTING_STARTED.md +++ b/docs/sdks/php/GETTING_STARTED.md @@ -1,7 +1,7 @@ ## Getting Started ### Init your SDK -Initialize your SDK code with your project ID which can be found in your project settings page and your new API secret Key from previous phase. +Initialize your SDK code with your project ID which can be found in your project settings page and your new API secret Key from project's API keys section. ```php $client = new Client(); From ff1ebd0e3a9a03adb15fc11b5d9a90d4fee721fc Mon Sep 17 00:00:00 2001 From: Damodar Lohani Date: Wed, 17 Mar 2021 18:30:47 +0545 Subject: [PATCH 3/3] fix grammar --- docs/sdks/php/GETTING_STARTED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sdks/php/GETTING_STARTED.md b/docs/sdks/php/GETTING_STARTED.md index d467dabac0..1fcfa35f65 100644 --- a/docs/sdks/php/GETTING_STARTED.md +++ b/docs/sdks/php/GETTING_STARTED.md @@ -14,7 +14,7 @@ $client ``` ### Make Your First Request -Once your SDK object is set, create any of the Appwrite service project objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section. +Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section. ```php $users = new Users($client);