1. trait
  2. Contentful
  3. \
  4. Management
  5. \
  6. ClientExtension
  7. \
  8. SpaceExtension

SpaceExtension

trait SpaceExtension

SpaceExtension trait.

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

Traits

DeliveryApiKeyExtension
DeliveryApiKeyExtension trait.
EnvironmentExtension
EnvironmentExtension trait.
PreviewApiKeyExtension
PreviewApiKeyExtension trait.
RoleExtension
RoleExtension trait.
SpaceMembershipExtension
SpaceMembershipExtension trait.
UploadExtension
UploadExtension trait.
WebhookExtension
WebhookExtension trait.
AssetExtension
AssetExtension trait.
ContentTypeExtension
ContentTypeExtension trait.
EntryExtension
EntryExtension trait.
ExtensionExtension
ExtensionExtension trait.
LocaleExtension
LocaleExtension trait.
ContentTypeSnapshotExtension
ContentTypeSnapshotExtension trait.
EditorInterfaceExtension
EditorInterfaceExtension trait.
EntrySnapshotExtension
EntrySnapshotExtension trait.
WebhookCallExtension
WebhookCallExtension trait.
WebhookHealthExtension
WebhookHealthExtension trait.

Methods

DeliveryApiKey
getDeliveryApiKey(string $spaceId, string $deliveryApiKeyId)

Returns a DeliveryApiKey resource.

from DeliveryApiKeyExtension
ResourceArray
getDeliveryApiKeys(string $spaceId, Query $query = null)

Returns a ResourceArray object containing DeliveryApiKey objects.

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

No description

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
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.

from EnvironmentExtension
Environment
getEnvironment(string $spaceId, string $environmentId)

Returns an Environment resource.

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

Returns a ResourceArray object which contains Environment resources.

from EnvironmentExtension
PreviewApiKey
getPreviewApiKey(string $spaceId, string $previewApiKeyId)

Returns a PreviewApiKey resource.

from PreviewApiKeyExtension
ResourceArray
getPreviewApiKeys(string $spaceId, Query $query = null)

Returns a ResourceArray object containing PreviewApiKey resources.

from PreviewApiKeyExtension
Role
getRole(string $spaceId, string $roleId)

Returns a Role resource.

from RoleExtension
ResourceArray
getRoles(string $spaceId, Query $query = null)

Returns a ResourceArray object containing Role resources.

from RoleExtension
SpaceMembership
getSpaceMembership(string $spaceId, string $spaceMembershipId)

Returns a SpaceMembership resource.

from SpaceMembershipExtension
ResourceArray
getSpaceMemberships(string $spaceId, Query $query = null)

Returns a ResourceArray object containing SpaceMembership resources.

from SpaceMembershipExtension
Upload
getUpload(string $spaceId, string $uploadId)

Returns an Upload resource.

from UploadExtension
WebhookCall
getWebhookCall(string $spaceId, string $webhookId, string $webhookCallId)

Returns a WebhookCall resource.

from WebhookCallExtension
ResourceArray
getWebhookCalls(string $spaceId, string $webhookId, Query $query = null)

Returns a ResourceArray object containing WebhookCall resources.

from WebhookCallExtension
WebhookHealth
getWebhookHealth(string $spaceId, string $webhookId)

Returns an WebhookHealth resource.

from WebhookHealthExtension
Webhook
getWebhook(string $spaceId, string $webhookId)

Returns a Webhook resource.

from WebhookExtension
ResourceArray
getWebhooks(string $spaceId, Query $query = null)

Returns a ResourceArray object containing Webhook resources.

from WebhookExtension
SpaceProxy
getSpaceProxy(string $spaceId)

Returns a proxy to a space resource.

Space
getSpace(string $spaceId)

Returns a Space resource.

ResourceArray
getSpaces(Query $query = null)

Returns a ResourceArray object containing Space objects.

Details

in DeliveryApiKeyExtension at line 36
DeliveryApiKey getDeliveryApiKey(string $spaceId, string $deliveryApiKeyId)

Returns a DeliveryApiKey resource.

Parameters

string $spaceId
string $deliveryApiKeyId

