1. trait
  2. Contentful
  3. \
  4. Management
  5. \
  6. Proxy
  7. \
  8. Extension
  9. \
  10. EnvironmentProxyExtension

EnvironmentProxyExtension

trait EnvironmentProxyExtension

EnvironmentProxyExtension trait.

This trait is an extension to the Environment resource class. It is built here and included as a trait to better separate concerns. This trait provides shortcuts for fetching resources that belong to an environment.

Properties

Client $client

Methods

string
getSpaceId()

Returns the ID associated to the current space.

string
getEnvironmentId()

Returns the ID associated to the current environment.

Asset
getAsset(string $assetId)

Returns an Asset resource.

ResourceArray
getAssets(Query $query = \null)

Returns a ResourceArray object which contains Asset resources.

ContentType
getContentType(string $contentTypeId)

Returns a ContentType resource.

ResourceArray
getContentTypes(Query $query = \null)

Returns a ResourceArray object which contains ContentType resources.

ContentType
getPublishedContentType(string $contentTypeId)

Returns a published ContentType resource.

ResourceArray
getPublishedContentTypes(Query $query = \null)

Returns a ResourceArray object which contains published ContentType resources.

ContentTypeSnapshot
getContentTypeSnapshot(string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

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

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

EditorInterface
getEditorInterface(string $contentTypeId)

Returns an EditorInterface resource.

Entry
getEntry(string $entryId)

Returns an Entry resource.

ResourceArray
getEntries(Query $query = \null)

Returns a ResourceArray object which contains Entry resources.

EntrySnapshot
getEntrySnapshot(string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

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

Returns a ResourceArray object which contains EntrySnapshot resources.

Extension
getExtension(string $extensionId)

Returns an Extension resource.

ResourceArray
getExtensions()

Returns a ResourceArray object containing Extension resources.

Locale
getLocale(string $localeId)

Returns a Locale resource.

ResourceArray
getLocales()

Returns a ResourceArray object containing Locale resources.

Details

at line 42
abstract protected string getSpaceId()

Returns the ID associated to the current space.

Return Value

string

at line 49
abstract protected string getEnvironmentId()

Returns the ID associated to the current environment.

Return Value

string

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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