interface MessageInterface
Provides an interface defining a contact message entity.
Hierarchy
- interface \Drupal\Core\Entity\FieldableEntityInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\SynchronizableInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\TranslatableRevisionableInterface extends \Drupal\Core\Entity\TranslatableInterface, \Drupal\Core\Entity\RevisionableInterface
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable, \Drupal\Core\Entity\FieldableEntityInterface, \Drupal\Core\Entity\TranslatableRevisionableInterface, \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\contact\MessageInterface extends \Drupal\Core\Entity\ContentEntityInterface
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable, \Drupal\Core\Entity\FieldableEntityInterface, \Drupal\Core\Entity\TranslatableRevisionableInterface, \Drupal\Core\Entity\SynchronizableInterface
Expanded class hierarchy of MessageInterface
All classes that implement MessageInterface
2 files declare their use of MessageInterface
- MailHandlerTest.php in core/
modules/ contact/ tests/ src/ Unit/ MailHandlerTest.php - Message.php in core/
modules/ contact/ src/ Entity/ Message.php
File
-
core/
modules/ contact/ src/ MessageInterface.php, line 10
Namespace
Drupal\contactView source
interface MessageInterface extends ContentEntityInterface {
/**
* Returns the form this contact message belongs to.
*
* @return \Drupal\contact\ContactFormInterface
* The contact form entity.
*/
public function getContactForm();
/**
* Returns the name of the sender.
*
* @return string
* The name of the message sender.
*/
public function getSenderName();
/**
* Sets the name of the message sender.
*
* @param string $sender_name
* The name of the message sender.
*/
public function setSenderName($sender_name);
/**
* Returns the email address of the sender.
*
* @return string
* The email address of the message sender.
*/
public function getSenderMail();
/**
* Sets the email address of the sender.
*
* @param string $sender_mail
* The email address of the message sender.
*/
public function setSenderMail($sender_mail);
/**
* Returns the message subject.
*
* @return string
* The message subject.
*/
public function getSubject();
/**
* Sets the subject for the email.
*
* @param string $subject
* The message subject.
*/
public function setSubject($subject);
/**
* Returns the message body.
*
* @return string
* The message body.
*/
public function getMessage();
/**
* Sets the email message to send.
*
* @param string $message
* The message body.
*/
public function setMessage($message);
/**
* Returns TRUE if a copy should be sent to the sender.
*
* @return bool
* TRUE if a copy should be sent, FALSE if not.
*/
public function copySender();
/**
* Sets if the sender should receive a copy of this email or not.
*
* @param bool $inform
* TRUE if a copy should be sent, FALSE if not.
*/
public function setCopySender($inform);
/**
* Returns TRUE if this is the personal contact form.
*
* @return bool
* TRUE if the message bundle is personal.
*/
public function isPersonal();
/**
* Returns the user this message is being sent to.
*
* @return \Drupal\user\UserInterface
* The user entity of the recipient, NULL if this is not a personal message.
*/
public function getPersonalRecipient();
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| AccessibleInterface::access | public | function | Checks data value access. | 9 | |
| CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 | |
| CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 | |
| CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 | |
| EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 | |
| EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 | |
| EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 | |
| EntityInterface::delete | public | function | Deletes an entity permanently. | 2 | |
| EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 | |
| EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 | |
| EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 | |
| EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 | |
| EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 | |
| EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 | |
| EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 | |
| EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 | |
| EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 | |
| EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 | |
| EntityInterface::id | public | function | Gets the identifier. | 2 | |
| EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 | |
| EntityInterface::label | public | function | Gets the label of the entity. | 2 | |
| EntityInterface::language | public | function | Gets the language of the entity. | 2 | |
| EntityInterface::load | public static | function | Loads an entity. | 2 | |
| EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 | |
| EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 | |
| EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 | |
| EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 | |
| EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 | |
| EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 | |
| EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 | |
| EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 | |
| EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 | |
| EntityInterface::save | public | function | Saves an entity permanently. | 2 | |
| EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 | |
| EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 | |
| EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 | |
| EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 | |
| EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 | |
| FieldableEntityInterface::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. | 2 | |
| FieldableEntityInterface::bundleFieldDefinitions | public static | function | Provides field definitions for a specific bundle. | 2 | |
| FieldableEntityInterface::get | public | function | Gets a field item list. | 1 | |
| FieldableEntityInterface::getFieldDefinition | public | function | Gets the definition of a contained field. | 1 | |
| FieldableEntityInterface::getFieldDefinitions | public | function | Gets an array of field definitions of all contained fields. | 1 | |
| FieldableEntityInterface::getFields | public | function | Gets an array of all field item lists. | 1 | |
| FieldableEntityInterface::getTranslatableFields | public | function | Gets an array of field item lists for translatable fields. | 1 | |
| FieldableEntityInterface::hasField | public | function | Determines whether the entity has a field with the given name. | 1 | |
| FieldableEntityInterface::isValidationRequired | public | function | Checks whether entity validation is required before saving the entity. | 1 | |
| FieldableEntityInterface::onChange | public | function | Reacts to changes to a field. | 1 | |
| FieldableEntityInterface::set | public | function | Sets a field value. | 1 | |
| FieldableEntityInterface::setValidationRequired | public | function | Sets whether entity validation is required before saving the entity. | 1 | |
| FieldableEntityInterface::toArray | public | function | Gets an array of all field values. | Overrides EntityInterface::toArray | |
| FieldableEntityInterface::validate | public | function | Validates the currently set values. | 1 | |
| MessageInterface::copySender | public | function | Returns TRUE if a copy should be sent to the sender. | 1 | |
| MessageInterface::getContactForm | public | function | Returns the form this contact message belongs to. | 1 | |
| MessageInterface::getMessage | public | function | Returns the message body. | 1 | |
| MessageInterface::getPersonalRecipient | public | function | Returns the user this message is being sent to. | 1 | |
| MessageInterface::getSenderMail | public | function | Returns the email address of the sender. | 1 | |
| MessageInterface::getSenderName | public | function | Returns the name of the sender. | 1 | |
| MessageInterface::getSubject | public | function | Returns the message subject. | 1 | |
| MessageInterface::isPersonal | public | function | Returns TRUE if this is the personal contact form. | 1 | |
| MessageInterface::setCopySender | public | function | Sets if the sender should receive a copy of this email or not. | 1 | |
| MessageInterface::setMessage | public | function | Sets the email message to send. | 1 | |
| MessageInterface::setSenderMail | public | function | Sets the email address of the sender. | 1 | |
| MessageInterface::setSenderName | public | function | Sets the name of the message sender. | 1 | |
| MessageInterface::setSubject | public | function | Sets the subject for the email. | 1 | |
| RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 | |
| RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 | |
| RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 | |
| RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 | |
| RevisionableInterface::getLoadedRevisionId | public | function | Gets the loaded Revision ID of the entity. | 1 | |
| RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. | 1 | |
| RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. | 1 | |
| RevisionableInterface::isLatestRevision | public | function | Checks if this entity is the latest revision. | 1 | |
| RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. | 1 | |
| RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. | 1 | |
| RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | 1 | |
| RevisionableInterface::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | 1 | |
| RevisionableInterface::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | 1 | |
| SynchronizableInterface::isSyncing | public | function | Returns whether this entity is being changed as part of a synchronization. | 1 | |
| SynchronizableInterface::setSyncing | public | function | Sets the status of the synchronization flag. | 1 | |
| TranslatableInterface::addTranslation | public | function | Adds a new translation to the translatable object. | 1 | |
| TranslatableInterface::getTranslation | public | function | Gets a translation of the data. | 1 | |
| TranslatableInterface::getTranslationLanguages | public | function | Returns the languages the data is translated to. | 1 | |
| TranslatableInterface::getUntranslated | public | function | Returns the translatable object in the language it was created. | 1 | |
| TranslatableInterface::hasTranslation | public | function | Checks there is a translation for the given language code. | 1 | |
| TranslatableInterface::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. | 1 | |
| TranslatableInterface::isDefaultTranslation | public | function | Checks whether the translation is the default one. | 1 | |
| TranslatableInterface::isNewTranslation | public | function | Checks whether the translation is new. | 1 | |
| TranslatableInterface::isTranslatable | public | function | Returns the translation support status. | 1 | |
| TranslatableInterface::removeTranslation | public | function | Removes the translation identified by the given language code. | 1 | |
| TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly | public | function | Checks if untranslatable fields should affect only the default translation. | 1 | |
| TranslatableRevisionableInterface::isLatestTranslationAffectedRevision | public | function | Checks whether this is the latest revision affecting this translation. | 1 | |
| TranslatableRevisionableInterface::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. | 1 | |
| TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced | public | function | Checks if the revision translation affected flag value has been enforced. | 1 | |
| TranslatableRevisionableInterface::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. | 1 | |
| TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced | public | function | Enforces the revision translation affected flag value. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.