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

SpaceProxyExtension

trait SpaceProxyExtension

SpaceProxyExtension trait.

This trait is an extension to the Space 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 a space.

Properties

Client $client

Methods

string
getSpaceId()

Returns the ID associated to the current space.

Asset
getAsset(string $environmentId, string $assetId)

Returns an Asset resource.

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

Returns a ResourceArray object which contains Asset resources.

ContentType
getContentType(string $environmentId, string $contentTypeId)

Returns a ContentType resource.

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

Returns a ResourceArray object which contains ContentType resources.

ContentType
getPublishedContentType(string $environmentId, string $contentTypeId)

Returns a published ContentType resource.

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

Returns a ResourceArray object which contains published ContentType resources.

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

Returns a ContentTypeSnapshot resource.

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

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

DeliveryApiKey
getDeliveryApiKey(string $deliveryApiKeyId)

Returns a DeliveryApiKey resource.

ResourceArray
getDeliveryApiKeys(Query $query = null)

Returns a ResourceArray object containing DeliveryApiKey objects.

EditorInterface
getEditorInterface(string $environmentId, string $contentTypeId)

Returns an EditorInterface resource.

Entry
getEntry(string $environmentId, string $entryId)

Returns an Entry resource.

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

Returns a ResourceArray object which contains Entry resources.

