1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Resource
  7. \
  8. Environment

Environment

class Environment extends BaseResource implements CreatableInterface

Environment class.

This class represents a resource with type "Environment" in Contentful.

Traits

EnvironmentProxyExtension
EnvironmentProxyExtension trait.
DeletableTrait
DeletableTrait.
UpdatableTrait
UpdatableTrait.

Properties

SystemProperties $sys from UpdatableTrait
Client $client from UpdatableTrait
protected string $name

Methods

initialize(string $type, array $sys = [])

Initialize system properties.

from BaseResource
getSystemProperties()

{@inheritdoc}

from BaseResource
getId()

{@inheritdoc}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
mixed
asRequestBody()

Returns the resource in the form of request body.

BaseResource
setClient(Client $client)

Sets the current Client object instance.

from BaseResource
getSpaceId()

{@inheritdoc}

getEnvironmentId()

{@inheritdoc}

Asset
getAsset(string $assetId)

Returns an Asset resource.

from EnvironmentProxyExtension
ResourceArray
getAssets(Query $query = null)

Returns a ResourceArray object which contains Asset resources.

from EnvironmentProxyExtension
ContentType
getContentType(string $contentTypeId)

Returns a ContentType resource.

from EnvironmentProxyExtension
ResourceArray
getContentTypes(Query $query = null)

Returns a ResourceArray object which contains ContentType resources.

from EnvironmentProxyExtension
ContentType
getPublishedContentType(string $contentTypeId)

Returns a published ContentType resource.

from EnvironmentProxyExtension
ResourceArray
getPublishedContentTypes(Query $query = null)

Returns a ResourceArray object which contains published ContentType resources.

