1. trait
  2. Contentful
  3. \
  4. Management
  5. \
  6. ClientExtension
  7. \
  8. Space
  9. \
  10. EnvironmentExtension

EnvironmentExtension

trait EnvironmentExtension

EnvironmentExtension trait.

This extension is supposed to be applied to Client class which provides a fetchResource method.

Traits

AssetExtension
AssetExtension trait.
ContentTypeExtension
ContentTypeExtension trait.
EntryExtension
EntryExtension trait.
ExtensionExtension
ExtensionExtension trait.
LocaleExtension
LocaleExtension trait.
ContentTypeSnapshotExtension
ContentTypeSnapshotExtension trait.
EditorInterfaceExtension
EditorInterfaceExtension trait.
EntrySnapshotExtension
EntrySnapshotExtension trait.

Methods

Asset
getAsset(string $spaceId, string $environmentId, string $assetId)

Returns an Asset resource.

from AssetExtension
ResourceArray
getAssets(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains Asset resources.

from AssetExtension
ResourceInterface|ResourceArray
fetchResource(string $class, array $parameters, Query $query = null, ResourceInterface $resource = null)

No description

ContentTypeSnapshot
getContentTypeSnapshot(string $spaceId, string $environmentId, string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

from ContentTypeSnapshotExtension
ResourceArray
getContentTypeSnapshots(string $spaceId, string $environmentId, string $contentTypeId, Query $query = null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

from ContentTypeSnapshotExtension
EditorInterface
getEditorInterface(string $spaceId, string $environmentId, string $contentTypeId)

Returns an EditorInterface resource.

from EditorInterfaceExtension
ContentType
getContentType(string $spaceId, string $environmentId, string $contentTypeId)

Returns a ContentType resource.

from ContentTypeExtension
ResourceArray
getContentTypes(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains ContentType resources.

from ContentTypeExtension
ContentType
getPublishedContentType(string $spaceId, string $environmentId, string $contentTypeId)

Returns a published ContentType resource.

from ContentTypeExtension
ResourceArray
getPublishedContentTypes(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains published ContentType resources.

from ContentTypeExtension
EntrySnapshot
getEntrySnapshot(string $spaceId, string $environmentId, string $entryId, string $snapshotId)

Returns an EntrySnapshot resource.

from EntrySnapshotExtension
ResourceArray
getEntrySnapshots(string $spaceId, string $environmentId, string $entryId, Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

from EntrySnapshotExtension
Entry
getEntry(string $spaceId, string $environmentId, string $entryId)

Returns an Entry resource.

from EntryExtension
ResourceArray
getEntries(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains Entry resources.

from EntryExtension
Extension
getExtension(string $spaceId, string $environmentId, string $extensionId)

Returns an Extension resource.

from ExtensionExtension
ResourceArray
getExtensions(string $spaceId, string $environmentId)

Returns a ResourceArray object containing Extension resources.

from ExtensionExtension
Locale
getLocale(string $spaceId, string $environmentId, string $localeId)

Returns a Locale resource.

from LocaleExtension
ResourceArray
getLocales(string $spaceId, string $environmentId)

Returns a ResourceArray object containing Locale resources.

from LocaleExtension
EnvironmentProxy
getEnvironmentProxy(string $spaceId, string $environmentId = 'master')

Returns a proxy to an environment resource.

Environment
getEnvironment(string $spaceId, string $environmentId)

Returns an Environment resource.

ResourceArray
getEnvironments(string $spaceId, Query $query = null)

Returns a ResourceArray object which contains Environment resources.

Details

in AssetExtension at line 38
Asset getAsset(string $spaceId, string $environmentId, string $assetId)

Returns an Asset resource.

Parameters

string $spaceId
string $environmentId
string $assetId

Return Value

Asset

See also

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

in AssetExtension at line 58
ResourceArray getAssets(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains Asset resources.

Parameters

string $spaceId
string $environmentId
Query $query

Return Value

ResourceArray

See also

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

at line 25
ResourceInterface|ResourceArray fetchResource(string $class, array $parameters, Query $query = null, ResourceInterface $resource = null)

Parameters

string $class
array $parameters
Query $query
ResourceInterface $resource

Return Value

ResourceInterface|ResourceArray

in ContentTypeSnapshotExtension at line 38
ContentTypeSnapshot getContentTypeSnapshot(string $spaceId, string $environmentId, string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

Parameters

string $spaceId
string $environmentId
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 ContentTypeSnapshotExtension at line 60
ResourceArray getContentTypeSnapshots(string $spaceId, string $environmentId, string $contentTypeId, Query $query = null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

Parameters

string $spaceId
string $environmentId
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 EditorInterfaceExtension at line 35
EditorInterface getEditorInterface(string $spaceId, string $environmentId, string $contentTypeId)

Returns an EditorInterface resource.

Parameters

string $spaceId
string $environmentId
string $contentTypeId

Return Value

EditorInterface

See also

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

in ContentTypeExtension at line 41
ContentType getContentType(string $spaceId, string $environmentId, string $contentTypeId)

Returns a ContentType resource.

Parameters

string $spaceId
string $environmentId
string $contentTypeId

Return Value

ContentType

See also

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

in ContentTypeExtension at line 61
ResourceArray getContentTypes(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains ContentType resources.

Parameters

string $spaceId
string $environmentId
Query $query

Return Value

ResourceArray

See also

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

in ContentTypeExtension at line 80
ContentType getPublishedContentType(string $spaceId, string $environmentId, string $contentTypeId)

Returns a published ContentType resource.

Parameters

string $spaceId
string $environmentId
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 ContentTypeExtension at line 100
ResourceArray getPublishedContentTypes(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains published ContentType resources.

Parameters

string $spaceId
string $environmentId
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 EntrySnapshotExtension at line 38
EntrySnapshot getEntrySnapshot(string $spaceId, string $environmentId, string $entryId, string $snapshotId)

Returns an EntrySnapshot resource.

Parameters

string $spaceId
string $environmentId
string $entryId
string $snapshotId

Return Value

EntrySnapshot

See also

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

in EntrySnapshotExtension at line 60
ResourceArray getEntrySnapshots(string $spaceId, string $environmentId, string $entryId, Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

Parameters

string $spaceId
string $environmentId
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 EntryExtension at line 39
Entry getEntry(string $spaceId, string $environmentId, string $entryId)

Returns an Entry resource.

Parameters

string $spaceId
string $environmentId
string $entryId

Return Value

Entry

See also

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

in EntryExtension at line 59
ResourceArray getEntries(string $spaceId, string $environmentId, Query $query = null)

Returns a ResourceArray object which contains Entry resources.

Parameters

string $spaceId
string $environmentId
Query $query

Return Value

ResourceArray

See also

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

in ExtensionExtension at line 36
Extension getExtension(string $spaceId, string $environmentId, string $extensionId)

Returns an Extension resource.

Parameters

string $spaceId
string $environmentId
string $extensionId

Return Value

Extension

See also

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

in ExtensionExtension at line 55
ResourceArray getExtensions(string $spaceId, string $environmentId)

Returns a ResourceArray object containing Extension resources.

Parameters

string $spaceId
string $environmentId

Return Value

ResourceArray

See also

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

in LocaleExtension at line 36
Locale getLocale(string $spaceId, string $environmentId, string $localeId)

Returns a Locale resource.

Parameters

string $spaceId
string $environmentId
string $localeId

Return Value

Locale

See also

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

in LocaleExtension at line 55
ResourceArray getLocales(string $spaceId, string $environmentId)

Returns a ResourceArray object containing Locale resources.

Parameters

string $spaceId
string $environmentId

Return Value

ResourceArray

See also

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

at line 42
EnvironmentProxy getEnvironmentProxy(string $spaceId, string $environmentId = 'master')

Returns a proxy to an environment resource.

Useful for all environment-scoped operations.

Parameters

string $spaceId
string $environmentId

Return Value

EnvironmentProxy

at line 57
Environment getEnvironment(string $spaceId, string $environmentId)

Returns an Environment resource.

Parameters

string $spaceId
string $environmentId

Return Value

Environment

See also

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

at line 75
ResourceArray getEnvironments(string $spaceId, Query $query = null)

Returns a ResourceArray object which contains Environment resources.

Parameters

string $spaceId
Query $query

Return Value

ResourceArray

See also

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