class MetatagCustomCreateForm in Metatag Routes 8

Class MetatagCustomCreateForm.

@package Drupal\metatag_routes\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\metatag_routes\Form\MetatagCustomCreateForm

Expanded class hierarchy of MetatagCustomCreateForm

1 string reference to 'MetatagCustomCreateForm'

metatag_routes.routing.yml in ./metatag_routes.routing.yml: metatag_routes.routing.yml

File

src/Form/MetatagCustomCreateForm.php, line 18

Namespace

Drupal\metatag_routes\Form

View source

class MetatagCustomCreateForm extends FormBase {

  /**
   * Drupal\Core\Entity\EntityTypeManagerInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Drupal\Core\Routing\RouteProvider definition.
   *
   * @var \Drupal\Core\Routing\RouteProvider
   */
  protected $routeProvider;

  /**
   * Drupal\Core\Path\PathValidator definition.
   *
   * @var \Drupal\Core\Path\PathValidator
   */
  protected $pathValidator;

  /**
   * Drupal\Core\Routing\AdminContext definition.
   *
   * @var \Drupal\Core\Routing\AdminContext
   */
  protected $adminContext;

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, RouteProvider $route_provider, PathValidator $path_validator, AdminContext $admin_context) {
    $this->entityTypeManager = $entity_type_manager;
    $this->routeProvider = $route_provider;
    $this->pathValidator = $path_validator;
    $this->adminContext = $admin_context;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('router.route_provider'), $container
      ->get('path.validator'), $container
      ->get('router.admin_context'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'ok_metatag_custom_create_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['metatag_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path'),
      '#description' => $this
        ->t('Enter the path for which you want to add the metatags.'),
      '#maxlength' => 200,
      '#required' => TRUE,
    ];
    $form['route_name'] = [
      '#type' => 'hidden',
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    // Get the path given by the user.
    $url = trim($form_state
      ->getValue('metatag_url'));

    // Validate the url format.
    if (strpos($url, '/') === FALSE) {
      $form_state
        ->setErrorByName('metatag_url', $this
        ->t('The path must begin with /'));
      return FALSE;
    }

    // Get route name from path.
    $url_object = $this->pathValidator
      ->getUrlIfValid($url);
    if ($url_object) {
      $route_name = $url_object
        ->getRouteName();
      $route_object = $this->routeProvider
        ->getrouteByName($route_name);

      // Avoid administrative routes to have metatags.
      if ($this->adminContext
        ->isAdminRoute($route_object)) {
        $form_state
          ->setErrorByName('metatag_url', $this
          ->t('The admin routes should not have metatags.'));
        return FALSE;
      }

      // Avoid including entity routes.
      $params = $url_object
        ->getRouteParameters();
      $entity_type = !empty($params) ? key($params) : NULL;
      if (isset($entity_type) && in_array($entity_type, [
        'node',
        'taxonomy_term',
      ])) {
        $form_state
          ->setErrorByName('metatag_url', $this
          ->t('The entities routes metatags must be added by fields. @entity_type - @id', [
          '@entity_type' => $entity_type,
          '@id' => $params[$entity_type],
        ]));
        return FALSE;
      }

      // Validate that the route doesn't have metatags created already.
      $ids = $this->entityTypeManager
        ->getStorage('metatag_defaults')
        ->getQuery()
        ->condition('id', $route_name)
        ->execute();
      if ($ids) {
        $form_state
          ->setErrorByName('metatag_url', $this
          ->t('There are already metatags created for this route.'));
        return FALSE;
      }
      $form_state
        ->setValue('route_name', $route_name);
    }
    else {
      $form_state
        ->setErrorByName('metatag_url', $this
        ->t('The path does not exist as an internal Drupal route.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Get values for form submission.
    $route_name = $form_state
      ->getValue('route_name');
    $url = $form_state
      ->getValue('metatag_url');
    if ($route_name && $url) {

      // Create the new metatag entity.
      $entity = $this->entityTypeManager
        ->getStorage('metatag_defaults')
        ->create([
        'id' => $route_name,
        'label' => $url,
      ]);
      $entity
        ->save();
      $this
        ->messenger()
        ->addStatus($this
        ->t('Created metatags for the path: @url. Internal route: @route.', [
        '@url' => $url,
        '@route' => $route_name,
      ]));

      // Redirect to metatag edit page.
      $form_state
        ->setRedirect('entity.metatag_defaults.edit_form', [
        'metatag_defaults' => $route_name,
      ]);
    }
    else {
      $this
        ->messenger()
        ->addError($this
        ->t('The metatags could not be created for the path: @url.', [
        '@url' => $url,
      ]));

      // Redirect to metatag edit page.
      $form_state
        ->setRedirect('entity.metatag_defaults.collection');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
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.
MetatagCustomCreateForm::$adminContext	protected	property	Drupal\Core\Routing\AdminContext definition.
MetatagCustomCreateForm::$entityTypeManager	protected	property	Drupal\Core\Entity\EntityTypeManagerInterface definition.
MetatagCustomCreateForm::$pathValidator	protected	property	Drupal\Core\Path\PathValidator definition.
MetatagCustomCreateForm::$routeProvider	protected	property	Drupal\Core\Routing\RouteProvider definition.
MetatagCustomCreateForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
MetatagCustomCreateForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
MetatagCustomCreateForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MetatagCustomCreateForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
MetatagCustomCreateForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
MetatagCustomCreateForm::__construct	public	function
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.

You are here

class MetatagCustomCreateForm in Metatag Routes 8

Hierarchy

File

Namespace

Members

API Navigation