A

AssetsClass in namespace Contentstack\Stack
Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use.
$ Assets#assetUidProperty in class Assets
BaseQuery::ascending() — Method in class BaseQuery
To sort the entries in ascending order of the specified field
BaseQuery::addParam() — Method in class BaseQuery
To add query parameter in query
BaseQuery::addQuery() — Method in class BaseQuery
Add Query is used to add the raw/array query to filter the entries
Stack::Assets() — Method in class Stack
Assets Class to initalize your Assets

B

BaseQueryClass in namespace Contentstack\Stack
BaseQuery Base Class where all the Queries will be created

C

ContentstackClass in namespace Contentstack
Contentstack abstract class to provide access to Stack Object
ContentstackRegionClass in namespace Contentstack
Contentstack Regions
CSExceptionClass in namespace Contentstack\Error
CSException CSException Class is used to wrap the REST API error
BaseQuery::count() — Method in class BaseQuery
To get only count result
BaseQuery::containedIn() — Method in class BaseQuery
Query the field value from the given set of values
ContentTypeClass in namespace Contentstack\Stack
Class ContentType
$ Entry#contentTypeProperty in class Entry
Stack::ContentType() — Method in class Stack
To initialize the ContentType object from where the content will be fetched/retrieved.
Utility::contentstackUrl() — Method in class Utility
Contentstack URL method to create the url based on the request
Utility::contentstackRequest() — Method in class Utility
Contentstack request to the API server based on the data

D

BaseQuery::descending() — Method in class BaseQuery
To sort the entries in descending order of the specified field
Stack::DeliveryToken() — Method in class Stack
This function returns Delivery Token.
Utility::debug() — Method in class Utility
DEBUGGING MESSAGE

E

$ CSException#error_messageProperty in class CSException
$ CSException#error_codeProperty in class CSException
BaseQuery::except() — Method in class BaseQuery
To exclude the fields from the result set
BaseQuery::exists() — Method in class BaseQuery
To check field exists
ContentType::Entry() — Method in class ContentType
Entry object to create the "Query" on the specified ContentType
EntryClass in namespace Contentstack\Stack\ContentType
Entry
$ Entry#entryUidProperty in class Entry

F

Assets::fetch() — Method in class Assets
Fetch the specified assets
ContentType::fetch() — Method in class ContentType
Fetch the specific contenttypes
Entry::fetch() — Method in class Entry
Fetch the specified entry
Query::find() — Method in class Query
Get all entries based on the specified subquery
Query::findOne() — Method in class Query
Get single entry based on the specified subquery

G

CSException::getStatusCode() — Method in class CSException
To get http status_code of the current exception
CSException::getErrors() — Method in class CSException
Returns error details of current exception
BaseQuery::greaterThan() — Method in class BaseQuery
Query the field which has greater value than specified one
BaseQuery::greaterThanEqualTo() — Method in class BaseQuery
Query the field which has greater or equal value than specified one
BaseQuery::getQuery() — Method in class BaseQuery
Get the raw/array query from the current instance of Query/Entry
Result::get() — Method in class Result
Get the keys from the object
Stack::getLastActivities() — Method in class Stack
To get the last_activity information of the configured environment from all the content types
Stack::getHost() — Method in class Stack
This function returns host.
Stack::getProtocol() — Method in class Stack
This function return protocol type.
Stack::getPort() — Method in class Stack
This function return Port.
Stack::getAPIKEY() — Method in class Stack
This function returns API Key.
Stack::getEnvironment() — Method in class Stack
This function returns environment name.
Stack::getContentTypes() — Method in class Stack
This call returns comprehensive information of all the content types available in a particular stack in your account.
Utility::getDomain() — Method in class Utility
Get the domain from the current object
Utility::generateQuery() — Method in class Utility
POST formatted query for the API server
Utility::generateQueryParams() — Method in class Utility
Sending the GET requests with all the parameters in POST as well as GET
Utility::getLastActivites() — Method in class Utility
Get Last activities

H

$ CSException#http_codeProperty in class CSException
$ Stack#headerProperty in class Stack
Utility::headers() — Method in class Utility
Header transformation as it required format

I