EntrySnapshot
getEntrySnapshot(string $environmentId, string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

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

Returns a ResourceArray object which contains EntrySnapshot resources.

Environment
getEnvironment(string $environmentId)

Returns an Environment resource.

ResourceArray
getEnvironments(Query $query = null)

Returns a ResourceArray object which contains Environment resources.

Extension
getExtension(string $environmentId, string $extensionId)

Returns an Extension resource.

ResourceArray
getExtensions(string $environmentId)

Returns a ResourceArray object containing Extension resources.

Locale
getLocale(string $environmentId, string $localeId)

Returns a Locale resource.

ResourceArray
getLocales(string $environmentId)

Returns a ResourceArray object containing Locale resources.

PreviewApiKey
getPreviewApiKey(string $previewApiKeyId)

Returns a PreviewApiKey resource.

ResourceArray
getPreviewApiKeys(Query $query = null)

Returns a ResourceArray object containing PreviewApiKey resources.

Role
getRole(string $roleId)

Returns a Role resource.

ResourceArray
getRoles(Query $query = null)

Returns a ResourceArray object containing Role resources.

SpaceMembership
getSpaceMembership(string $spaceMembershipId)

Returns a SpaceMembership resource.

ResourceArray
getSpaceMemberships(Query $query = null)

Returns a ResourceArray object containing SpaceMembership resources.

Upload
getUpload(string $uploadId)

Returns an Upload resource.

Webhook
getWebhook(string $webhookId)

Returns a Webhook resource.

ResourceArray
getWebhooks(Query $query = null)

Returns a ResourceArray object containing Webhook resources.

WebhookCall
getWebhookCall(string $webhookId, string $callId)

Returns a WebhookCall resource.

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

Returns a ResourceArray object containing WebhookCall resources.

WebhookHealth
getWebhookHealth(string $webhookId)

Returns an WebhookHealth resource.

Details

at line 50
abstract protected string getSpaceId()

Returns the ID associated to the current space.

Return Value

string

at line 62
Asset getAsset(string $environmentId, string $assetId)

Returns an Asset resource.

Parameters

string $environmentId
string $assetId

Return Value

Asset

See also

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

at line 81
ResourceArray getAssets(string $environmentId, Query $query = null)

Returns a ResourceArray object which contains Asset resources.

Parameters

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 100
ContentType getContentType(string $environmentId, string $contentTypeId)

Returns a ContentType resource.

Parameters

string $environmentId
string $contentTypeId

Return Value

ContentType

See also

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

at line 119
ResourceArray getContentTypes(string $environmentId, Query $query = null)

Returns a ResourceArray object which contains ContentType resources.

Parameters

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

at line 138
ContentType getPublishedContentType(string $environmentId, string $contentTypeId)

Returns a published ContentType resource.

Parameters

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

at line 157
ResourceArray getPublishedContentTypes(string $environmentId, Query $query = null)

Returns a ResourceArray object which contains published ContentType resources.

Parameters

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

at line 177
ContentTypeSnapshot getContentTypeSnapshot(string $environmentId, string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

Parameters

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

at line 198
ResourceArray getContentTypeSnapshots(string $environmentId, string $contentTypeId, Query $query = null)

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

Parameters

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

at line 217
DeliveryApiKey getDeliveryApiKey(string $deliveryApiKeyId)

Returns a DeliveryApiKey resource.

Parameters

string $deliveryApiKeyId

Return Value

DeliveryApiKey

See also

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

at line 234
ResourceArray getDeliveryApiKeys(Query $query = null)

Returns a ResourceArray object containing DeliveryApiKey objects.

Parameters

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 252
EditorInterface getEditorInterface(string $environmentId, string $contentTypeId)

Returns an EditorInterface resource.

Parameters

string $environmentId
string $contentTypeId

Return Value

EditorInterface

See also

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

at line 271
Entry getEntry(string $environmentId, string $entryId)

Returns an Entry resource.

Parameters

string $environmentId
string $entryId

Return Value

Entry

See also

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

at line 290
ResourceArray getEntries(string $environmentId, Query $query = null)

Returns a ResourceArray object which contains Entry resources.

Parameters

string $environmentId
Query $query

Return Value

ResourceArray

See also

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

at line 310
EntrySnapshot getEntrySnapshot(string $environmentId, string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

Parameters

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

at line 331
ResourceArray getEntrySnapshots(string $environmentId, string $entryId, Query $query = null)

Returns a ResourceArray object which contains EntrySnapshot resources.

Parameters

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

at line 350
Environment getEnvironment(string $environmentId)

Returns an Environment resource.

Parameters

string $environmentId

Return Value

Environment

See also

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

at line 367
ResourceArray getEnvironments(Query $query = null)

Returns a ResourceArray object which contains Environment resources.

Parameters

Query $query

Return Value

ResourceArray

See also

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

at line 385
Extension getExtension(string $environmentId, string $extensionId)

Returns an Extension resource.

Parameters

string $environmentId
string $extensionId

Return Value

Extension

See also

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

at line 403
ResourceArray getExtensions(string $environmentId)

Returns a ResourceArray object containing Extension resources.

Parameters

string $environmentId

Return Value

ResourceArray

See also

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

at line 421
Locale getLocale(string $environmentId, string $localeId)

Returns a Locale resource.

Parameters

string $environmentId
string $localeId

Return Value

Locale

See also

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

at line 439
ResourceArray getLocales(string $environmentId)

Returns a ResourceArray object containing Locale resources.

Parameters

string $environmentId

Return Value

ResourceArray

See also

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

at line 456
PreviewApiKey getPreviewApiKey(string $previewApiKeyId)

Returns a PreviewApiKey resource.

Parameters

string $previewApiKeyId

Return Value

PreviewApiKey

See also

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

at line 473
ResourceArray getPreviewApiKeys(Query $query = null)

Returns a ResourceArray object containing PreviewApiKey resources.

Parameters

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 490
Role getRole(string $roleId)

Returns a Role resource.

Parameters

string $roleId

Return Value

Role

See also

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

at line 507
ResourceArray getRoles(Query $query = null)

Returns a ResourceArray object containing Role resources.

Parameters

Query $query

Return Value

ResourceArray

See also

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

at line 524
SpaceMembership getSpaceMembership(string $spaceMembershipId)

Returns a SpaceMembership resource.

Parameters

string $spaceMembershipId

Return Value

SpaceMembership

See also

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

at line 541
ResourceArray getSpaceMemberships(Query $query = null)

Returns a ResourceArray object containing SpaceMembership resources.

Parameters

Query $query

Return Value

ResourceArray

See also

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

at line 558
Upload getUpload(string $uploadId)

Returns an Upload resource.

Parameters

string $uploadId

Return Value

Upload

See also

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

at line 575
Webhook getWebhook(string $webhookId)

Returns a Webhook resource.

Parameters

string $webhookId

Return Value

Webhook

See also

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

at line 592
ResourceArray getWebhooks(Query $query = null)

Returns a ResourceArray object containing Webhook resources.

Parameters

Query $query

Return Value

ResourceArray

See also

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

at line 610
WebhookCall getWebhookCall(string $webhookId, string $callId)

Returns a WebhookCall resource.

Parameters

string $webhookId
string $callId

Return Value

WebhookCall

See also

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

at line 629
ResourceArray getWebhookCalls(string $webhookId, Query $query = null)

Returns a ResourceArray object containing WebhookCall resources.

Parameters

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

at line 647
WebhookHealth getWebhookHealth(string $webhookId)

Returns an WebhookHealth resource.

Parameters

string $webhookId

Return Value

WebhookHealth

See also

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