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.

getAsset(string $environmentId, string $assetId)

Returns an Asset resource.

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

Returns a ResourceArray object which contains Asset resources.

getContentType(string $environmentId, string $contentTypeId)

Returns a ContentType resource.

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

Returns a ResourceArray object which contains ContentType resources.

getPublishedContentType(string $environmentId, string $contentTypeId)

Returns a published ContentType resource.

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

Returns a ResourceArray object which contains published ContentType resources.

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

Returns a ContentTypeSnapshot resource.

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

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

getDeliveryApiKey(string $deliveryApiKeyId)

Returns a DeliveryApiKey resource.

getDeliveryApiKeys(Query $query = null)

Returns a ResourceArray object containing DeliveryApiKey objects.

getEditorInterface(string $environmentId, string $contentTypeId)

Returns an EditorInterface resource.

getEntry(string $environmentId, string $entryId)

Returns an Entry resource.

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

Returns a ResourceArray object which contains Entry resources.

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

Returns a EntrySnapshot resource.

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

Returns a ResourceArray object which contains EntrySnapshot resources.

getEnvironment(string $environmentId)

Returns an Environment resource.

getEnvironments(Query $query = null)

Returns a ResourceArray object which contains Environment resources.

getExtension(string $environmentId, string $extensionId)

Returns an Extension resource.

getExtensions(string $environmentId)

Returns a ResourceArray object containing Extension resources.

getLocale(string $environmentId, string $localeId)

Returns a Locale resource.

getLocales(string $environmentId)

Returns a ResourceArray object containing Locale resources.

getPreviewApiKey(string $previewApiKeyId)

Returns a PreviewApiKey resource.

getPreviewApiKeys(Query $query = null)

Returns a ResourceArray object containing PreviewApiKey resources.

getRole(string $roleId)

Returns a Role resource.

getRoles(Query $query = null)

Returns a ResourceArray object containing Role resources.

getSpaceMembership(string $spaceMembershipId)

Returns a SpaceMembership resource.

getSpaceMemberships(Query $query = null)

Returns a ResourceArray object containing SpaceMembership resources.

getUpload(string $uploadId)

Returns an Upload resource.

getWebhook(string $webhookId)

Returns a Webhook resource.

getWebhooks(Query $query = null)

Returns a ResourceArray object containing Webhook resources.

getWebhookCall(string $webhookId, string $callId)

Returns a WebhookCall resource.

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

Returns a ResourceArray object containing WebhookCall resources.

getWebhookHealth(string $webhookId)

Returns an WebhookHealth resource.

Details

at line 51
abstract protected string getSpaceId()

Returns the ID associated to the current space.

Return Value

string

at line 58
getAsset(string $environmentId, string $assetId)

Returns an Asset resource.

Parameters

string $environmentId
string $assetId

See also

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

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

Returns a ResourceArray object which contains Asset resources.

Parameters

string $environmentId
Query $query

See also

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

at line 86
getContentType(string $environmentId, string $contentTypeId)

Returns a ContentType resource.

Parameters

string $environmentId
string $contentTypeId

See also

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

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

Returns a ResourceArray object which contains ContentType resources.

Parameters

string $environmentId
Query $query

See also

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

at line 114
getPublishedContentType(string $environmentId, string $contentTypeId)

Returns a published ContentType resource.

Parameters

string $environmentId
string $contentTypeId

See also

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

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

Returns a ResourceArray object which contains published ContentType resources.

Parameters

string $environmentId
Query $query

See also

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

at line 142
getContentTypeSnapshot(string $environmentId, string $contentTypeId, string $snapshotId)

Returns a ContentTypeSnapshot resource.

Parameters

string $environmentId
string $contentTypeId
string $snapshotId

See also

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

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

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

Parameters

string $environmentId
string $contentTypeId
Query $query

See also

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

at line 172
getDeliveryApiKey(string $deliveryApiKeyId)

Returns a DeliveryApiKey resource.

Parameters

string $deliveryApiKeyId

See also

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

at line 185
getDeliveryApiKeys(Query $query = null)

Returns a ResourceArray object containing DeliveryApiKey objects.

Parameters

Query $query

See also

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

at line 198
getEditorInterface(string $environmentId, string $contentTypeId)

Returns an EditorInterface resource.

Parameters

string $environmentId
string $contentTypeId

See also

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

at line 212
getEntry(string $environmentId, string $entryId)

Returns an Entry resource.

Parameters

string $environmentId
string $entryId

See also

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

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

Returns a ResourceArray object which contains Entry resources.

Parameters

string $environmentId
Query $query

See also

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

at line 240
getEntrySnapshot(string $environmentId, string $entryId, string $snapshotId)

Returns a EntrySnapshot resource.

Parameters

string $environmentId
string $entryId
string $snapshotId

See also

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

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

Returns a ResourceArray object which contains EntrySnapshot resources.

Parameters

string $environmentId
string $entryId
Query $query

See also

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

at line 270
getEnvironment(string $environmentId)

Returns an Environment resource.

Parameters

string $environmentId

See also

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

at line 283
getEnvironments(Query $query = null)

Returns a ResourceArray object which contains Environment resources.

Parameters

Query $query

See also

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

at line 296
getExtension(string $environmentId, string $extensionId)

Returns an Extension resource.

Parameters

string $environmentId
string $extensionId

See also

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

at line 310
getExtensions(string $environmentId)

Returns a ResourceArray object containing Extension resources.

Parameters

string $environmentId

See also

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

at line 323
getLocale(string $environmentId, string $localeId)

Returns a Locale resource.

Parameters

string $environmentId
string $localeId

See also

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

at line 337
getLocales(string $environmentId)

Returns a ResourceArray object containing Locale resources.

Parameters

string $environmentId

See also

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

at line 350
getPreviewApiKey(string $previewApiKeyId)

Returns a PreviewApiKey resource.

Parameters

string $previewApiKeyId

See also

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

at line 363
getPreviewApiKeys(Query $query = null)

Returns a ResourceArray object containing PreviewApiKey resources.

Parameters

Query $query

See also

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

at line 376
getRole(string $roleId)

Returns a Role resource.

Parameters

string $roleId

See also

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

at line 389
getRoles(Query $query = null)

Returns a ResourceArray object containing Role resources.

Parameters

Query $query

See also

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

at line 402
getSpaceMembership(string $spaceMembershipId)

Returns a SpaceMembership resource.

Parameters

string $spaceMembershipId

See also

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

at line 415
getSpaceMemberships(Query $query = null)

Returns a ResourceArray object containing SpaceMembership resources.

Parameters

Query $query

See also

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

at line 428
getUpload(string $uploadId)

Returns an Upload resource.

Parameters

string $uploadId

See also

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

at line 441
getWebhook(string $webhookId)

Returns a Webhook resource.

Parameters

string $webhookId

See also

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

at line 454
getWebhooks(Query $query = null)

Returns a ResourceArray object containing Webhook resources.

Parameters

Query $query

See also

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

at line 467
getWebhookCall(string $webhookId, string $callId)

Returns a WebhookCall resource.

Parameters

string $webhookId
string $callId

See also

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

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

Returns a ResourceArray object containing WebhookCall resources.

Parameters

string $webhookId
Query $query

See also

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

at line 495
getWebhookHealth(string $webhookId)

Returns an WebhookHealth resource.

Parameters

string $webhookId

See also

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