1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Proxy
  7. \
  8. EnvironmentProxy

EnvironmentProxy

class EnvironmentProxy

EnvironmentProxy class.

This class works as a lazy reference to an environment resource. You can use it for most environment-related needs, such as fetching entries, assets and content types, or creating them (attaching them to this space).

To access this class, you can use the convenience method found in a client object.

$environment = $client->getEnvironmentProxy($spaceId, $environmentId);

The methods provided are very similar to the getX() methods you will find in an actual environment resource object. The main difference is that when fetching a environment resource, you will actually call the API, whereas with this proxy, you're just holding a reference to a certain environment. This is the reason why in most situations you should prefer using an EnvironmentProxy rather than an environment resource.

// Only the entries query will be made
$environment = $client->getEnvironmentProxy($spaceId, $environmentId);
$entries = $environment->getEntries();

// Two queries will be made
$environment = $client->getEnvironment($spaceId, $environmentId);
$entries = $environment->getEntries();

Traits

EnvironmentProxyExtension
EnvironmentProxyExtension trait.

Properties

Client $client from EnvironmentProxyExtension

Methods

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
__construct(Client $client, string $spaceId, string $environmentId)

No description

create(CreatableInterface $resource, string $resourceId = '', ResourceInterface|string[] $parameters = [])

Persist a new resource in Contentful.

ResourceInterface
resolveLink(Link $link, array $parameters = [])

Resolves a Contentful link scoped to the current space and environment.

Details

at line 81
protected getSpaceId()

{@inheritdoc}

at line 89
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

at line 71
__construct(Client $client, string $spaceId, string $environmentId)

Parameters

Client $client
string $spaceId
string $environmentId

at line 105
create(CreatableInterface $resource, string $resourceId = '', ResourceInterface|string[] $parameters = [])

Persist a new resource in Contentful.

This is a convenience method which just forwards to Client::create(), but setting the space and environment keys to the current space and environment IDs in the parameters array.

Parameters

CreatableInterface $resource
string $resourceId
ResourceInterface|string[] $parameters

See also

\Contentful\Management\Client::create()

Resolves a Contentful link scoped to the current space and environment.

Parameters

Link $link
array $parameters

Return Value

ResourceInterface