from EnvironmentProxyExtension
ContentTypeSnapshot
getContentTypeSnapshot(string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

from EnvironmentProxyExtension
ResourceArray
getContentTypeSnapshots(string $contentTypeId, Query $query = null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

from EnvironmentProxyExtension
EditorInterface
getEditorInterface(string $contentTypeId)

Returns an EditorInterface resource.

from EnvironmentProxyExtension
Entry
getEntry(string $entryId)

Returns an Entry resource.

from EnvironmentProxyExtension
ResourceArray
getEntries(Query $query = null)

Returns a ResourceArray object which contains Entry resources.

from EnvironmentProxyExtension
EntrySnapshot
getEntrySnapshot(string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

from EnvironmentProxyExtension
ResourceArray
getEntrySnapshots(string $entryId, Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

from EnvironmentProxyExtension
Extension
getExtension(string $extensionId)

Returns an Extension resource.

from EnvironmentProxyExtension
ResourceArray
getExtensions()

Returns a ResourceArray object containing Extension resources.

from EnvironmentProxyExtension
Locale
getLocale(string $localeId)

Returns a Locale resource.

from EnvironmentProxyExtension
ResourceArray
getLocales()

Returns a ResourceArray object containing Locale resources.

from EnvironmentProxyExtension
delete()

Deletes the current resource.

from DeletableTrait
update()

Deletes the current resource.

from UpdatableTrait
__construct(string $name)

Environment constructor.

array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

string[]
asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

string[]
getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

string
getName()

No description

Environment
setName(string $name)

No description

Details

in BaseResource at line 39
protected initialize(string $type, array $sys = [])

Initialize system properties.

Parameters

string $type The system type
array $sys

in BaseResource at line 48
getSystemProperties()

{@inheritdoc}

in BaseResource at line 56
getId()

{@inheritdoc}

in BaseResource at line 64
getType()

{@inheritdoc}

{@inheritdoc}

at line 64
mixed asRequestBody()

Returns the resource in the form of request body.

This can differ from regular serialization, as some fields may not be present in the request payload.

Return Value

mixed

in BaseResource at line 98
BaseResource setClient(Client $client)

Sets the current Client object instance.

This is done automatically when performing API calls, so it shouldn't be used manually.

Parameters

Client $client

Return Value

BaseResource

at line 95
protected getSpaceId()

{@inheritdoc}

at line 103
protected getEnvironmentId()

{@inheritdoc}

in EnvironmentProxyExtension at line 59
Asset getAsset(string $assetId)

Returns an Asset resource.

Parameters

string $assetId

Return Value

Asset

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/assets/asset

in EnvironmentProxyExtension at line 77
ResourceArray getAssets(Query $query = null)

Returns a ResourceArray object which contains Asset resources.

Parameters

Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/assets/assets-collection

in EnvironmentProxyExtension at line 95
ContentType getContentType(string $contentTypeId)

Returns a ContentType resource.

Parameters

string $contentTypeId

Return Value

ContentType

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-types/content-type

in EnvironmentProxyExtension at line 113
ResourceArray getContentTypes(Query $query = null)

Returns a ResourceArray object which contains ContentType resources.

Parameters

Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-types/content-type-collection

in EnvironmentProxyExtension at line 131
ContentType getPublishedContentType(string $contentTypeId)

Returns a published ContentType resource.

Parameters

string $contentTypeId

Return Value

ContentType

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-types/activated-content-type-collection

in EnvironmentProxyExtension at line 149
ResourceArray getPublishedContentTypes(Query $query = null)

Returns a ResourceArray object which contains published ContentType resources.

Parameters

Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/content-types/activated-content-type-collection

in EnvironmentProxyExtension at line 168
ContentTypeSnapshot getContentTypeSnapshot(string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

Parameters

string $contentTypeId
string $snapshotId

Return Value

ContentTypeSnapshot

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/content-type-snapshot

in EnvironmentProxyExtension at line 188
ResourceArray getContentTypeSnapshots(string $contentTypeId, Query $query = null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

Parameters

string $contentTypeId
Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/content-type-snapshots-collection

in EnvironmentProxyExtension at line 207
EditorInterface getEditorInterface(string $contentTypeId)

Returns an EditorInterface resource.

Parameters

string $contentTypeId

Return Value

EditorInterface

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/editor-interface

in EnvironmentProxyExtension at line 225
Entry getEntry(string $entryId)

Returns an Entry resource.

Parameters

string $entryId

Return Value

Entry

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/entries/entry

in EnvironmentProxyExtension at line 243
ResourceArray getEntries(Query $query = null)

Returns a ResourceArray object which contains Entry resources.

Parameters

Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/entries/entries-collection

in EnvironmentProxyExtension at line 262
EntrySnapshot getEntrySnapshot(string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

Parameters

string $entryId
string $snapshotId

Return Value

EntrySnapshot

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/entry-snapshot

in EnvironmentProxyExtension at line 282
ResourceArray getEntrySnapshots(string $entryId, Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

Parameters

string $entryId
Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/snapshots/entry-snapshots-collection

in EnvironmentProxyExtension at line 301
Extension getExtension(string $extensionId)

Returns an Extension resource.

Parameters

string $extensionId

Return Value

Extension

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/ui-extensions/extension

in EnvironmentProxyExtension at line 317
ResourceArray getExtensions()

Returns a ResourceArray object containing Extension resources.

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/ui-extensions/extensions-collection

in EnvironmentProxyExtension at line 334
Locale getLocale(string $localeId)

Returns a Locale resource.

Parameters

string $localeId

Return Value

Locale

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/locales/locale

in EnvironmentProxyExtension at line 350
ResourceArray getLocales()

Returns a ResourceArray object containing Locale resources.

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/locales/locale-collection

in DeletableTrait at line 29
delete()

Deletes the current resource.

in UpdatableTrait at line 38
update()

Deletes the current resource.

at line 42
__construct(string $name)

Environment constructor.

Parameters

string $name

at line 53
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array

at line 76
string[] asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

Return Value

string[]

at line 87
string[] getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

This method is supposed to be overridden if necessary.

Return Value

string[]

at line 111
string getName()

Return Value

string

at line 121
Environment setName(string $name)

Parameters

string $name

Return Value

Environment