class TourTipController in Tour UI 8

Handles page returns for tour tip.

Hierarchy

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

Expanded class hierarchy of TourTipController

File

src/Controller/TourTipController.php, line 20

Namespace

Drupal\tour_ui\Controller

View source

class TourTipController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The Tip plugin manager.
   *
   * @var \Drupal\tour\TipPluginManager
   */
  protected $tipPluginManager;

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The Request Stack Service.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * Constructs a new TourTipController object.
   *
   * @param \Drupal\tour\TipPluginManager $tipPluginManager
   *   The Tip Plugin Manager.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   The request stack service.
   */
  public function __construct(TipPluginManager $tipPluginManager, FormBuilderInterface $form_builder, RequestStack $requestStack) {
    $this->tipPluginManager = $tipPluginManager;
    $this->formBuilder = $form_builder;
    $this->requestStack = $requestStack;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.tour.tip'), $container
      ->get('form_builder'), $container
      ->get('request_stack'));
  }

  /**
   * Provides a creation form for a new tip to be added to a tour entity.
   *
   * @param \Drupal\tour\Entity\Tour $tour
   *   The tour in which the tip needs to be added to.
   * @param string $type
   *   The type of tip that will be added to the tour.
   *
   * @return array
   *   A renderable form array.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \Drupal\Core\Form\EnforcedResponseException
   * @throws \Drupal\Core\Form\FormAjaxException
   */
  public function add(Tour $tour, $type = '') {

    // We need a type to build this form.
    if (!$type) {
      throw new NotFoundHttpException();
    }

    // Default values.
    $defaults = [
      'plugin' => Html::escape($type),
      'weight' => $this->requestStack
        ->getCurrentRequest()->query
        ->get('weight'),
    ];

    // Build a new stub tip.
    $stub = $this->tipPluginManager
      ->createInstance($type, $defaults);

    // Attach the tour, tip and if it's new to the form.
    $form_state = new FormState();
    $form_state
      ->setFormState([
      '#tour' => $tour,
      '#tip' => $stub,
      '#new' => TRUE,
    ]);
    return $this->formBuilder
      ->buildForm('\\Drupal\\tour_ui\\Form\\TourTipForm', $form_state);
  }

  /**
   * Provides an edit form for tip to be updated against a tour entity.
   *
   * @param \Drupal\tour\Entity\Tour $tour
   *   The tour in which the tip is being edited against.
   * @param string $tip
   *   The identifier of tip that will be edited against the tour.
   *
   * @return array
   *   A renderable form array.
   *
   * @throws \Drupal\Core\Form\EnforcedResponseException
   * @throws \Drupal\Core\Form\FormAjaxException
   */
  public function edit(Tour $tour, $tip = '') {

    // We need a tip to build this form.
    if (!$tip && !$tour) {
      throw new NotFoundHttpException();
    }
    try {
      $the_tip = $tour
        ->getTip($tip);
    } catch (PluginNotFoundException $e) {
      throw new NotFoundHttpException();
    }

    // Attach the tour and tip.
    $form_state = new FormState();
    $form_state
      ->setFormState([
      '#tour' => $tour,
      '#tip' => $the_tip,
    ]);
    return $this->formBuilder
      ->buildForm('\\Drupal\\tour_ui\\Form\\TourTipForm', $form_state);
  }

}

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::$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.
TourTipController::$formBuilder	protected	property	The form builder. Overrides ControllerBase::$formBuilder
TourTipController::$requestStack	protected	property	The Request Stack Service.
TourTipController::$tipPluginManager	protected	property	The Tip plugin manager.
TourTipController::add	public	function	Provides a creation form for a new tip to be added to a tour entity.
TourTipController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
TourTipController::edit	public	function	Provides an edit form for tip to be updated against a tour entity.
TourTipController::__construct	public	function	Constructs a new TourTipController object.
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.

You are here

class TourTipController in Tour UI 8

Hierarchy

File

Namespace

Members

API Navigation