Skip to content

Improving the README with php highlighting #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
uttamukkoji merged 1 commit into from
Jan 28, 2021
Merged

Improving the README with php highlighting #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 38 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ To use the PHP SDK, you need to perform the following steps:

To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.

use Contentstack\Contentstack;
$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
```php
use Contentstack\Contentstack;
$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
```


#### Download and install library:
Expand All @@ -32,9 +34,11 @@ To use the PHP SDK, you need to perform the following steps:

To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.

use Contentstack\Contentstack;
include_once "contentstack/contentstack.php";
$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
```php
use Contentstack\Contentstack;
include_once "contentstack/contentstack.php";
$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
```


### Key Concepts for using Contentstack
Expand All @@ -59,8 +63,7 @@ Assets refer to all the media files (images, videos, PDFs, audio files, and so o

A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with [Environments](https://www.contentstack.com/docs/guide/environments).





### Contentstack PHP SDK: 5-minute Quickstart

Expand All @@ -69,31 +72,35 @@ Install the library using [Composer](https://packagist.org/packages/contentstack

composer require contentstack/contentstack


To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.

use Contentstack\Contentstack;
$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
```php
use Contentstack\Contentstack;
$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
```

To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings > Stack to view the API Key and Delivery Token.



#### Querying content from your stack

To find all entries of a content type, use the query given below:

$result = $stack->ContentType(CONTENT_TYPE_UID)->Query()->toJSON()->includeCount()->includeContentType()->find()
// $result[0] - array of entries
// $result[1] - content type
// $result[2] - count of the entries



```php
$result = $stack->ContentType(CONTENT_TYPE_UID)->Query()->toJSON()->includeCount()->includeContentType()->find();
// $result[0] - array of entries
// $result[1] - content type
// $result[2] - count of the entries
```

To fetch a specific entry from a content type, use the following query:

$result = $stack->ContentType(CONTENT_TYPE_UID)->Entry(ENTRY_UID)->toJSON()->fetch()
// $result - entry object
```php
$result = $stack->ContentType(CONTENT_TYPE_UID)->Entry(ENTRY_UID)->toJSON()->fetch();
// $result - entry object
```

### Advanced Queries

Expand All @@ -115,22 +122,24 @@ You can use the Image Delivery API functions in this SDK as well. Here are a few

// set the image quality to 100.

imageUrl = Stack->imageTransform(imageUrl, array(
'quality'=> 100));
```php
$imageUrl = $stack->imageTransform(imageUrl, array('quality' => 100));
```

// resize the image by specifying width and height.

imageUrl = Stack->imageTransform(imageUrl, array(
'width'=> 100,
'height'=> 100
));
```php
$imageUrl = $stack->imageTransform(imageUrl, array(
'width' => 100,
'height' => 100
));
```

// enable auto optimization for the image.

imageUrl = Stack->imageTransform(imageUrl, array(
'auto'=> 'webp'
))

```php
$imageUrl = $stack->imageTransform(imageUrl, array('auto' => 'webp'));
```


### Helpful Links
Expand Down