Return Value

DeliveryApiKey

See also

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

in DeliveryApiKeyExtension at line 54
ResourceArray getDeliveryApiKeys(string $spaceId, Query $query = null)

Returns a ResourceArray object containing DeliveryApiKey objects.

Parameters

string $spaceId
Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/api-keys/api-keys-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 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

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

in EnvironmentExtension 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

in EnvironmentExtension 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

in EnvironmentExtension 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

in PreviewApiKeyExtension at line 36
PreviewApiKey getPreviewApiKey(string $spaceId, string $previewApiKeyId)

Returns a PreviewApiKey resource.

Parameters

string $spaceId
string $previewApiKeyId

Return Value

PreviewApiKey

See also

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

in PreviewApiKeyExtension at line 54
ResourceArray getPreviewApiKeys(string $spaceId, Query $query = null)

Returns a ResourceArray object containing PreviewApiKey resources.

Parameters

string $spaceId
Query $query

Return Value

ResourceArray

See also

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

in RoleExtension at line 36
Role getRole(string $spaceId, string $roleId)

Returns a Role resource.

Parameters

string $spaceId
string $roleId

Return Value

Role

See also

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

in RoleExtension at line 54
ResourceArray getRoles(string $spaceId, Query $query = null)

Returns a ResourceArray object containing Role resources.

Parameters

string $spaceId
Query $query

Return Value

ResourceArray

See also

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

in SpaceMembershipExtension at line 36
SpaceMembership getSpaceMembership(string $spaceId, string $spaceMembershipId)

Returns a SpaceMembership resource.

Parameters

string $spaceId
string $spaceMembershipId

Return Value

SpaceMembership

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/space-memberships/space-membership

in SpaceMembershipExtension at line 54
ResourceArray getSpaceMemberships(string $spaceId, Query $query = null)

Returns a ResourceArray object containing SpaceMembership resources.

Parameters

string $spaceId
Query $query

Return Value

ResourceArray

See also

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

in UploadExtension at line 34
Upload getUpload(string $spaceId, string $uploadId)

Returns an Upload resource.

Parameters

string $spaceId
string $uploadId

Return Value

Upload

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/uploads/retrieving-an-upload

in WebhookCallExtension at line 37
WebhookCall getWebhookCall(string $spaceId, string $webhookId, string $webhookCallId)

Returns a WebhookCall resource.

Parameters

string $spaceId
string $webhookId
string $webhookCallId

Return Value

WebhookCall

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-details

in WebhookCallExtension at line 57
ResourceArray getWebhookCalls(string $spaceId, string $webhookId, Query $query = null)

Returns a ResourceArray object containing WebhookCall resources.

Parameters

string $spaceId
string $webhookId
Query $query

Return Value

ResourceArray

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-call-overview

in WebhookHealthExtension at line 34
WebhookHealth getWebhookHealth(string $spaceId, string $webhookId)

Returns an WebhookHealth resource.

Parameters

string $spaceId
string $webhookId

Return Value

WebhookHealth

See also

https://www.contentful.com/developers/docs/references/content-management-api/#/reference/webhook-calls/webhook-health

in WebhookExtension at line 39
Webhook getWebhook(string $spaceId, string $webhookId)

Returns a Webhook resource.

Parameters

string $spaceId
string $webhookId

Return Value

Webhook

See also

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

in WebhookExtension at line 57
ResourceArray getWebhooks(string $spaceId, Query $query = null)

Returns a ResourceArray object containing Webhook resources.

Parameters

string $spaceId
Query $query

Return Value

ResourceArray

See also

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

at line 43
SpaceProxy getSpaceProxy(string $spaceId)

Returns a proxy to a space resource.

Useful for all space-scoped operations.

Parameters

string $spaceId

Return Value

SpaceProxy

at line 57
Space getSpace(string $spaceId)

Returns a Space resource.

Parameters

string $spaceId

Return Value

Space

See also

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

at line 73
ResourceArray getSpaces(Query $query = null)

Returns a ResourceArray object containing Space objects.

Parameters

Query $query

Return Value

ResourceArray

See also

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