class ContactController in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/contact/src/Controller/ContactController.php \Drupal\contact\Controller\ContactController
Controller routines for contact routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\contact\Controller\ContactController
Expanded class hierarchy of ContactController
File
- core/
modules/ contact/ src/ Controller/ ContactController.php, line 20 - Contains \Drupal\contact\Controller\ContactController.
Namespace
Drupal\contact\ControllerView source
class ContactController extends ControllerBase {
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* Constructs a ContactController object.
*
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
*/
public function __construct(RendererInterface $renderer) {
$this->renderer = $renderer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('renderer'));
}
/**
* Presents the site-wide contact form.
*
* @param \Drupal\contact\ContactFormInterface $contact_form
* The contact form to use.
*
* @return array
* The form as render array as expected by drupal_render().
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
* Exception is thrown when user tries to access non existing default
* contact form.
*/
public function contactSitePage(ContactFormInterface $contact_form = NULL) {
$config = $this
->config('contact.settings');
// Use the default form if no form has been passed.
if (empty($contact_form)) {
$contact_form = $this
->entityManager()
->getStorage('contact_form')
->load($config
->get('default_form'));
// If there are no forms, do not display the form.
if (empty($contact_form)) {
if ($this
->currentUser()
->hasPermission('administer contact forms')) {
drupal_set_message($this
->t('The contact form has not been configured. <a href=":add">Add one or more forms</a> .', array(
':add' => $this
->url('contact.form_add'),
)), 'error');
return array();
}
else {
throw new NotFoundHttpException();
}
}
}
$message = $this
->entityManager()
->getStorage('contact_message')
->create(array(
'contact_form' => $contact_form
->id(),
));
$form = $this
->entityFormBuilder()
->getForm($message);
$form['#title'] = $contact_form
->label();
$form['#cache']['contexts'][] = 'user.permissions';
$this->renderer
->addCacheableDependency($form, $config);
return $form;
}
/**
* Form constructor for the personal contact form.
*
* @param \Drupal\user\UserInterface $user
* The account for which a personal contact form should be generated.
*
* @return array
* The personal contact form as render array as expected by drupal_render().
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
* Exception is thrown when user tries to access a contact form for a
* user who does not have an email address configured.
*/
public function contactPersonalPage(UserInterface $user) {
// Do not continue if the user does not have an email address configured.
if (!$user
->getEmail()) {
throw new NotFoundHttpException();
}
$message = $this
->entityManager()
->getStorage('contact_message')
->create(array(
'contact_form' => 'personal',
'recipient' => $user
->id(),
));
$form = $this
->entityFormBuilder()
->getForm($message);
$form['#title'] = $this
->t('Contact @username', array(
'@username' => $user
->getDisplayName(),
));
$form['#cache']['contexts'][] = 'user.permissions';
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContactController:: |
protected | property | The renderer. | |
ContactController:: |
public | function | Form constructor for the personal contact form. | |
ContactController:: |
public | function | Presents the site-wide contact form. | |
ContactController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
ContactController:: |
public | function | Constructs a ContactController object. | |
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity manager. | 1 |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 3 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity manager service. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 3 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns the state storage service. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Returns a redirect response object for the specified route. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |