ContactForm.php in Drupal 9
Same filename and directory in other branches
Namespace
Drupal\contact\EntityFile
core/modules/contact/src/Entity/ContactForm.phpView source
<?php
namespace Drupal\contact\Entity;
use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
use Drupal\contact\ContactFormInterface;
use Drupal\Core\Url;
/**
* Defines the contact form entity.
*
* @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",
* }
* )
*/
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;
}
}
Classes
Name | Description |
---|---|
ContactForm | Defines the contact form entity. |