You are here

Home » API reference » Simple XML sitemap 8.2 » FormHelper.php

class FormHelper in Simple XML sitemap 8.2

Same name and namespace in other branches
  1. 8.3 src/Form/FormHelper.php \Drupal\simple_sitemap\Form\FormHelper
  2. 4.x src/Form/FormHelper.php \Drupal\simple_sitemap\Form\FormHelper

Class FormHelper @package Drupal\simple_sitemap\Form

Hierarchy

Expanded class hierarchy of FormHelper

1 string reference to 'FormHelper'
simple_sitemap.services.yml in ./simple_sitemap.services.yml
simple_sitemap.services.yml
1 service uses FormHelper
simple_sitemap.form_helper in ./simple_sitemap.services.yml
Drupal\simple_sitemap\Form\FormHelper

File

src/Form/FormHelper.php, line 15

Namespace

Drupal\simple_sitemap\Form
View source 
class FormHelper {
  use StringTranslationTrait;
  const PRIORITY_DEFAULT = 0.5;
  const PRIORITY_HIGHEST = 10;
  const PRIORITY_DIVIDER = 10;

  /**
   * @var \Drupal\simple_sitemap\Simplesitemap
   */
  protected $generator;

  /**
   * @var \Drupal\simple_sitemap\EntityHelper
   */
  protected $entityHelper;

  /**
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * @var \Drupal\Core\Form\FormState
   */
  protected $formState;

  /**
   * @var string|null
   */
  protected $entityCategory;

  /**
   * @var string
   */
  protected $entityTypeId;

  /**
   * @var string
   */
  protected $bundleName;

  /**
   * @var string
   */
  protected $instanceId;
  protected static $allowedFormOperations = [
    'default',
    'edit',
    'add',
    'register',
  ];
  protected static $changefreqValues = [
    'always',
    'hourly',
    'daily',
    'weekly',
    'monthly',
    'yearly',
    'never',
  ];
  protected static $valuesToCheck = [
    'simple_sitemap_index_content',
    'simple_sitemap_priority',
    'simple_sitemap_changefreq',
    'simple_sitemap_include_images',
    'simple_sitemap_regenerate_now',
  ];

  /**
   * FormHelper constructor.
   * @param \Drupal\simple_sitemap\Simplesitemap $generator
   * @param \Drupal\simple_sitemap\EntityHelper $entityHelper
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   */
  public function __construct(Simplesitemap $generator, EntityHelper $entityHelper, AccountProxyInterface $current_user) {
    $this->generator = $generator;
    $this->entityHelper = $entityHelper;
    $this->currentUser = $current_user;
  }

  /**
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   * @return bool
   */
  public function processForm(FormStateInterface $form_state) {
    $this->formState = $form_state;
    $this
      ->cleanUpFormInfo();
    $this
      ->getEntityDataFromFormEntity();
    return $this
      ->supports();
  }

  /**
   * @param string $entity_category
   * @return $this
   */
  public function setEntityCategory($entity_category) {
    $this->entityCategory = $entity_category;
    return $this;
  }

  /**
   * @return null|string
   */
  public function getEntityCategory() {
    return $this->entityCategory;
  }

  /**
   * @param string $entity_type_id
   * @return $this
   */
  public function setEntityTypeId($entity_type_id) {
    $this->entityTypeId = $entity_type_id;
    return $this;
  }

  /**
   * @return string
   */
  public function getEntityTypeId() {
    return $this->entityTypeId;
  }

  /**
   * @param string $bundle_name
   * @return $this
   */
  public function setBundleName($bundle_name) {
    $this->bundleName = $bundle_name;
    return $this;
  }

  /**
   * @return string
   */
  public function getBundleName() {
    return $this->bundleName;
  }

  /**
   * @param string $instance_id
   * @return $this
   */
  public function setInstanceId($instance_id) {
    $this->instanceId = $instance_id;
    return $this;
  }

  /**
   * @return string
   */
  public function getInstanceId() {
    return $this->instanceId;
  }

