class Message
Same name in this branch
- 9 composer/Plugin/ProjectMessage/Message.php \Drupal\Composer\Plugin\ProjectMessage\Message
Same name and namespace in other branches
- 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 extends \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait implements \Drupal\Core\Entity\EntityBase
- class \Drupal\contact\Entity\Message extends \Drupal\contact\MessageInterface implements \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait implements \Drupal\Core\Entity\EntityBase
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
36 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 an 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
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;
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.