1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Resource
  7. \
  8. Space

Space

class Space extends BaseResource implements CreatableInterface

Space class.

This class represents a resource with type "Space" in Contentful.

Traits

SpaceProxyExtension
SpaceProxyExtension trait.
DeletableTrait
DeletableTrait.
UpdatableTrait
UpdatableTrait.

Properties

SystemProperties $sys from UpdatableTrait
Client $client from UpdatableTrait
protected string $name
protected string|null $organizationId
protected string|null $defaultLocale

Methods

initialize(string $type, array $sys = [])

Initialize system properties.

from BaseResource
getSystemProperties()

{@inheritdoc}

from BaseResource
getId()

{@inheritdoc}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
mixed
asRequestBody()

Returns the resource in the form of request body.

BaseResource
setClient(Client $client)

Sets the current Client object instance.

from BaseResource
getSpaceId()

{@inheritdoc}

Asset
getAsset(string $environmentId, string $assetId)

Returns an Asset resource.

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

Returns a ResourceArray object which contains Asset resources.

from SpaceProxyExtension
ContentType
getContentType(string $environmentId, string $contentTypeId)

Returns a ContentType resource.

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

Returns a ResourceArray object which contains ContentType resources.

from SpaceProxyExtension
ContentType
getPublishedContentType(string $environmentId, string $contentTypeId)

Returns a published ContentType resource.

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

Returns a ResourceArray object which contains published ContentType resources.

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

Returns a ContentTypeSnapshot resource.

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

Returns a ResourceArray object which contains ContentTypeSnapshot resources.

from SpaceProxyExtension
DeliveryApiKey
getDeliveryApiKey(string $deliveryApiKeyId)

Returns a DeliveryApiKey resource.

from SpaceProxyExtension
ResourceArray
getDeliveryApiKeys(Query $query = null)

Returns a ResourceArray object containing DeliveryApiKey objects.

from SpaceProxyExtension
EditorInterface
getEditorInterface(string $environmentId, string $contentTypeId)

Returns an EditorInterface resource.

from SpaceProxyExtension
Entry
getEntry(string $environmentId, string $entryId)

Returns an Entry resource.

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

Returns a ResourceArray object which contains Entry resources.

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

Returns a EntrySnapshot resource.

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

Returns a ResourceArray object which contains EntrySnapshot resources.

from SpaceProxyExtension
Environment
getEnvironment(string $environmentId)

Returns an Environment resource.

from SpaceProxyExtension
ResourceArray
getEnvironments(Query $query = null)

Returns a ResourceArray object which contains Environment resources.

from SpaceProxyExtension
Extension
getExtension(string $environmentId, string $extensionId)

Returns an Extension resource.

from SpaceProxyExtension
ResourceArray
getExtensions(string $environmentId)

Returns a ResourceArray object containing Extension resources.

from SpaceProxyExtension
Locale
getLocale(string $environmentId, string $localeId)

Returns a Locale resource.

from SpaceProxyExtension
ResourceArray
getLocales(string $environmentId)

Returns a ResourceArray object containing Locale resources.

from SpaceProxyExtension
PreviewApiKey
getPreviewApiKey(string $previewApiKeyId)

Returns a PreviewApiKey resource.

from SpaceProxyExtension
ResourceArray
getPreviewApiKeys(Query $query = null)

Returns a ResourceArray object containing PreviewApiKey resources.

from SpaceProxyExtension
Role
getRole(string $roleId)

Returns a Role resource.

from SpaceProxyExtension
ResourceArray
getRoles(Query $query = null)

Returns a ResourceArray object containing Role resources.

from SpaceProxyExtension
SpaceMembership
getSpaceMembership(string $spaceMembershipId)

Returns a SpaceMembership resource.

from SpaceProxyExtension
ResourceArray
getSpaceMemberships(Query $query = null)

Returns a ResourceArray object containing SpaceMembership resources.

from SpaceProxyExtension
Upload
getUpload(string $uploadId)

Returns an Upload resource.

from SpaceProxyExtension
Webhook
getWebhook(string $webhookId)

Returns a Webhook resource.

from SpaceProxyExtension
ResourceArray
getWebhooks(Query $query = null)

Returns a ResourceArray object containing Webhook resources.

from SpaceProxyExtension
WebhookCall
getWebhookCall(string $webhookId, string $callId)

Returns a WebhookCall resource.

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

Returns a ResourceArray object containing WebhookCall resources.

from SpaceProxyExtension
WebhookHealth
getWebhookHealth(string $webhookId)

Returns an WebhookHealth resource.

from SpaceProxyExtension
delete()

Deletes the current resource.

from DeletableTrait
update()

Deletes the current resource.

from UpdatableTrait
__construct(string $name, string $organizationId, string $defaultLocale = null)

Space constructor.

array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

string[]
asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

string[]
getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

string
getName()

No description

Space
setName(string $name)

No description

Details

in BaseResource at line 39
protected initialize(string $type, array $sys = [])

Initialize system properties.

Parameters

string $type The system type
array $sys

in BaseResource at line 48
getSystemProperties()

{@inheritdoc}

in BaseResource at line 56
getId()

{@inheritdoc}

in BaseResource at line 64
getType()

{@inheritdoc}

{@inheritdoc}

at line 79
mixed asRequestBody()

Returns the resource in the form of request body.

This can differ from regular serialization, as some fields may not be present in the request payload.

Return Value

mixed

in BaseResource at line 98
BaseResource setClient(Client $client)

Sets the current Client object instance.

This is done automatically when performing API calls, so it shouldn't be used manually.

Parameters

Client $client

Return Value

BaseResource

at line 105
protected getSpaceId()

{@inheritdoc}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

in DeletableTrait at line 29
delete()

Deletes the current resource.

in UpdatableTrait at line 38
update()

Deletes the current resource.

at line 55
__construct(string $name, string $organizationId, string $defaultLocale = null)

Space constructor.

Parameters

string $name
string $organizationId
string $defaultLocale

at line 68
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array

at line 95
string[] asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

Return Value

string[]

at line 113
string[] getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

This method is supposed to be overridden if necessary.

Return Value

string[]

at line 121
string getName()

Return Value

string

at line 131
Space setName(string $name)

Parameters

string $name

Return Value

Space