class ContactForm
Defines the contact form entity.
Plugin annotation
@ConfigEntityType(
  id = "contact_form",
  label = @Translation("Contact form"),
  label_collection = @Translation("Contact forms"),
  label_singular = @Translation("contact form"),
  label_plural = @Translation("contact forms"),
  label_count = @PluralTranslation(
    singular = "@count contact form",
    plural = "@count contact forms",
  ),
  handlers = {
    "access" = "Drupal\contact\ContactFormAccessControlHandler",
    "list_builder" = "Drupal\contact\ContactFormListBuilder",
    "form" = {
      "add" = "Drupal\contact\ContactFormEditForm",
      "edit" = "Drupal\contact\ContactFormEditForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm"
    }
  },
  config_prefix = "form",
  admin_permission = "administer contact forms",
  bundle_of = "contact_message",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  links = {
    "delete-form" = "/admin/structure/contact/manage/{contact_form}/delete",
    "edit-form" = "/admin/structure/contact/manage/{contact_form}",
    "collection" = "/admin/structure/contact",
    "canonical" = "/contact/{contact_form}",
  },
  config_export = {
    "id",
    "label",
    "recipients",
    "reply",
    "weight",
    "message",
    "redirect",
  }
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase extends \Drupal\Core\Config\Entity\ConfigEntityBase- class \Drupal\contact\Entity\ContactForm implements \Drupal\contact\ContactFormInterface extends \Drupal\Core\Config\Entity\ConfigEntityBundleBase
 
 
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase extends \Drupal\Core\Config\Entity\ConfigEntityBase
 
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of ContactForm
13 files declare their use of ContactForm
- ConfigTranslationListUiTest.php in core/modules/ config_translation/ tests/ src/ Functional/ ConfigTranslationListUiTest.php 
- contact.post_update.php in core/modules/ contact/ contact.post_update.php 
- Post update functions for Contact.
- ContactFieldsTest.php in core/modules/ contact/ tests/ src/ Kernel/ Views/ ContactFieldsTest.php 
- ContactFormResourceTestBase.php in core/modules/ contact/ tests/ src/ Functional/ Rest/ ContactFormResourceTestBase.php 
- ContactFormTest.php in core/modules/ jsonapi/ tests/ src/ Functional/ ContactFormTest.php 
File
- 
              core/modules/ contact/ src/ Entity/ ContactForm.php, line 55 
Namespace
Drupal\contact\EntityView source
class ContactForm extends ConfigEntityBundleBase implements ContactFormInterface {
  
  /**
   * The form ID.
   *
   * @var string
   */
  protected $id;
  
  /**
   * The human-readable label of the category.
   *
   * @var string
   */
  protected $label;
  
  /**
   * The message displayed to user on form submission.
   *
   * @var string
   */
  protected $message;
  
  /**
   * List of recipient email addresses.
   *
   * @var array
   */
  protected $recipients = [];
  
  /**
   * The path to redirect to on form submission.
   *
   * @var string
   */
  protected $redirect;
  
  /**
   * An auto-reply message.
   *
   * @var string
   */
  protected $reply = '';
  
  /**
   * The weight of the category.
   *
   * @var int
   */
  protected $weight = 0;
  
  /**
   * {@inheritdoc}
   */
  public function getMessage() {
    return $this->message;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setMessage($message) {
    $this->message = $message;
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRecipients() {
    return $this->recipients;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setRecipients($recipients) {
    $this->recipients = $recipients;
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRedirectPath() {
    return $this->redirect;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRedirectUrl() {
    if ($this->redirect) {
      $url = Url::fromUserInput($this->redirect);
    }
    else {
      $url = Url::fromRoute('<front>');
    }
    return $url;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setRedirectPath($redirect) {
    $this->redirect = $redirect;
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getReply() {
    return $this->reply;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setReply($reply) {
    $this->reply = $reply;
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->weight;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this->weight = $weight;
    return $this;
  }
}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. | ||||
| ConfigEntityBase::$isUninstalling | private | property | Whether the config is being deleted by the uninstall process. | ||||
| ConfigEntityBase::$langcode | protected | property | The language code of the entity's default language. | ||||
| ConfigEntityBase::$originalId | protected | property | The original ID of the configuration entity. | ||||
| ConfigEntityBase::$status | protected | property | The enabled/disabled status of the configuration entity. | 4 | |||
| ConfigEntityBase::$third_party_settings | protected | property | Third party entity settings. | ||||
| ConfigEntityBase::$trustedData | protected | property | Trust supplied data and not use configuration schema on save. | ||||
| ConfigEntityBase::$uuid | protected | property | The UUID for this entity. | ||||
| ConfigEntityBase::$_core | protected | property | Information maintained by Drupal core about configuration. | ||||
| ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | ||||
| ConfigEntityBase::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | Overrides ConfigEntityInterface::calculateDependencies | 13 | ||
| ConfigEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | ||
| ConfigEntityBase::disable | public | function | Disables the configuration entity. | Overrides ConfigEntityInterface::disable | 1 | ||
| ConfigEntityBase::enable | public | function | Enables the configuration entity. | Overrides ConfigEntityInterface::enable | |||
| ConfigEntityBase::get | public | function | Returns the value of a property. | Overrides ConfigEntityInterface::get | |||
| ConfigEntityBase::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityBase::getCacheTagsToInvalidate | 1 | ||
| ConfigEntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityBase::getConfigDependencyName | |||
| ConfigEntityBase::getConfigManager | protected static | function | Gets the configuration manager. | ||||
| ConfigEntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityBase::getConfigTarget | |||
| ConfigEntityBase::getDependencies | public | function | Gets the configuration dependencies. | Overrides ConfigEntityInterface::getDependencies | |||
| ConfigEntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityBase::getOriginalId | |||
| ConfigEntityBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |||
| ConfigEntityBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |||
| ConfigEntityBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |||
| ConfigEntityBase::getTypedConfig | protected | function | Gets the typed config manager. | ||||
| ConfigEntityBase::hasTrustedData | public | function | Gets whether on not the data is trusted. | Overrides ConfigEntityInterface::hasTrustedData | |||
| ConfigEntityBase::invalidateTagsOnDelete | protected static | function | Override to never invalidate the individual entities' cache tags; the config system already invalidates them. | Overrides EntityBase::invalidateTagsOnDelete | |||
| ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity's cache tag; the config system already invalidates it. | Overrides EntityBase::invalidateTagsOnSave | |||
| ConfigEntityBase::isInstallable | public | function | Checks whether this entity is installable. | Overrides ConfigEntityInterface::isInstallable | 2 | ||
| ConfigEntityBase::isNew | public | function | Overrides Entity::isNew(). | Overrides EntityBase::isNew | |||
| ConfigEntityBase::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | Overrides ConfigEntityInterface::isUninstalling | |||
| ConfigEntityBase::link | public | function | Deprecated way of generating a link to the entity. See toLink(). | Overrides EntityBase::link | |||
| ConfigEntityBase::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | Overrides ConfigEntityInterface::onDependencyRemoval | 7 | ||
| ConfigEntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::preDelete | 8 | ||
| ConfigEntityBase::save | public | function | Saves an entity permanently. | Overrides EntityBase::save | 1 | ||
| ConfigEntityBase::set | public | function | Sets the value of a property. | Overrides ConfigEntityInterface::set | |||
| ConfigEntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityBase::setOriginalId | |||
| ConfigEntityBase::setStatus | public | function | Sets the status of the configuration entity. | Overrides ConfigEntityInterface::setStatus | |||
| ConfigEntityBase::setThirdPartySetting | public | function | Sets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |||
| ConfigEntityBase::setUninstalling | public | function | |||||
| ConfigEntityBase::sort | public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 | |||
| ConfigEntityBase::status | public | function | Returns whether the configuration entity is enabled. | Overrides ConfigEntityInterface::status | 4 | ||
| ConfigEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | 2 | ||
| ConfigEntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityBase::toUrl | |||
| ConfigEntityBase::trustData | public | function | Sets that the data should be trusted. | Overrides ConfigEntityInterface::trustData | |||
| ConfigEntityBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |||
| ConfigEntityBase::url | public | function | Gets the public URL for this entity. | Overrides EntityBase::url | |||
| ConfigEntityBase::urlInfo | public | function | Gets the URL object for the entity. | Overrides EntityBase::urlInfo | |||
| ConfigEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | 10 | ||
| ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 4 | |||
| ConfigEntityBundleBase::deleteDisplays | protected | function | Deletes display if a bundle is deleted. | ||||
| ConfigEntityBundleBase::loadDisplays | protected | function | Returns view or form displays for this bundle. | ||||
| ConfigEntityBundleBase::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityBase::postDelete | 2 | ||
| ConfigEntityBundleBase::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityBase::postSave | 2 | ||
| ConfigEntityBundleBase::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides ConfigEntityBase::preSave | |||
| ContactForm::$id | protected | property | The form ID. | ||||
| ContactForm::$label | protected | property | The human-readable label of the category. | ||||
| ContactForm::$message | protected | property | The message displayed to user on form submission. | ||||
| ContactForm::$recipients | protected | property | List of recipient email addresses. | ||||
| ContactForm::$redirect | protected | property | The path to redirect to on form submission. | ||||
| ContactForm::$reply | protected | property | An auto-reply message. | ||||
| ContactForm::$weight | protected | property | The weight of the category. | ||||
| ContactForm::getMessage | public | function | Returns the message to be displayed to user. | Overrides ContactFormInterface::getMessage | |||
| ContactForm::getRecipients | public | function | Returns list of recipient email addresses. | Overrides ContactFormInterface::getRecipients | |||
| ContactForm::getRedirectPath | public | function | Returns the path for redirect. | Overrides ContactFormInterface::getRedirectPath | |||
| ContactForm::getRedirectUrl | public | function | Returns the url object for redirect path. | Overrides ContactFormInterface::getRedirectUrl | |||
| ContactForm::getReply | public | function | Returns an auto-reply message to send to the message author. | Overrides ContactFormInterface::getReply | |||
| ContactForm::getWeight | public | function | Returns the weight of this category (used for sorting). | Overrides ContactFormInterface::getWeight | |||
| ContactForm::setMessage | public | function | Sets the message to be displayed to the user. | Overrides ContactFormInterface::setMessage | |||
| ContactForm::setRecipients | public | function | Sets list of recipient email addresses. | Overrides ContactFormInterface::setRecipients | |||
| ContactForm::setRedirectPath | public | function | Sets the redirect path. | Overrides ContactFormInterface::setRedirectPath | |||
| ContactForm::setReply | public | function | Sets an auto-reply message to send to the message author. | Overrides ContactFormInterface::setReply | |||
| ContactForm::setWeight | public | function | Sets the weight. | Overrides ContactFormInterface::setWeight | |||
| 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 | ||||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | Aliased as: addDependencyTrait | |||
| 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::access | public | function | Checks data value access. | Overrides AccessibleInterface::access | 1 | ||
| EntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityInterface::bundle | 1 | ||
| 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::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | |||
| 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::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::id | public | function | Gets the identifier. | Overrides EntityInterface::id | 11 | ||
| EntityBase::label | public | function | Gets the label of the entity. | Overrides EntityInterface::label | 6 | ||
| EntityBase::language | public | function | Gets the language of the entity. | Overrides EntityInterface::language | 1 | ||
| EntityBase::languageManager | protected | function | Gets the language manager. | ||||
| 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::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityInterface::postCreate | 4 | ||
| 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::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityInterface::referencedEntities | 1 | ||
| EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | |||
| EntityBase::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | Overrides EntityInterface::uriRelationships | |||
| EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | |||
| EntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityInterface::uuid | 1 | ||
| EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | ||||
| PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | |||
| PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | ||||
| PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | |||
| PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | |||
| 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 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
