You are here

Home » API reference » Real-time SEO for Drupal 8 » YoastSeoConfigForm.php

class YoastSeoConfigForm in Real-time SEO for Drupal 8

Class YoastSeoConfigForm.

@package Drupal\metatag\Form

Hierarchy

Expanded class hierarchy of YoastSeoConfigForm

File

src/Form/YoastSeoConfigForm.php, line 13

Namespace

Drupal\yoast_seo\Form
View source 
class YoastSeoConfigForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $yoast_seo_manager = \Drupal::service('yoast_seo.manager');

    // Available entity types supported by Yoast SEO.
    $entity_types = $this
      ->getAvailableEntityTypes();
    foreach ($entity_types as $entity_type => $entity_label) {

      // Get the available bundles Yoast SEO supports.
      $options = $yoast_seo_manager
        ->getAvailableBundles($entity_type);

      // Get the bundles Yoast SEO has been enabled for.
      $enabled_bundles = $yoast_seo_manager
        ->getEnabledBundles($entity_type);

      // Add a checkboxes collection to allow the administrator to
      // enable/disable Yoast SEO for supported bundles.
      $form[$entity_type] = array(
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('@label', array(
          '@label' => $entity_label,
        )),
        '#options' => $options,
        '#required' => FALSE,
        '#default_value' => $enabled_bundles,
      );
    }

    // Add a save action.
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    );
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $yoast_seo_manager = \Drupal::service('yoast_seo.manager');

    // Get the available entity types Yoast SEO supports.
    $entity_types = $this
      ->getAvailableEntityTypes();

    // Retrieve the form values.
    $values = $form_state
      ->getValues();

    // Fields to attach.
    $to_attach = [];

    // Fields to detach.
    $to_detach = [];

    // Foreach entity types Yoast SEO can be enable for, check the bundle the
    // administrator wants to enable/disable Yoast SEO for.
    foreach ($entity_types as $entity_type_id => $entity_type_label) {

      // Get the available bundles Yoast SEO supports.
      $bundles = $yoast_seo_manager
        ->getAvailableBundles($entity_type_id);

      // Get the bundles Yoast SEO has been enabled for.
      $enabled_bundles = $yoast_seo_manager
        ->getEnabledBundles($entity_type_id);

      // Foreach available bundles.
      foreach ($bundles as $bundle_id => $bundle_label) {

        // Yoast SEO is required to be enabled for.
        if (isset($values[$entity_type_id][$bundle_id]) && $values[$entity_type_id][$bundle_id] !== 0 && !in_array($bundle_id, $enabled_bundles)) {
          $to_attach[$entity_type_id][] = $bundle_id;
        }
        elseif (isset($values[$entity_type_id][$bundle_id]) && $values[$entity_type_id][$bundle_id] === 0 && in_array($bundle_id, $enabled_bundles)) {
          $to_detach[$entity_type_id][] = $bundle_id;
        }
      }
    }

    // Process fields to be attached.
    if (!empty($to_attach)) {

      // Add field to content view in case not already attached.
      $yoast_seo_manager
        ->attachFieldHandlerToContentView();

      // Attach fields to content types.
      foreach ($to_attach as $entity_type_id => $bundles) {
        foreach ($bundles as $bundle_id) {
          $yoast_seo_manager
            ->attachYoastSeoFields($entity_type_id, $bundle_id);
        }
      }
    }

    // Process fields to be detached.
    if (!empty($to_detach)) {

      // View management. If Yoast SEO is going to be deactivated for all
      // fields related to nodes.
      // Then we first detach the field from the view.
      if (!empty($to_detach['node'])) {
        $node_enabled_bundles = $yoast_seo_manager
          ->getEnabledBundles('node');

        // If list of fields to detach is equal to the currently enabled
        // bundles for node,
        // then we should remove the fields from the view.
        if (count($node_enabled_bundles) == count($to_detach['node'])) {
          $yoast_seo_manager
            ->detachFieldHandlerFromContentView();
        }
      }

      // Detach fields from content types.
      foreach ($to_detach as $entity_type_id => $bundles) {
        foreach ($bundles as $bundle_id) {
          $yoast_seo_manager
            ->detachYoastSeoFields($entity_type_id, $bundle_id);
        }
      }
    }
    \Drupal::messenger()
      ->addMessage($this
      ->t('Real-time SEO configuration by bundles has been saved successfully.'));
  }

  /**
   * Returns an array of available entity types Yoast SEO can be enabled for.
   *
   * @return array
   *   A list of available entity types as $id => $label.
   */
  protected function getAvailableEntityTypes() {

    // @todo Should be the same than the ones supported by the metatag module.
    return [
      'node' => 'Node',
    ];
  }

}

Members

Namesort descending 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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
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.
YoastSeoConfigForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
YoastSeoConfigForm::getAvailableEntityTypes protected function Returns an array of available entity types Yoast SEO can be enabled for.
YoastSeoConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
YoastSeoConfigForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
YoastSeoConfigForm::validateForm public function Form validation handler. Overrides FormBase::validateForm