class Message
Same name in this branch
- 8.9.x composer/Plugin/ProjectMessage/Message.php \Drupal\Composer\Plugin\ProjectMessage\Message
Same name in other branches
- 9 composer/Plugin/ProjectMessage/Message.php \Drupal\Composer\Plugin\ProjectMessage\Message
- 9 core/modules/contact/src/Entity/Message.php \Drupal\contact\Entity\Message
- 10 composer/Plugin/ProjectMessage/Message.php \Drupal\Composer\Plugin\ProjectMessage\Message
- 10 core/modules/contact/src/Entity/Message.php \Drupal\contact\Entity\Message
- 11.x composer/Plugin/ProjectMessage/Message.php \Drupal\Composer\Plugin\ProjectMessage\Message
- 11.x core/modules/contact/src/Entity/Message.php \Drupal\contact\Entity\Message
Defines the contact message entity.
Plugin annotation
@ContentEntityType(
id = "contact_message",
label = @Translation("Contact message"),
label_collection = @Translation("Contact messages"),
label_singular = @Translation("contact message"),
label_plural = @Translation("contact messages"),
label_count = @PluralTranslation(
singular = "@count contact message",
plural = "@count contact messages",
),
bundle_label = @Translation("Contact form"),
handlers = {
"access" = "Drupal\contact\ContactMessageAccessControlHandler",
"storage" = "Drupal\Core\Entity\ContentEntityNullStorage",
"view_builder" = "Drupal\contact\MessageViewBuilder",
"form" = {
"default" = "Drupal\contact\MessageForm"
}
},
admin_permission = "administer contact forms",
entity_keys = {
"bundle" = "contact_form",
"uuid" = "uuid",
"langcode" = "langcode"
},
bundle_entity_type = "contact_form",
field_ui_base_route = "entity.contact_form.edit_form",
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
- class \Drupal\contact\Entity\Message extends \Drupal\Core\Entity\ContentEntityBase implements \Drupal\contact\MessageInterface
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
Expanded class hierarchy of Message
3 files declare their use of Message
- ContactStorageTest.php in core/
modules/ contact/ tests/ src/ Functional/ ContactStorageTest.php - MessageResourceTestBase.php in core/
modules/ contact/ tests/ src/ Functional/ Rest/ MessageResourceTestBase.php - MessageTest.php in core/
modules/ jsonapi/ tests/ src/ Functional/ MessageTest.php
39 string references to 'Message'
- AjaxTestController::renderError in core/
modules/ system/ tests/ modules/ ajax_test/ src/ Controller/ AjaxTestController.php - Returns an AjaxResponse with alert command.
- ConfigEntityImportTest::doActionUpdate in core/
modules/ system/ tests/ src/ Kernel/ Entity/ ConfigEntityImportTest.php - Tests updating a action during import.
- ConfigExportUITest::testExport in core/
modules/ config/ tests/ src/ Functional/ ConfigExportUITest.php - Tests export of configuration.
- ConnectionFailureTest::testConnectionFailureLogging in core/
modules/ dblog/ tests/ src/ Kernel/ ConnectionFailureTest.php - Tests logging of connection failures.
- ContactFormEditForm::form in core/
modules/ contact/ src/ ContactFormEditForm.php - Gets the actual form array to be built.
File
-
core/
modules/ contact/ src/ Entity/ Message.php, line 42
Namespace
Drupal\contact\EntityView source
class Message extends ContentEntityBase implements MessageInterface {
/**
* {@inheritdoc}
*/
public function isPersonal() {
return $this->bundle() == 'personal';
}
/**
* {@inheritdoc}
*/
public function getContactForm() {
return $this->get('contact_form')->entity;
}
/**
* {@inheritdoc}
*/
public function getSenderName() {
return $this->get('name')->value;
}
/**
* {@inheritdoc}
*/
public function setSenderName($sender_name) {
$this->set('name', $sender_name);
}
/**
* {@inheritdoc}
*/
public function getSenderMail() {
return $this->get('mail')->value;
}
/**
* {@inheritdoc}
*/
public function setSenderMail($sender_mail) {
$this->set('mail', $sender_mail);
}
/**
* {@inheritdoc}
*/
public function getSubject() {
return $this->get('subject')->value;
}
/**
* {@inheritdoc}
*/
public function setSubject($subject) {
$this->set('subject', $subject);
}
/**
* {@inheritdoc}
*/
public function getMessage() {
return $this->get('message')->value;
}
/**
* {@inheritdoc}
*/
public function setMessage($message) {
$this->set('message', $message);
}
/**
* {@inheritdoc}
*/
public function copySender() {
return (bool) $this->get('copy')->value;
}
/**
* {@inheritdoc}
*/
public function setCopySender($inform) {
$this->set('copy', (bool) $inform);
}
/**
* {@inheritdoc}
*/
public function getPersonalRecipient() {
if ($this->isPersonal()) {
return $this->get('recipient')->entity;
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
/** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
$fields = parent::baseFieldDefinitions($entity_type);
$fields['contact_form']->setLabel(t('Form ID'))
->setDescription(t('The ID of the associated form.'));
$fields['uuid']->setDescription(t('The message UUID.'));
$fields['langcode']->setDescription(t('The message language code.'));
$fields['name'] = BaseFieldDefinition::create('string')->setLabel(t("The sender's name"))
->setDescription(t('The name of the person that is sending the contact message.'));
$fields['mail'] = BaseFieldDefinition::create('email')->setLabel(t("The sender's email"))
->setDescription(t('The email of the person that is sending the contact message.'));
// The subject of the contact message.
$fields['subject'] = BaseFieldDefinition::create('string')->setLabel(t('Subject'))
->setRequired(TRUE)
->setSetting('max_length', 100)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -10,
])
->setDisplayConfigurable('form', TRUE);
// The text of the contact message.
$fields['message'] = BaseFieldDefinition::create('string_long')->setLabel(t('Message'))
->setRequired(TRUE)
->setDisplayOptions('form', [
'type' => 'string_textarea',
'weight' => 0,
'settings' => [
'rows' => 12,
],
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'type' => 'string',
'weight' => 0,
'label' => 'above',
])
->setDisplayConfigurable('view', TRUE);
$fields['copy'] = BaseFieldDefinition::create('boolean')->setLabel(t('Copy'))
->setDescription(t('Whether to send a copy of the message to the sender.'));
$fields['recipient'] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Recipient ID'))
->setDescription(t('The ID of the recipient user for personal contact messages.'))
->setSetting('target_type', 'user');
return $fields;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | ||||
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | ||||
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | ||||
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | ||||
ContentEntityBase::$activeLangcode | protected | property | Language code identifying the entity active language. | ||||
ContentEntityBase::$defaultLangcode | protected | property | Local cache for the default language code. | ||||
ContentEntityBase::$defaultLangcodeKey | protected | property | The default langcode entity key. | ||||
ContentEntityBase::$enforceRevisionTranslationAffected | protected | property | Whether the revision translation affected flag has been enforced. | ||||
ContentEntityBase::$entityKeys | protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | ||||
ContentEntityBase::$fieldDefinitions | protected | property | Local cache for field definitions. | ||||
ContentEntityBase::$fields | protected | property | The array of fields, each being an instance of FieldItemListInterface. | ||||
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck | protected static | property | Local cache for fields to skip from the checking for translation changes. | ||||
ContentEntityBase::$isDefaultRevision | protected | property | Indicates whether this is the default revision. | ||||
ContentEntityBase::$langcodeKey | protected | property | The language entity key. | ||||
ContentEntityBase::$languages | protected | property | Local cache for the available language objects. | ||||
ContentEntityBase::$loadedRevisionId | protected | property | The loaded revision ID before the new revision was set. | ||||
ContentEntityBase::$newRevision | protected | property | Boolean indicating whether a new revision should be created on save. | ||||
ContentEntityBase::$revisionTranslationAffectedKey | protected | property | The revision translation affected entity key. | ||||
ContentEntityBase::$translatableEntityKeys | protected | property | Holds translatable entity keys such as the label. | ||||
ContentEntityBase::$translationInitialize | protected | property | A flag indicating whether a translation object is being initialized. | ||||
ContentEntityBase::$translations | protected | property | An array of entity translation metadata. | ||||
ContentEntityBase::$validated | protected | property | Whether entity validation was performed. | ||||
ContentEntityBase::$validationRequired | protected | property | Whether entity validation is required before saving the entity. | ||||
ContentEntityBase::$values | protected | property | The plain data values of the contained fields. | ||||
ContentEntityBase::access | public | function | Checks data value access. | Overrides EntityBase::access | 1 | ||
ContentEntityBase::addTranslation | public | function | |||||
ContentEntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityBase::bundle | |||
ContentEntityBase::bundleFieldDefinitions | public static | function | 4 | ||||
ContentEntityBase::clearTranslationCache | protected | function | Clear entity translation object cache to remove stale references. | ||||
ContentEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | ||
ContentEntityBase::get | public | function | |||||
ContentEntityBase::getEntityKey | protected | function | Gets the value of the given entity key, if defined. | 1 | |||
ContentEntityBase::getFieldDefinition | public | function | |||||
ContentEntityBase::getFieldDefinitions | public | function | |||||
ContentEntityBase::getFields | public | function | |||||
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 | |||
ContentEntityBase::getIterator | public | function | |||||
ContentEntityBase::getLanguages | protected | function | |||||
ContentEntityBase::getLoadedRevisionId | public | function | |||||
ContentEntityBase::getRevisionId | public | function | |||||
ContentEntityBase::getTranslatableFields | public | function | |||||
ContentEntityBase::getTranslatedField | protected | function | Gets a translated field. | ||||
ContentEntityBase::getTranslation | public | function | |||||
ContentEntityBase::getTranslationLanguages | public | function | |||||
ContentEntityBase::getTranslationStatus | public | function | Returns the translation status. | Overrides TranslationStatusInterface::getTranslationStatus | |||
ContentEntityBase::getUntranslated | public | function | |||||
ContentEntityBase::hasField | public | function | |||||
ContentEntityBase::hasTranslation | public | function | |||||
ContentEntityBase::hasTranslationChanges | public | function | |||||
ContentEntityBase::id | public | function | Gets the identifier. | Overrides EntityBase::id | |||
ContentEntityBase::initializeTranslation | protected | function | Instantiates a translation object for an existing translation. | ||||
ContentEntityBase::isDefaultRevision | public | function | |||||
ContentEntityBase::isDefaultTranslation | public | function | |||||
ContentEntityBase::isDefaultTranslationAffectedOnly | public | function | |||||
ContentEntityBase::isLatestRevision | public | function | |||||
ContentEntityBase::isLatestTranslationAffectedRevision | public | function | |||||
ContentEntityBase::isNewRevision | public | function | |||||
ContentEntityBase::isNewTranslation | public | function | |||||
ContentEntityBase::isRevisionTranslationAffected | public | function | |||||
ContentEntityBase::isRevisionTranslationAffectedEnforced | public | function | |||||
ContentEntityBase::isTranslatable | public | function | |||||
ContentEntityBase::isValidationRequired | public | function | |||||
ContentEntityBase::label | public | function | Gets the label of the entity. | Overrides EntityBase::label | 6 | ||
ContentEntityBase::language | public | function | Gets the language of the entity. | Overrides EntityBase::language | |||
ContentEntityBase::onChange | public | function | |||||
ContentEntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityBase::postCreate | |||
ContentEntityBase::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityBase::postSave | 9 | ||
ContentEntityBase::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides EntityBase::preSave | 8 | ||
ContentEntityBase::preSaveRevision | public | function | 3 | ||||
ContentEntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityBase::referencedEntities | 1 | ||
ContentEntityBase::removeTranslation | public | function | |||||
ContentEntityBase::set | public | function | |||||
ContentEntityBase::setDefaultLangcode | protected | function | Populates the local cache for the default language code. | ||||
ContentEntityBase::setNewRevision | public | function | |||||
ContentEntityBase::setRevisionTranslationAffected | public | function | |||||
ContentEntityBase::setRevisionTranslationAffectedEnforced | public | function | |||||
ContentEntityBase::setValidationRequired | public | function | |||||
ContentEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | |||
ContentEntityBase::updateFieldLangcodes | protected | function | Updates language for already instantiated fields. | ||||
ContentEntityBase::updateLoadedRevisionId | public | function | |||||
ContentEntityBase::updateOriginalValues | public | function | Updates the original values with the interim changes. | ||||
ContentEntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityBase::uuid | |||
ContentEntityBase::validate | public | function | 1 | ||||
ContentEntityBase::wasDefaultRevision | public | function | |||||
ContentEntityBase::__clone | public | function | Magic method: Implements a deep clone. | ||||
ContentEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | |||
ContentEntityBase::__get | public | function | Implements the magic method for getting object properties. | ||||
ContentEntityBase::__isset | public | function | Implements the magic method for isset(). | ||||
ContentEntityBase::__set | public | function | Implements the magic method for setting object properties. | ||||
ContentEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | ||||
ContentEntityBase::__unset | public | function | Implements the magic method for unset(). | ||||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||||
DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | ||||
EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | ||||
EntityBase::$entityTypeId | protected | property | The entity type. | ||||
EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | ||||
EntityBase::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityInterface::create | |||
EntityBase::delete | public | function | Deletes an entity permanently. | Overrides EntityInterface::delete | 2 | ||
EntityBase::enforceIsNew | public | function | Enforces an entity to be new. | Overrides EntityInterface::enforceIsNew | |||
EntityBase::entityManager | Deprecated | protected | function | Gets the entity manager. | |||
EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | ||||
EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | ||||
EntityBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyTrait::getCacheContexts | |||
EntityBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyTrait::getCacheMaxAge | |||
EntityBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyTrait::getCacheTags | |||
EntityBase::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityInterface::getCacheTagsToInvalidate | 4 | ||
EntityBase::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | |||
EntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityInterface::getConfigDependencyName | 1 | ||
EntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityInterface::getConfigTarget | 1 | ||
EntityBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityInterface::getEntityType | |||
EntityBase::getEntityTypeId | public | function | Gets the ID of the type of the entity. | Overrides EntityInterface::getEntityTypeId | |||
EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | ||||
EntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityInterface::getOriginalId | 1 | ||
EntityBase::getTypedData | public | function | Gets a typed data object for this entity object. | Overrides EntityInterface::getTypedData | |||
EntityBase::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | Overrides EntityInterface::hasLinkTemplate | |||
EntityBase::invalidateTagsOnDelete | protected static | function | Invalidates an entity's cache tags upon delete. | 1 | |||
EntityBase::invalidateTagsOnSave | protected | function | Invalidates an entity's cache tags upon save. | 1 | |||
EntityBase::isNew | public | function | Determines whether the entity is new. | Overrides EntityInterface::isNew | 2 | ||
EntityBase::languageManager | protected | function | Gets the language manager. | ||||
EntityBase::link | public | function | Deprecated way of generating a link to the entity. See toLink(). | Overrides EntityInterface::link | 1 | ||
EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | |||
EntityBase::load | public static | function | Loads an entity. | Overrides EntityInterface::load | |||
EntityBase::loadMultiple | public static | function | Loads one or more entities. | Overrides EntityInterface::loadMultiple | |||
EntityBase::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityInterface::postDelete | 18 | ||
EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 2 | ||
EntityBase::preCreate | public static | function | Changes the values of an entity before it is created. | Overrides EntityInterface::preCreate | 7 | ||
EntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityInterface::preDelete | 6 | ||
EntityBase::save | public | function | Saves an entity permanently. | Overrides EntityInterface::save | 3 | ||
EntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityInterface::setOriginalId | 1 | ||
EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | |||
EntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityInterface::toUrl | 2 | ||
EntityBase::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | Overrides EntityInterface::uriRelationships | |||
EntityBase::url | public | function | Gets the public URL for this entity. | Overrides EntityInterface::url | 2 | ||
EntityBase::urlInfo | public | function | Gets the URL object for the entity. | Overrides EntityInterface::urlInfo | 1 | ||
EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | |||
EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | ||||
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip when checking for changes. | Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |||
Message::baseFieldDefinitions | public static | function | Overrides ContentEntityBase::baseFieldDefinitions | ||||
Message::copySender | public | function | Returns TRUE if a copy should be sent to the sender. | Overrides MessageInterface::copySender | |||
Message::getContactForm | public | function | Returns the form this contact message belongs to. | Overrides MessageInterface::getContactForm | |||
Message::getMessage | public | function | Returns the message body. | Overrides MessageInterface::getMessage | |||
Message::getPersonalRecipient | public | function | Returns the user this message is being sent to. | Overrides MessageInterface::getPersonalRecipient | |||
Message::getSenderMail | public | function | Returns the email address of the sender. | Overrides MessageInterface::getSenderMail | |||
Message::getSenderName | public | function | Returns the name of the sender. | Overrides MessageInterface::getSenderName | |||
Message::getSubject | public | function | Returns the message subject. | Overrides MessageInterface::getSubject | |||
Message::isPersonal | public | function | Returns TRUE if this is the personal contact form. | Overrides MessageInterface::isPersonal | |||
Message::setCopySender | public | function | Sets if the sender should receive a copy of this email or not. | Overrides MessageInterface::setCopySender | |||
Message::setMessage | public | function | Sets the email message to send. | Overrides MessageInterface::setMessage | |||
Message::setSenderMail | public | function | Sets the email address of the sender. | Overrides MessageInterface::setSenderMail | |||
Message::setSenderName | public | function | Sets the name of the message sender. | Overrides MessageInterface::setSenderName | |||
Message::setSubject | public | function | Sets the subject for the email. | Overrides MessageInterface::setSubject | |||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | ||||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | |||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | |||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | |||||
SynchronizableEntityTrait::$isSyncing | protected | property | Whether this entity is being created, updated or deleted through a synchronization process. |
||||
SynchronizableEntityTrait::isSyncing | public | function | |||||
SynchronizableEntityTrait::setSyncing | public | function | |||||
TranslationStatusInterface::TRANSLATION_CREATED | constant | Status code identifying a newly created translation. | |||||
TranslationStatusInterface::TRANSLATION_EXISTING | constant | Status code identifying an existing translation. | |||||
TranslationStatusInterface::TRANSLATION_REMOVED | constant | Status code identifying a removed translation. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.