BaseQuery::includeReference() — Method in class BaseQuery
To include reference(s) of other content type in entries
BaseQuery::includeFallback() — Method in class BaseQuery
To include fallback content if specified locale content is not publish.
BaseQuery::includeSchema() — Method in class BaseQuery
To include schema along with entries
BaseQuery::includeReferenceContentTypeUID() — Method in class BaseQuery
This method includes the content type UIDs of the referenced entries returned in the response.
BaseQuery::includeContentType() — Method in class BaseQuery
To include content_type along with entries
BaseQuery::includeCount() — Method in class BaseQuery
To include the count of entries based on the results
BaseQuery::includeOwner() — Method in class BaseQuery
To include the owner of entries based on the results
Stack::ImageTrasform() — Method in class Stack
ImageTrasform function is define for image manipulation with different
Utility::isKeySet() — Method in class Utility
Validate the key is set or not
Utility::isEmpty() — Method in class Utility
Validate the String

L

BaseQuery::logicalAND() — Method in class BaseQuery
Logical AND queries are pushed
BaseQuery::logicalOR() — Method in class BaseQuery
Logical OR queries are pushed
BaseQuery::language() — Method in class BaseQuery
To set the language code in the query
BaseQuery::limit() — Method in class BaseQuery
Limit the specified number of entries from result set
BaseQuery::lessThan() — Method in class BaseQuery
Query the field which has less value than specified one
BaseQuery::lessThanEqualTo() — Method in class BaseQuery
Query the field which has less or equal value than specified one

N

BaseQuery::notExists() — Method in class BaseQuery
To check field doesn't exists
BaseQuery::notContainedIn() — Method in class BaseQuery
Query the field value other than the given set of values
BaseQuery::notEqualTo() — Method in class BaseQuery
Query the field which has not equal to value than specified one

O

$ Assets#operationProperty in class Assets
BaseQuery::only() — Method in class BaseQuery
To project the fields in the result set
$ Entry#operationProperty in class Entry
$ Query#operationProperty in class Query

Q

Assets::Query() — Method in class Assets
Query object to create the "Query" on the specified ContentType
ContentType::Query() — Method in class ContentType
Query object to create the "Query" on the specified ContentType
QueryClass in namespace Contentstack\Stack\ContentType
Class Query

R

BaseQuery::regex() — Method in class BaseQuery
To perform the regular expression test on the specified field
ResultClass in namespace Contentstack\Stack
Class Result

S

Contentstack::Stack() — Method in class Contentstack
Static method for the Stack constructor
$ Assets#stackProperty in class Assets
$ BaseQuery#subQueryProperty in class BaseQuery
BaseQuery::search() — Method in class BaseQuery
To search the given string in the entries
BaseQuery::skip() — Method in class BaseQuery
Skip the specified number of entries from result set
$ ContentType#stackProperty in class ContentType
StackClass in namespace Contentstack\Stack
Stack Class to initialize the provided parameter Stack
Stack::setHost() — Method in class Stack
To set the host on stack object
Stack::setProtocol() — Method in class Stack
This function sets protocol.
Stack::setPort() — Method in class Stack
This function sets Port.
Stack::setAPIKEY() — Method in class Stack
This function sets API Key.
Stack::setDeliveryToken() — Method in class Stack
This function sets Delivery Token.
Stack::setEnvironment() — Method in class Stack
This function sets environment name.
Stack::sync() — Method in class Stack
Syncs your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates

T

$ Assets#typeProperty in class Assets
BaseQuery::toJSON() — Method in class BaseQuery
To transform the Result object to server response content
BaseQuery::tags() — Method in class BaseQuery
Result set entries should have tags specified
Result::toJSON() — Method in class Result
To convert result object to json

U

$ ContentType#uidProperty in class ContentType
UtilityClass in namespace Contentstack\Support
Utility/Helper where all the helper and utility functions will be available.

V

Utility::validateInput() — Method in class Utility
Validation for all the parameters required for the SDK

W

BaseQuery::where() — Method in class BaseQuery
Query the field which has exact value as specified
Utility::wrapResult() — Method in class Utility
Wrap Result

_

CSException::__construct() — Method in class CSException
CSException Class to initalize your ContentType
Assets::__construct() — Method in class Assets
Assets constructor
BaseQuery::__construct() — Method in class BaseQuery
BaseQuery constructor
ContentType::__construct() — Method in class ContentType
ContentType ContentType Class to initalize your ContentType
$ Entry#_queryProperty in class Entry
Entry::__construct() — Method in class Entry
Entry Class to initalize your Entry
$ Query#_queryProperty in class Query
Query::__construct() — Method in class Query
Query Class to initalize your Query
Result::__construct() — Method in class Result
Result constructor Result wrapper over the plain result for the future
Stack::__construct() — Method in class Stack
Constructor of the Stack