You are here

Home » API reference » Zircon Profile 8 » Message.php

class Message in Zircon Profile 8

Same name in this branch
  1. 8 vendor/zendframework/zend-stdlib/src/Message.php \Zend\Stdlib\Message
  2. 8 vendor/symfony/psr-http-message-bridge/Tests/Fixtures/Message.php \Symfony\Bridge\PsrHttpMessage\Tests\Fixtures\Message
  3. 8 core/modules/contact/src/Entity/Message.php \Drupal\contact\Entity\Message
Same name and namespace in other branches
  1. 8.0 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"),
  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

Expanded class hierarchy of Message

1 file declares its use of Message
ContactStorageTest.php in core/modules/contact/src/Tests/ContactStorageTest.php
Contains \Drupal\contact\Tests\ContactStorageTest.
17 string references to 'Message'
Abstract2Dot5ApiTest::testNoDuplicateValidationIfClassConstraintInMultipleGroups in vendor/symfony/validator/Tests/Validator/Abstract2Dot5ApiTest.php
Abstract2Dot5ApiTest::testNoDuplicateValidationIfPropertyConstraintInMultipleGroups in vendor/symfony/validator/Tests/Validator/Abstract2Dot5ApiTest.php
Abstract2Dot5ApiTest::testTraversalEnabledOnClass in vendor/symfony/validator/Tests/Validator/Abstract2Dot5ApiTest.php
AbstractValidatorTest::testValidateDifferentObjectsSeparately in vendor/symfony/validator/Tests/Validator/AbstractValidatorTest.php
AbstractValidatorTest::testValidateMultipleGroups in vendor/symfony/validator/Tests/Validator/AbstractValidatorTest.php

... See full list

File

core/modules/contact/src/Entity/Message.php, line 39
Contains \Drupal\contact\Entity\Message.

Namespace

Drupal\contact\Entity
View 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) {
    $fields['contact_form'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Form ID'))
      ->setDescription(t('The ID of the associated form.'))
      ->setSetting('target_type', 'contact_form')
      ->setRequired(TRUE);
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('UUID'))
      ->setDescription(t('The message UUID.'))
      ->setReadOnly(TRUE);
    $fields['langcode'] = BaseFieldDefinition::create('language')
      ->setLabel(t('Language'))
      ->setDescription(t('The message language code.'))
      ->setDisplayOptions('form', array(
      'type' => 'language_select',
      'weight' => 2,
    ));
    $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', array(
      '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', array(
      'type' => 'string_textarea',
      'weight' => 0,
      'settings' => array(
        'rows' => 12,
      ),
    ))
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayOptions('view', array(
      '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

Namesort descending Modifiers Type Description Overrides
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::$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::$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::$newRevision protected property Boolean indicating whether a new revision should be created on save.
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 Entity::access 1
ContentEntityBase::addTranslation public function Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides Entity::bundle
ContentEntityBase::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions 3
ContentEntityBase::clearTranslationCache protected function Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides Entity::createDuplicate 1
ContentEntityBase::get public function Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined.
ContentEntityBase::getFieldDefinition public function Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions public function Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields public function Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getIterator public function
ContentEntityBase::getLanguages protected function
ContentEntityBase::getRevisionId public function Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields public function Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages public function Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getUntranslated public function Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField public function Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation public function Returns TRUE there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. Overrides ContentEntityInterface::hasTranslationChanges
ContentEntityBase::id public function Gets the identifier. Overrides Entity::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation public function Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isNewRevision public function Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation public function Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. Overrides ContentEntityInterface::isRevisionTranslationAffected
ContentEntityBase::isTranslatable public function Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired public function Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::label public function Gets the label of the entity. Overrides Entity::label 3
ContentEntityBase::language public function Gets the language of the entity. Overrides Entity::language
ContentEntityBase::onChange public function Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate public function Acts on an entity after it is created but before hooks are invoked. Overrides Entity::postCreate
ContentEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides Entity::preSave 5
ContentEntityBase::preSaveRevision public function Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision 2
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides Entity::referencedEntities 1
ContentEntityBase::removeTranslation public function Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set public function Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setNewRevision public function Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected public function Marks the current revision translation as affected. Overrides ContentEntityInterface::setRevisionTranslationAffected
ContentEntityBase::setValidationRequired public function Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray public function Gets an array of all property values. Overrides Entity::toArray
ContentEntityBase::TRANSLATION_CREATED constant Status code identifying a newly created translation.
ContentEntityBase::TRANSLATION_EXISTING constant Status code identifying an existing translation.
ContentEntityBase::TRANSLATION_REMOVED constant Status code identifying a removed translation.
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides Entity::uuid
ContentEntityBase::validate public function Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides Entity::__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 Entity::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
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
Entity::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId protected property The entity type.
Entity::$typedData protected property A typed data object wrapping this entity.
Entity::create public static function Overrides EntityInterface::create
Entity::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
Entity::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated protected function Gets the entity manager.
Entity::entityTypeManager protected function Gets the entity type manager.
Entity::getCacheContexts public function The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags public function The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 3
Entity::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 1
Entity::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 1
Entity::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 1
Entity::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::invalidateTagsOnDelete protected static function Invalidates an entity's cache tags upon delete. 1
Entity::invalidateTagsOnSave protected function Invalidates an entity's cache tags upon save. 1
Entity::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
Entity::languageManager protected function Gets the language manager.
Entity::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link 1
Entity::linkTemplates protected function Gets an array link templates. 1
Entity::load public static function Overrides EntityInterface::load
Entity::loadMultiple public static function Overrides EntityInterface::loadMultiple
Entity::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 14
Entity::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
Entity::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 20
Entity::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 6
Entity::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 5
Entity::save public function Saves an entity permanently. Overrides EntityInterface::save 2
Entity::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
Entity::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 1
Entity::uriRelationships public function Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::url public function Gets the public URL for this entity. Overrides EntityInterface::url 2
Entity::urlInfo public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo 1
Entity::urlRouteParameters protected function Gets an array of placeholders for this entity. 1
Entity::uuidGenerator protected function Gets the UUID generator.
Message::baseFieldDefinitions public static function Provides base field definitions for an entity type. Overrides FieldableEntityInterface::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::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function