ContactMessageResource
class ContactMessageResource extends EntityResource (View source)
Customizes the entity REST Resource plugin for Contact's Message entities.
Message entities are not stored, so they cannot be:
- retrieved (GET)
- modified (PATCH)
- deleted (DELETE) Messages can only be sent/created (POST).
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected array | $serializerFormats | The available serialization formats. |
from ResourceBase |
| protected LoggerInterface | $logger | A logger instance. |
from ResourceBase |
| protected EntityTypeInterface | $entityType | The entity type targeted by this resource. |
from EntityResource |
| protected ConfigFactoryInterface | $configFactory | The config factory. |
from EntityResource |
| protected PluginManagerInterface | $linkRelationTypeManager | The link relation type manager used to create HTTP header links. |
from EntityResource |
Methods
Constructs a Drupal\rest\Plugin\rest\resource\EntityResource object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Creates an instance of the plugin.
Returns a collection of routes with URL path information for the resource.
Returns the available HTTP request methods on this plugin.
Gets the base route for a particular method.
Gets the base route requirements for a particular method.
Verifies that an entity does not violate any validation constraints.
Responds to entity PATCH requests.
Checks whether the given field should be PATCHed.
Generates a fallback access denied message, when no specific reason is set.
Calculates dependencies for the configured plugin.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, EntityTypeManagerInterface $entity_type_manager, array $serializer_formats, LoggerInterface $logger, ConfigFactoryInterface $config_factory, PluginManagerInterface $link_relation_type_manager)
Constructs a Drupal\rest\Plugin\rest\resource\EntityResource object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
array
permissions()
Implements ResourceInterface::permissions().
Every plugin operation method gets its own user permission. Example: "restful delete entity:node" with the title "Access DELETE on Node resource".
RouteCollection
routes()
Returns a collection of routes with URL path information for the resource.
This method determines where a resource is reachable, what path replacements are used, the required HTTP method for the operation etc.
protected array
requestMethods()
Provides predefined HTTP request methods.
Plugins can override this method to provide additional custom request methods.
array
availableMethods()
Returns the available HTTP request methods on this plugin.
protected Route
getBaseRoute(string $canonical_path, string $method)
Gets the base route for a particular method.
protected array
getBaseRouteRequirements($method)
Gets the base route requirements for a particular method.
protected
validate(EntityInterface $entity, array $fields_to_validate = [])
Verifies that an entity does not violate any validation constraints.
The validation errors will be filtered to not include fields to which the current user does not have access and if $fields_to_validate is provided will only include fields in that array.
protected
checkEditFieldAccess(EntityInterface $entity)
Performs edit access checks for fields.
ResourceResponse
get(EntityInterface $entity, Request $request)
Responds to entity GET requests.
ModifiedResourceResponse
post(EntityInterface $entity = NULL)
Responds to entity POST requests and saves the new entity.
ModifiedResourceResponse
patch(EntityInterface $original_entity, EntityInterface $entity = NULL)
Responds to entity PATCH requests.
protected bool
checkPatchFieldAccess(FieldItemListInterface $original_field, FieldItemListInterface $received_field)
| internal |
Checks whether the given field should be PATCHed.
ModifiedResourceResponse
delete(EntityInterface $entity)
Responds to entity DELETE requests.
protected string
generateFallbackAccessDeniedMessage(EntityInterface $entity, string $operation)
Generates a fallback access denied message, when no specific reason is set.
protected bool
isConfigEntityResource()
Checks if this resource is for a Config Entity.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
protected
addLinkHeaders(EntityInterface $entity, Response $response)
Adds link headers to a response.