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

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

Methods

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()

Updates the current resource.

from UpdatableTrait
getSystemProperties()

{@inheritdoc}

__construct(string $name)

Environment constructor.

jsonSerialize()

{@inheritdoc}

string[]
asUriParameters()

Returns an associative 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 37
getId()

{@inheritdoc}

in BaseResource at line 45
getType()

{@inheritdoc}

{@inheritdoc}

at line 76
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 79
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 107
protected getSpaceId()

{@inheritdoc}

at line 115
protected getEnvironmentId()

{@inheritdoc}

in EnvironmentProxyExtension at line 60
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 78
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 96
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 114
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 132
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 150
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 169
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 189
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 208
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 226
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 244
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 263
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 283
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 302
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 318
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 335
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 351
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 28
delete()

Deletes the current resource.

in UpdatableTrait at line 40
update()

Updates the current resource.

at line 57
getSystemProperties()

{@inheritdoc}

at line 49
__construct(string $name)

Environment constructor.

Parameters

string $name

at line 65
jsonSerialize()

{@inheritdoc}

at line 88
string[] asUriParameters()

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

Return Value

string[]

at line 99
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 123
string getName()

Return Value

string

at line 133
Environment setName(string $name)

Parameters

string $name

Return Value

Environment