interface ContactFormInterface
Same name in other branches
- 9 core/modules/contact/src/ContactFormInterface.php \Drupal\contact\ContactFormInterface
- 8.9.x core/modules/contact/src/ContactFormInterface.php \Drupal\contact\ContactFormInterface
- 11.x core/modules/contact/src/ContactFormInterface.php \Drupal\contact\ContactFormInterface
Provides an interface defining a contact form entity.
Hierarchy
- interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\EntityInterface extends \Drupal\Core\Access\AccessibleInterface \Drupal\Core\Cache\CacheableDependencyInterface \Drupal\Core\Cache\RefinableCacheableDependencyInterface; interface \Drupal\Core\Entity\SynchronizableInterface extends \Drupal\Core\Entity\EntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\contact\ContactFormInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface
Expanded class hierarchy of ContactFormInterface
All classes that implement ContactFormInterface
5 files declare their use of ContactFormInterface
- ContactController.php in core/
modules/ contact/ src/ Controller/ ContactController.php - ContactForm.php in core/
modules/ contact/ src/ Entity/ ContactForm.php - ContactFormValidationTest.php in core/
modules/ contact/ tests/ src/ Kernel/ ContactFormValidationTest.php - contact_storage_test.module in core/
modules/ contact/ tests/ modules/ contact_storage_test/ contact_storage_test.module - Contains custom contact message functionality for ContactStorageTest.
- MigrateContactCategoryTest.php in core/
modules/ contact/ tests/ src/ Kernel/ Migrate/ MigrateContactCategoryTest.php
File
-
core/
modules/ contact/ src/ ContactFormInterface.php, line 10
Namespace
Drupal\contactView source
interface ContactFormInterface extends ConfigEntityInterface {
/**
* Returns the message to be displayed to user.
*
* @return string
* A user message.
*/
public function getMessage();
/**
* Returns list of recipient email addresses.
*
* @return array
* List of recipient email addresses.
*/
public function getRecipients();
/**
* Returns the path for redirect.
*
* @return string
* The redirect path.
*/
public function getRedirectPath();
/**
* Returns the \Drupal\Core\Url object for redirect path.
*
* Empty redirect property results a \Drupal\Core\Url object of front page.
*
* @return \Drupal\Core\Url
* The redirect \Drupal\Core\Url object.
*/
public function getRedirectUrl();
/**
* Returns an auto-reply message to send to the message author.
*
* @return string
* An auto-reply message
*/
public function getReply();
/**
* Returns the weight of this category (used for sorting).
*
* @return int
* The weight of this category.
*/
public function getWeight();
/**
* Sets the message to be displayed to the user.
*
* @param string $message
* The message to display after form is submitted.
*
* @return $this
*/
public function setMessage($message);
/**
* Sets list of recipient email addresses.
*
* @param array $recipients
* The desired list of email addresses of this category.
*
* @return $this
*/
public function setRecipients($recipients);
/**
* Sets the redirect path.
*
* @param string $redirect
* The desired path.
*
* @return $this
*/
public function setRedirectPath($redirect);
/**
* Sets an auto-reply message to send to the message author.
*
* @param string $reply
* The desired reply.
*
* @return $this
*/
public function setReply($reply);
/**
* Sets the weight.
*
* @param int $weight
* The desired weight.
*
* @return $this
*/
public function setWeight($weight);
}
Members
Title Sort descending | Modifiers | Object type | Summary | 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 |
ConfigEntityInterface::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface::disable | public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface::enable | public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface::get | public | function | Returns the value of a property. | 2 |
ConfigEntityInterface::getDependencies | public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface::hasTrustedData | public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface::isInstallable | public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface::set | public | function | Sets the value of a property. | 2 |
ConfigEntityInterface::setStatus | public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface::status | public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface::trustData | public | function | Sets that the data should be trusted. | 2 |
ContactFormInterface::getMessage | public | function | Returns the message to be displayed to user. | 1 |
ContactFormInterface::getRecipients | public | function | Returns list of recipient email addresses. | 1 |
ContactFormInterface::getRedirectPath | public | function | Returns the path for redirect. | 1 |
ContactFormInterface::getRedirectUrl | public | function | Returns the \Drupal\Core\Url object for redirect path. | 1 |
ContactFormInterface::getReply | public | function | Returns an auto-reply message to send to the message author. | 1 |
ContactFormInterface::getWeight | public | function | Returns the weight of this category (used for sorting). | 1 |
ContactFormInterface::setMessage | public | function | Sets the message to be displayed to the user. | 1 |
ContactFormInterface::setRecipients | public | function | Sets list of recipient email addresses. | 1 |
ContactFormInterface::setRedirectPath | public | function | Sets the redirect path. | 1 |
ContactFormInterface::setReply | public | function | Sets an auto-reply message to send to the message author. | 1 |
ContactFormInterface::setWeight | public | function | Sets the weight. | 1 |
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::toArray | public | function | Gets an array of all property values. | 3 |
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 |
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 |
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 |
ThirdPartySettingsInterface::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | 4 |
ThirdPartySettingsInterface::getThirdPartySetting | public | function | Gets the value of a third-party setting. | 4 |
ThirdPartySettingsInterface::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | 4 |
ThirdPartySettingsInterface::setThirdPartySetting | public | function | Sets the value of a third-party setting. | 4 |
ThirdPartySettingsInterface::unsetThirdPartySetting | public | function | Unsets a third-party setting. | 4 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.