Query

• data for query

• type of query

//Converting response array to JSON format



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('CONTENT_TYPE_UID')->Query()->toJSON()->find();

• field uids as array

In the Product content type, if we need to retrieve the data of entries of all the

other fields except the Price in USD parameter, you can send the parameter as:



except(string $level = 'BASE', array $field_uids = array())



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Entry('CONTENTTYPE_UID')->toJSON()->except('BASE',array('price'))->fetch();

• field uids as array

In the Product content type, if we need to retrieve the data of only the Price in USD

 parameter of all the entries, you can send the parameter as:



only(string $level = 'BASE', array $field_uids = array())



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Entry('  ')->toJSON()->only('BASE',array('price'))->fetch();

• array of reference field uids

//In the Product content type, there is a reference field called Categories, which refers entries of another content type. Let’s assume that you had

created an entry for the Product content type, and the value selected in the Categories field was ‘Mobiles’. If you fetch the entry using

the ‘Get a Single Entry’ API request, you would get all the details of the entry in the response, but the value against the Categories field

would be UID of the referenced entry (i.e., UID of the ‘Mobiles’ entry in this case).



 //In order to fetch the details of the entry used in the Categories reference field, you need to

 //use the include[] parameter in the following manner:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$results = $stack->ContentType('product')->Query()->toJSON()->includeReference(array('categories'))->find();

• string to be search in entries

In the Product content type, you have a entry text 'contentstack' in your content type, and you want to retrieve all the entries within this content type that have

values for this field anywhere with 'contentstack'.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->search('contentstack')->find();

In the Product content type, you have a field named Color ("uid":"color") in your content type, and you want to retrieve all the entries within this content type that have

values for this field starting with 'Bl'.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->regex('color','^B1')->find();



Now, in order to perform a case-insensitive search, you can use the $options key to specify any regular expressions options:

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->regex('color','^B1','i')->find();

Let’s say you want to retrieve entries in which the Title field is set to 'Redmi Note

3' and the Color field is 'Gold'. The query to be used for such a case would be:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$query1 = $stack->ContentType('product')->Query()->where('title', 'Redmi Note 3');

$query2 = $stack->ContentType('product')->Query()->where('color', 'Gold');

$entries = $stack->ContentType('product')->Query()->logicalAND($query1, $query2)->toJSON()->find();

Let’s say you want to retrieve entries in which either the value for the Color field is 'Gold' or 'Black'.

The query to be used for such a case would be:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$query1 = $stack->ContentType('product')->Query()->where('color', 'Black');

$query2 = $stack->ContentType('product')->Query()->where('color', 'Gold');

$entries = $stack->ContentType('product')->Query()->logicalOR($query1, $query2)->toJSON()->find();

• field uid to be sorted

In the Product content type, if you wish to sort the entries with respect to their prices in ascending order.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->ascending('price')->find();

• field uid to be sorted

In the Product content type, if you wish to sort the entries with respect to their prices in descending order.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->descending('price')->find();

• field uid against the value not existence is checked

In the Product content type, if we need to retrieve the data of entries of all the other fields except the Price in USD parameter.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->notExists('price')->find();

• field uid against the value existence is checked

In the Product content type, if we need to retrieve the data of only the Price in USD parameter of all the entries.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->exists('price')->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeFallback()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeBranch()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeSchema()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeReferenceContentTypeUID()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeContentType()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeEmbeddedItems()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeCount()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->count()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->includeOwner()->find();

• Name of key in string

• Value of the key in string

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->addParam('include_count', 'true')->toJSON()->find();

• Language code by default is "en-us"

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->language('en-us')->find();

• valid number

The skip parameter will skip a specific number of entries in the output. So, for example, if the content type contains around 12 entries

and you want to skip the first 2 entries to get only the last 10 in the response body, you need to specify ‘2’ here.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->skip(2)->find();

• array of tags you want to match in the entries tags

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->tags(array('Vivo','Gold'))->find();

• valid number

The limit parameter will return a specific number of entries in the output.

So for example, if the content type contains more than 100 entries and you wish to fetch only the first 2 entries, you need to specify '2' as value in this parameter.



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->limit(2)->find();

• field in the entry against which comparision needs to be done

• array value against which comparision is going to happen

Example 1 - Array Equals Operator Within Group

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->containedIn('title',array('Redmi','Samsung'))->find();





Example 2 - Array Equals Operator Within Modular Blocks

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->containedIn("additional_info.deals.deal_name", ["Christmas Deal", "Summer Deal"])->find();

• field in the entry against which comparision needs to be done

• array value against which comparision is going to happen

Example 1 - Array Not-equals Operator Within Group

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->notContainedIn("title", ["Electronics", "Apparel"])->find();



Example 2 - Array Not-equals Operator Within Modular Blocks

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->notContainedIn("additional_info.deals.deal_name", ["Christmas Deal", "Summer Deal"]) ->find();

• field in the entry against which comparision needs to be done

• value against which comparision is going to happen

In the Products content type, you have a field named Title ("uid":"title") field. If, for instance,

 you want to retrieve all the entries in which the value for the Title field is 'Redmi 3S', you can set the parameters as:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->where('title','Redmi 3S')->find();

• field in the entry against which comparision needs to be done

• value against which comparision is going to happen

Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is less than but not equal to 600. You can send the parameter as:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->lessThan('price','600')->find();

• field in the entry against which comparision needs to be done

• value against which comparision is going to happen

Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is less than or equal to 146. To achieve this, send the parameter as:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->lessThanEqualTo('price','146')->find();

• field in the entry against which comparision needs to be done

• value against which comparision is going to happen

Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is greater than but not equal to 146. You can send the parameter as:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->greaterThan('price','146')->find();

• field in the entry against which comparision needs to be done

• value against which comparision is going to happen

Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is less than and equal to 146. You can send the parameter as:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->greaterThanEqualTo('price','146')->find();

• field in the entry against which comparision needs to be done

• value against which comparision is going to happen

Let’s say you want to retrieve all the entries that have value of the Price in USD field set to a value that is not equal to 500. You can send the parameter as:



use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$result = $stack->ContentType('product')->Query()->toJSON()->notEqualTo('price','500')->find();

• array formatted query

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$_set = ['vivo', 'samsung', 'redmi 3', 'apple'];

$query1 = $stack->ContentType('product')->Query()->lessThan('title', $_set)->getQuery();

$_entries = $stack->ContentType('product')->Query()->addQuery($query1)->toJSON()->find();

use Contentstack\Contentstack;

$stack = Contentstack::Stack("API_KEY", "DELIVERY_TOKEN", "ENVIRONMENT");

$query1 = $stack->ContentType('product')->Query()->greaterThan('price', '5000')->getQuery();