  /**
   * @return bool
   */
  protected function supports() {

    // Do not alter the form if user lacks certain permissions.
    if (!$this->currentUser
      ->hasPermission('administer sitemap settings')) {
      return FALSE;
    }
    elseif (empty($this
      ->getEntityCategory())) {
      return FALSE;
    }
    elseif (!$this->generator
      ->entityTypeIsEnabled($this
      ->getEntityTypeId())) {
      return FALSE;
    }
    elseif ($this
      ->getEntityCategory() === 'instance' && !$this->generator
      ->bundleIsIndexed($this
      ->getEntityTypeId(), $this
      ->getBundleName())) {
      return FALSE;
    }
    return TRUE;
  }

  /**
   * @param array $form_fragment
   */
  public function displayRegenerateNow(&$form_fragment) {
    $form_fragment['simple_sitemap_regenerate_now'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Regenerate sitemap after hitting <em>Save</em>'),
      '#description' => $this
        ->t('This setting will regenerate the whole sitemap including the above changes.'),
      '#default_value' => FALSE,
    ];
    if ($this->generator
      ->getSetting('cron_generate')) {
      $form_fragment['simple_sitemap_regenerate_now']['#description'] .= '</br>' . $this
        ->t('Otherwise the sitemap will be regenerated during a future cron run.');
    }
  }

  /**
   * @param array $form_fragment
   * @param bool $multiple
   * @return $this
   */
  public function displayEntitySettings(&$form_fragment, $multiple = FALSE) {
    $prefix = $multiple ? $this
      ->getEntityTypeId() . '_' : '';
    if ($this
      ->getEntityCategory() === 'instance') {
      $bundle_settings = $this->generator
        ->getBundleSettings($this
        ->getEntityTypeId(), $this
        ->getBundleName());
      $settings = NULL !== $this
        ->getInstanceId() ? $this->generator
        ->getEntityInstanceSettings($this
        ->getEntityTypeId(), $this
        ->getInstanceId()) : $bundle_settings;
    }
    else {
      $settings = $this->generator
        ->getBundleSettings($this
        ->getEntityTypeId(), $this
        ->getBundleName());
    }
    Simplesitemap::supplementDefaultSettings('entity', $settings, [
      'index' => 0,
    ]);
    $bundle_name = !empty($this
      ->getBundleName()) ? $this
      ->getBundleName() : $this
      ->t('undefined');

    // Index
    if (!$multiple) {
      $form_fragment[$prefix . 'simple_sitemap_index_content'] = [
        '#type' => 'radios',
        '#default_value' => $settings['index'],
        '#options' => [
          0 => $this
            ->getEntityCategory() === 'instance' ? $this
            ->t('Do not index this @bundle entity', [
            '@bundle' => $bundle_name,
          ]) : $this
            ->t('Do not index entities of this type'),
          1 => $this
            ->getEntityCategory() === 'instance' ? $this
            ->t('Index this @bundle entity', [
            '@bundle' => $bundle_name,
          ]) : $this
            ->t('Index entities of this type'),
        ],
      ];
      if ($this
        ->getEntityCategory() === 'instance' && isset($bundle_settings['index'])) {
        $form_fragment[$prefix . 'simple_sitemap_index_content']['#options'][$bundle_settings['index']] .= ' <em>(' . $this
          ->t('default') . ')</em>';
      }
    }

    // Priority
    $form_fragment[$prefix . 'simple_sitemap_priority'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Priority'),
      '#description' => $this
        ->getEntityCategory() === 'instance' ? $this
        ->t('The priority this @bundle entity will have in the eyes of search engine bots.', [
        '@bundle' => $bundle_name,
      ]) : $this
        ->t('The priority entities of this type will have in the eyes of search engine bots.'),
      '#default_value' => $settings['priority'],
      '#options' => $this
        ->getPrioritySelectValues(),
    ];
    if ($this
      ->getEntityCategory() === 'instance' && isset($bundle_settings['priority'])) {
      $form_fragment[$prefix . 'simple_sitemap_priority']['#options'][$this
        ->formatPriority($bundle_settings['priority'])] .= ' (' . $this
        ->t('default') . ')';
    }

    // Changefreq
    $form_fragment[$prefix . 'simple_sitemap_changefreq'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Change frequency'),
      '#description' => $this
        ->getEntityCategory() === 'instance' ? $this
        ->t('The frequency with which this @bundle entity changes. Search engine bots may take this as an indication of how often to index it.', [
        '@bundle' => $bundle_name,
      ]) : $this
        ->t('The frequency with which entities of this type change. Search engine bots may take this as an indication of how often to index them.'),
      '#default_value' => $settings['changefreq'],
      '#options' => $this
        ->getChangefreqSelectValues(),
    ];
    if ($this
      ->getEntityCategory() === 'instance' && isset($bundle_settings['changefreq'])) {
      $form_fragment[$prefix . 'simple_sitemap_changefreq']['#options'][$bundle_settings['changefreq']] .= ' (' . $this
        ->t('default') . ')';
    }

    // Images
    $form_fragment[$prefix . 'simple_sitemap_include_images'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Include images'),
      '#description' => $this
        ->getEntityCategory() === 'instance' ? $this
        ->t('Determines if images referenced by this @bundle entity should be included in the sitemap.', [
        '@bundle' => $bundle_name,
      ]) : $this
        ->t('Determines if images referenced by entities of this type should be included in the sitemap.'),
      '#default_value' => $settings['include_images'],
      '#options' => [
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ],
    ];
    if ($this
      ->getEntityCategory() === 'instance' && isset($bundle_settings['include_images'])) {
      $form_fragment[$prefix . 'simple_sitemap_include_images']['#options'][$bundle_settings['include_images']] .= ' (' . $this
        ->t('default') . ')';
    }
    return $this;
  }

