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.

getAsset(string $assetId)

Returns an Asset resource.

getAssets(Query $query = null)

Returns a ResourceArray object which contains Asset resources.

getContentType(string $contentTypeId)

Returns a ContentType resource.

getContentTypes(Query $query = null)

Returns a ResourceArray object which contains ContentType resources.

getPublishedContentType(string $contentTypeId)

Returns a published ContentType resource.

getPublishedContentTypes(Query $query = null)

Returns a ResourceArray object which contains published ContentType resources.

getContentTypeSnapshot(string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

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

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

getEditorInterface(string $contentTypeId)

Returns an EditorInterface resource.

getEntry(string $entryId)

Returns an Entry resource.

getEntries(Query $query = null)

Returns a ResourceArray object which contains Entry resources.

getEntrySnapshot(string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

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

Returns a ResourceArray object which contains EntrySnapshot resources.

getExtension(string $extensionId)

Returns an Extension resource.

getExtensions()

Returns a ResourceArray object containing Extension resources.

getLocale(string $localeId)

Returns a Locale resource.

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 56
getAsset(string $assetId)

Returns an Asset resource.

Parameters

string $assetId

See also

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

at line 70
getAssets(Query $query = null)

Returns a ResourceArray object which contains Asset resources.

Parameters

Query $query

See also

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

at line 84
getContentType(string $contentTypeId)

Returns a ContentType resource.

Parameters

string $contentTypeId

See also

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

at line 98
getContentTypes(Query $query = null)

Returns a ResourceArray object which contains ContentType resources.

Parameters

Query $query

See also

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

at line 112
getPublishedContentType(string $contentTypeId)

Returns a published ContentType resource.

Parameters

string $contentTypeId

See also

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

at line 126
getPublishedContentTypes(Query $query = null)

Returns a ResourceArray object which contains published ContentType resources.

Parameters

Query $query

See also

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

at line 140
getContentTypeSnapshot(string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

Parameters

string $contentTypeId
string $snapshotId

See also

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

at line 155
getContentTypeSnapshots(string $contentTypeId, Query $query = null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

Parameters

string $contentTypeId
Query $query

See also

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

at line 170
getEditorInterface(string $contentTypeId)

Returns an EditorInterface resource.

Parameters

string $contentTypeId

See also

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

at line 184
getEntry(string $entryId)

Returns an Entry resource.

Parameters

string $entryId

See also

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

at line 198
getEntries(Query $query = null)

Returns a ResourceArray object which contains Entry resources.

Parameters

Query $query

See also

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

at line 212
getEntrySnapshot(string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

Parameters

string $entryId
string $snapshotId

See also

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

at line 227
getEntrySnapshots(string $entryId, Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

Parameters

string $entryId
Query $query

See also

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

at line 242
getExtension(string $extensionId)

Returns an Extension resource.

Parameters

string $extensionId

See also

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

at line 256
getExtensions()

Returns a ResourceArray object containing Extension resources.

See also

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

at line 269
getLocale(string $localeId)

Returns a Locale resource.

Parameters

string $localeId

See also

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

at line 283
getLocales()

Returns a ResourceArray object containing Locale resources.

See also

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