Mercurial > hg > cmmr2012-drupal-site
diff core/modules/contact/src/ContactFormInterface.php @ 0:c75dbcec494b
Initial commit from drush-created site
author | Chris Cannam |
---|---|
date | Thu, 05 Jul 2018 14:24:15 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/modules/contact/src/ContactFormInterface.php Thu Jul 05 14:24:15 2018 +0000 @@ -0,0 +1,112 @@ +<?php + +namespace Drupal\contact; + +use Drupal\Core\Config\Entity\ConfigEntityInterface; + +/** + * Provides an interface defining a contact form entity. + */ +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 url object for redirect path. + * + * Empty redirect property results a url object of front page. + * + * @return \Drupal\core\Url + * The redirect 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); + +}