  /**
   * Checks if this particular form is a bundle form, or a bundle instance form
   * and gathers sitemap settings from the database.
   *
   * @return bool
   *   TRUE if this is a bundle or bundle instance form, FALSE otherwise.
   */
  protected function getEntityDataFromFormEntity() {
    if (!($form_entity = $this
      ->getFormEntity())) {
      return FALSE;
    }
    $entity_type_id = $form_entity
      ->getEntityTypeId();
    $sitemap_entity_types = $this->entityHelper
      ->getSupportedEntityTypes();
    if (isset($sitemap_entity_types[$entity_type_id])) {
      $this
        ->setEntityCategory('instance');
    }
    else {

      /**
       * @var \Drupal\Core\Entity\EntityType $sitemap_entity_type
       */
      foreach ($sitemap_entity_types as $sitemap_entity_type) {
        if ($sitemap_entity_type
          ->getBundleEntityType() === $entity_type_id) {
          $this
            ->setEntityCategory('bundle');
          break;
        }
      }
    }

    // Menu fix.
    $this
      ->setEntityCategory(NULL === $this
      ->getEntityCategory() && $entity_type_id === 'menu' ? 'bundle' : $this
      ->getEntityCategory());
    switch ($this
      ->getEntityCategory()) {
      case 'bundle':
        $this
          ->setEntityTypeId($this->entityHelper
          ->getBundleEntityTypeId($form_entity));
        $this
          ->setBundleName($form_entity
          ->id());
        $this
          ->setInstanceId(NULL);
        break;
      case 'instance':
        $this
          ->setEntityTypeId($entity_type_id);
        $this
          ->setBundleName($this->entityHelper
          ->getEntityInstanceBundleName($form_entity));

        // New menu link's id is '' instead of NULL, hence checking for empty.
        $this
          ->setInstanceId(!empty($form_entity
          ->id()) ? $form_entity
          ->id() : NULL);
        break;
      default:
        return FALSE;
    }
    return TRUE;
  }

  /**
   * Gets the object entity of the form if available.
   *
   * @return \Drupal\Core\Entity\Entity|false
   *   Entity or FALSE if non-existent or if form operation is
   *   'delete'.
   */
  protected function getFormEntity() {
    $form_object = $this->formState
      ->getFormObject();
    if (NULL !== $form_object && method_exists($form_object, 'getOperation') && method_exists($form_object, 'getEntity') && in_array($form_object
      ->getOperation(), self::$allowedFormOperations)) {
      return $form_object
        ->getEntity();
    }
    return FALSE;
  }

  /**
   * Removes gathered form information from service object.
   *
   * Needed because this service may contain form info from the previous
   * operation when revived from the container.
   */
  protected function cleanUpFormInfo() {
    $this->entityCategory = NULL;
    $this->entityTypeId = NULL;
    $this->bundleName = NULL;
    $this->instanceId = NULL;
  }

