class YamlFormController in YAML Form 8

Provides route responses for form.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\yamlform\Controller\YamlFormController implements ContainerInjectionInterface

Expanded class hierarchy of YamlFormController

1 file declares its use of YamlFormController

YamlFormSubmissionForm.php in src/YamlFormSubmissionForm.php

File

src/Controller/YamlFormController.php, line 18

Namespace

Drupal\yamlform\Controller

View source

class YamlFormController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * Form request handler.
   *
   * @var \Drupal\yamlform\YamlFormRequestInterface
   */
  protected $requestHandler;

  /**
   * Constructs a new YamlFormSubmissionController object.
   *
   * @param \Drupal\yamlform\YamlFormRequestInterface $request_handler
   *   The form request handler.
   */
  public function __construct(YamlFormRequestInterface $request_handler) {
    $this->requestHandler = $request_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('yamlform.request'));
  }

  /**
   * Returns a form to add a new submission to a form.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\yamlform\YamlFormInterface $yamlform
   *   The form this submission will be added to.
   *
   * @return array
   *   The form submission form.
   */
  public function addForm(Request $request, YamlFormInterface $yamlform) {
    return $yamlform
      ->getSubmissionForm();
  }

  /**
   * Returns a form's CSS.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\yamlform\YamlFormInterface $yamlform
   *   The form.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  public function css(Request $request, YamlFormInterface $yamlform) {
    return new Response($yamlform
      ->getCss(), 200, [
      'Content-Type' => 'text/css',
    ]);
  }

  /**
   * Returns a form's JavaScript.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\yamlform\YamlFormInterface $yamlform
   *   The form.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  public function javascript(Request $request, YamlFormInterface $yamlform) {
    return new Response($yamlform
      ->getJavaScript(), 200, [
      'Content-Type' => 'text/javascript',
    ]);
  }

  /**
   * Returns a form confirmation page.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\yamlform\YamlFormInterface|null $yamlform
   *   A form.
   *
   * @return array
   *   A render array representing a form confirmation page
   */
  public function confirmation(Request $request, YamlFormInterface $yamlform = NULL) {

    /** @var \Drupal\Core\Entity\EntityInterface $source_entity */
    if (!$yamlform) {
      list($yamlform, $source_entity) = $this->requestHandler
        ->getYamlFormEntities();
    }
    else {
      $source_entity = $this->requestHandler
        ->getCurrentSourceEntity('yamlform');
    }

    /** @var \Drupal\yamlform\YamlFormSubmissionInterface $yamlform_submission */
    $yamlform_submission = NULL;
    if ($token = $request
      ->get('token')) {

      /** @var \Drupal\yamlform\YamlFormSubmissionStorageInterface $yamlform_submission_storage */
      $yamlform_submission_storage = $this
        ->entityTypeManager()
        ->getStorage('yamlform_submission');
      if ($entities = $yamlform_submission_storage
        ->loadByProperties([
        'token' => $token,
      ])) {
        $yamlform_submission = reset($entities);
      }
    }
    return [
      '#title' => $source_entity ? $source_entity
        ->label() : $yamlform
        ->label(),
      '#theme' => 'yamlform_confirmation',
      '#yamlform' => $yamlform,
      '#source_entity' => $source_entity,
      '#yamlform_submission' => $yamlform_submission,
    ];
  }

  /**
   * Returns a form filter form autocomplete matches.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param bool $templates
   *   If TRUE, limit autocomplete matches to form templates.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function autocomplete(Request $request, $templates = FALSE) {
    $q = $request->query
      ->get('q');
    $yamlform_storage = $this
      ->entityTypeManager()
      ->getStorage('yamlform');
    $query = $yamlform_storage
      ->getQuery()
      ->condition('title', $q, 'CONTAINS')
      ->range(0, 10)
      ->sort('title');

    // Limit query to templates.
    if ($templates) {
      $query
        ->condition('template', TRUE);
    }
    elseif ($this
      ->moduleHandler()
      ->moduleExists('yamlform_templates')) {

      // Filter out templates if the yamlform_template.module is enabled.
      $query
        ->condition('template', FALSE);
    }
    $entity_ids = $query
      ->execute();
    if (empty($entity_ids)) {
      return new JsonResponse([]);
    }
    $yamlforms = $yamlform_storage
      ->loadMultiple($entity_ids);
    $matches = [];
    foreach ($yamlforms as $yamlform) {
      if ($yamlform
        ->access('view')) {
        $value = new FormattableMarkup('@label (@id)', [
          '@label' => $yamlform
            ->label(),
          '@id' => $yamlform
            ->id(),
        ]);
        $matches[] = [
          'value' => $value,
          'label' => $value,
        ];
      }
    }
    return new JsonResponse($matches);
  }

  /**
   * Route title callback.
   *
   * @param \Drupal\yamlform\YamlFormInterface|null $yamlform
   *   A form.
   *
   * @return string
   *   The form label as a render array.
   */
  public function title(YamlFormInterface $yamlform = NULL) {

    /** @var \Drupal\Core\Entity\EntityInterface $source_entity */
    if (!$yamlform) {
      list($yamlform, $source_entity) = $this->requestHandler
        ->getYamlFormEntities();
    }
    else {
      $source_entity = $this->requestHandler
        ->getCurrentSourceEntity('yamlform');
    }
    return $source_entity ? $source_entity
      ->label() : $yamlform
      ->label();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' 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.	1
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.
YamlFormController::$requestHandler	protected	property	Form request handler.
YamlFormController::addForm	public	function	Returns a form to add a new submission to a form.
YamlFormController::autocomplete	public	function	Returns a form filter form autocomplete matches.
YamlFormController::confirmation	public	function	Returns a form confirmation page.
YamlFormController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
YamlFormController::css	public	function	Returns a form's CSS.
YamlFormController::javascript	public	function	Returns a form's JavaScript.
YamlFormController::title	public	function	Route title callback.
YamlFormController::__construct	public	function	Constructs a new YamlFormSubmissionController object.

You are here

class YamlFormController in YAML Form 8

Hierarchy

File

Namespace

Members

API Navigation