www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/contact/src/ContactFormInterface.php

   1 <?php
   2
   3 namespace Drupal\contact;
   4
   5 use Drupal\Core\Config\Entity\ConfigEntityInterface;
   6
   7 /**
   8  * Provides an interface defining a contact form entity.
   9  */
  10 interface ContactFormInterface extends ConfigEntityInterface {
  11
  12   /**
  13    * Returns the message to be displayed to user.
  14    *
  15    * @return string
  16    *   A user message.
  17    */
  18   public function getMessage();
  19
  20   /**
  21    * Returns list of recipient email addresses.
  22    *
  23    * @return array
  24    *   List of recipient email addresses.
  25    */
  26   public function getRecipients();
  27
  28   /**
  29    * Returns the path for redirect.
  30    *
  31    * @return string
  32    *   The redirect path.
  33    */
  34   public function getRedirectPath();
  35
  36   /**
  37    * Returns the url object for redirect path.
  38    *
  39    * Empty redirect property results a url object of front page.
  40    *
  41    * @return \Drupal\core\Url
  42    *   The redirect url object.
  43    */
  44   public function getRedirectUrl();
  45
  46   /**
  47    * Returns an auto-reply message to send to the message author.
  48    *
  49    * @return string
  50    *   An auto-reply message
  51    */
  52   public function getReply();
  53
  54   /**
  55    * Returns the weight of this category (used for sorting).
  56    *
  57    * @return int
  58    *   The weight of this category.
  59    */
  60   public function getWeight();
  61
  62   /**
  63    * Sets the message to be displayed to the user.
  64    *
  65    * @param string $message
  66    *   The message to display after form is submitted.
  67    *
  68    * @return $this
  69    */
  70   public function setMessage($message);
  71
  72   /**
  73    * Sets list of recipient email addresses.
  74    *
  75    * @param array $recipients
  76    *   The desired list of email addresses of this category.
  77    *
  78    * @return $this
  79    */
  80   public function setRecipients($recipients);
  81
  82   /**
  83    * Sets the redirect path.
  84    *
  85    * @param string $redirect
  86    *   The desired path.
  87    *
  88    * @return $this
  89    */
  90   public function setRedirectPath($redirect);
  91
  92   /**
  93    * Sets an auto-reply message to send to the message author.
  94    *
  95    * @param string $reply
  96    *   The desired reply.
  97    *
  98    * @return $this
  99    */
 100   public function setReply($reply);
 101
 102   /**
 103    * Sets the weight.
 104    *
 105    * @param int $weight
 106    *   The desired weight.
 107    *
 108    * @return $this
 109    */
 110   public function setWeight($weight);
 111
 112 }