  /**
   * Gets new entity Id after entity creation.
   * To be used in an entity form submit.
   *
   * @return int
   *   Entity ID.
   */
  public function getFormEntityId() {
    return $this->formState
      ->getFormObject()
      ->getEntity()
      ->id();
  }

  /**
   * Checks if simple_sitemap values have been changed after submitting the form.
   * To be used in an entity form submit.
   *
   * @param $form
   * @param array $values
   *
   * @return bool
   *   TRUE if simple_sitemap form values have been altered by the user.
   */
  public function valuesChanged($form, array $values) {
    foreach (self::$valuesToCheck as $field_name) {
      if (isset($values[$field_name]) && $values[$field_name] != $form['simple_sitemap'][$field_name]['#default_value']) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Gets the values needed to display the priority dropdown setting.
   *
   * @return array
   *   Select options.
   */
  public function getPrioritySelectValues() {
    $options = [];
    foreach (range(0, self::PRIORITY_HIGHEST) as $value) {
      $value = $this
        ->formatPriority($value / self::PRIORITY_DIVIDER);
      $options[$value] = $value;
    }
    return $options;
  }

  /**
   * Gets the values needed to display the changefreq dropdown setting.
   *
   * @return array
   *   Select options.
   */
  public function getChangefreqSelectValues() {
    $options = [
      '' => $this
        ->t('- Not specified -'),
    ];
    foreach (self::$changefreqValues as $setting) {
      $options[$setting] = $this
        ->t($setting);
    }
    return $options;
  }

  /**
   * @return array
   */
  public static function getChangefreqOptions() {
    return self::$changefreqValues;
  }

  /**
   * @param string $priority
   * @return string
   */
  public function formatPriority($priority) {
    return number_format((double) $priority, 1, '.', '');
  }

  /**
   * @param string|int $priority
   * @return bool
   */
  public static function isValidPriority($priority) {
    return is_numeric($priority) && $priority >= 0 && $priority <= 1;
  }

  /**
   * @param string $changefreq
   * @return bool
   */
  public static function isValidChangefreq($changefreq) {
    return in_array($changefreq, self::$changefreqValues);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FormHelper::$allowedFormOperations protected static property
FormHelper::$bundleName protected property
FormHelper::$changefreqValues protected static property
FormHelper::$currentUser protected property
FormHelper::$entityCategory protected property
FormHelper::$entityHelper protected property
FormHelper::$entityTypeId protected property
FormHelper::$formState protected property
FormHelper::$generator protected property
FormHelper::$instanceId protected property
FormHelper::$valuesToCheck protected static property
FormHelper::cleanUpFormInfo protected function Removes gathered form information from service object.
FormHelper::displayEntitySettings public function
FormHelper::displayRegenerateNow public function
FormHelper::formatPriority public function
FormHelper::getBundleName public function
FormHelper::getChangefreqOptions public static function
FormHelper::getChangefreqSelectValues public function Gets the values needed to display the changefreq dropdown setting.
FormHelper::getEntityCategory public function
FormHelper::getEntityDataFromFormEntity protected function Checks if this particular form is a bundle form, or a bundle instance form and gathers sitemap settings from the database.
FormHelper::getEntityTypeId public function
FormHelper::getFormEntity protected function Gets the object entity of the form if available.
FormHelper::getFormEntityId public function Gets new entity Id after entity creation. To be used in an entity form submit.
FormHelper::getInstanceId public function
FormHelper::getPrioritySelectValues public function Gets the values needed to display the priority dropdown setting.
FormHelper::isValidChangefreq public static function
FormHelper::isValidPriority public static function
FormHelper::PRIORITY_DEFAULT constant
FormHelper::PRIORITY_DIVIDER constant
FormHelper::PRIORITY_HIGHEST constant
FormHelper::processForm public function
FormHelper::setBundleName public function
FormHelper::setEntityCategory public function
FormHelper::setEntityTypeId public function
FormHelper::setInstanceId public function
FormHelper::supports protected function
FormHelper::valuesChanged public function Checks if simple_sitemap values have been changed after submitting the form. To be used in an entity form submit.
FormHelper::__construct public function FormHelper constructor.
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.