Role
class Role extends BaseProxy
Role class.
This class is used as a proxy for doing operations related to roles.
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 Role object which corresponds to the given resource ID in Contentful.
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 26
ResourceInterface
create(Role $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 26
ResourceInterface
update(Role $resource)
at line 26
ResourceInterface
delete(Role|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 31
string
getResourceUri(array $values)
Returns the URI for the current proxy type.
at line 39
string[]
getEnabledMethods()
An array of enabled methods for the current proxy.
at line 53
Role
get(string $resourceId)
Returns a Role object which corresponds to the given resource ID in Contentful.
at line 69
ResourceArray
getAll(Query $query = null)
Returns a ResourceArray object containing Role objects.