Locale
class Locale extends BaseProxy
Locale class.
This class is used as a proxy for doing operations related to locales.
Properties
| protected Client | $client | from BaseProxy | |
| protected string|null | $spaceId | from BaseProxy | |
| protected bool | $requiresSpaceId | Whether the current proxy requires a space ID for working properly. | from BaseProxy |
Methods
Returns the string to be used as baseUri option, or null otherwise.
No description
No description
Override this method in a proxy class if special headers are to be defined upon creation.
No description
No description
Returns the URI for the current proxy type.
An array of enabled methods for the current proxy.
Returns a Locale object which corresponds to the given resource ID in Contentful.
Returns a ResourceArray object containing Locale objects.
Details
in BaseProxy at line 78
ResourceInterface
__call(string $name, array $arguments)
Acts as a whitelister for protected methods.
in BaseProxy at line 93
protected string|null
getBaseUri()
Returns the string to be used as baseUri option, or null otherwise.
in BaseProxy at line 105
ResourceInterface
resolveLink(Link $link)
Shortcut for resolving links.
in BaseProxy at line 117
protected ResourceInterface|ResourceArray
getResource(array $values, Query $query = null, ResourceInterface $resource = null)
in BaseProxy at line 144
protected ResourceInterface
requestResource(string $method, string $uriSuffix, ResourceInterface|string $resource, int $version = null, mixed $body = null)
in BaseProxy at line 172
protected string
getResourceId(ResourceInterface|string $resource)
at line 25
ResourceInterface
create(Locale $resource, string $resourceId = null)
in BaseProxy at line 212
protected string[]
getCreateAdditionalHeaders(ResourceInterface $resource)
Override this method in a proxy class if special headers are to be defined upon creation.
at line 25
ResourceInterface
update(Locale $resource)
at line 25
ResourceInterface
delete(Locale|string $resource, int $version = null)
in BaseProxy at line 248
protected
archive(ResourceInterface|string $resource, int $version = null)
Archives a resource.
in BaseProxy at line 263
protected
unarchive(ResourceInterface|string $resource, int $version = null)
Unarchives a resource.
in BaseProxy at line 278
protected
publish(ResourceInterface|string $resource, int $version = null)
Publishes a resource.
in BaseProxy at line 293
protected
unpublish(ResourceInterface|string $resource, int $version = null)
Unpublishes a resource.
at line 30
string
getResourceUri(array $values)
Returns the URI for the current proxy type.
at line 38
string[]
getEnabledMethods()
An array of enabled methods for the current proxy.
at line 52
Locale
get(string $resourceId)
Returns a Locale object which corresponds to the given resource ID in Contentful.
at line 66
ResourceArray
getAll()
Returns a ResourceArray object containing Locale objects.