class ContactController

Same name in other branches
  1. 9 core/modules/contact/src/Controller/ContactController.php \Drupal\contact\Controller\ContactController
  2. 10 core/modules/contact/src/Controller/ContactController.php \Drupal\contact\Controller\ContactController
  3. 11.x core/modules/contact/src/Controller/ContactController.php \Drupal\contact\Controller\ContactController

Controller routines for contact routes.

Hierarchy

Expanded class hierarchy of ContactController

File

core/modules/contact/src/Controller/ContactController.php, line 16

Namespace

Drupal\contact\Controller
View 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\Core\Render\RendererInterface::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->entityTypeManager()
                ->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')) {
                    $this->messenger()
                        ->addError($this->t('The contact form has not been configured. <a href=":add">Add one or more forms</a> .', [
                        ':add' => Url::fromRoute('contact.form_add')->toString(),
                    ]));
                    return [];
                }
                else {
                    throw new NotFoundHttpException();
                }
            }
        }
        $message = $this->entityTypeManager()
            ->getStorage('contact_message')
            ->create([
            '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\Core\Render\RendererInterface::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->entityTypeManager()
            ->getStorage('contact_message')
            ->create([
            'contact_form' => 'personal',
            'recipient' => $user->id(),
        ]);
        $form = $this->entityFormBuilder()
            ->getForm($message);
        $form['#title'] = $this->t('Contact @username', [
            '@username' => $user->getDisplayName(),
        ]);
        $form['#cache']['contexts'][] = 'user.permissions';
        return $form;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
ContactController::$renderer protected property The renderer.
ContactController::contactPersonalPage public function Form constructor for the personal contact form.
ContactController::contactSitePage public function Presents the site-wide contact form.
ContactController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ContactController::__construct public function Constructs a ContactController object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.