FormHelper.php 14.1 KB
Newer Older
1 2
<?php

3
namespace Drupal\simple_sitemap\Form;
4

Pawel G's avatar
Pawel G committed
5
use Drupal\Core\Form\FormStateInterface;
6
use Drupal\Core\StringTranslation\StringTranslationTrait;
7
use Drupal\simple_sitemap\EntityHelper;
Pawel G's avatar
Pawel G committed
8 9
use Drupal\simple_sitemap\Simplesitemap;
use Drupal\Core\Session\AccountProxyInterface;
10

11
/**
Pawel G's avatar
Pawel G committed
12
 * Class FormHelper
13
 * @package Drupal\simple_sitemap\Form
14
 */
15
class FormHelper {
16
  use StringTranslationTrait;
17

Pawel G's avatar
Pawel G committed
18 19 20 21
  const PRIORITY_DEFAULT = 0.5;
  const PRIORITY_HIGHEST = 10;
  const PRIORITY_DIVIDER = 10;

Pawel G's avatar
Pawel G committed
22 23 24
  /**
   * @var \Drupal\simple_sitemap\Simplesitemap
   */
25
  protected $generator;
Pawel G's avatar
Pawel G committed
26 27 28 29

  /**
   * @var \Drupal\simple_sitemap\EntityHelper
   */
30
  protected $entityHelper;
Pawel G's avatar
Pawel G committed
31 32 33 34

  /**
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
35
  protected $currentUser;
Pawel G's avatar
Pawel G committed
36 37 38 39

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

Pawel G's avatar
Pawel G committed
42 43 44
  /**
   * @var string|null
   */
Pawel G's avatar
Pawel G committed
45
  protected $entityCategory;
Pawel G's avatar
Pawel G committed
46 47 48 49

  /**
   * @var string
   */
50
  protected $entityTypeId;
Pawel G's avatar
Pawel G committed
51 52 53 54

  /**
   * @var string
   */
55
  protected $bundleName;
Pawel G's avatar
Pawel G committed
56 57 58 59

  /**
   * @var string
   */
60
  protected $instanceId;
61

62
  protected static $allowedFormOperations = [
63 64 65
    'default',
    'edit',
    'add',
Pawel G's avatar
Pawel G committed
66
    'register',
67 68
  ];

69
  protected static $changefreqValues = [
70 71 72 73 74 75 76 77 78
    'always',
    'hourly',
    'daily',
    'weekly',
    'monthly',
    'yearly',
    'never',
  ];

79
  protected static $valuesToCheck = [
80 81
    'simple_sitemap_index_content',
    'simple_sitemap_priority',
82
    'simple_sitemap_changefreq',
83
    'simple_sitemap_include_images',
Pawel G's avatar
Pawel G committed
84
    'simple_sitemap_regenerate_now',
85
  ];
86

87
  /**
88 89 90 91
   * FormHelper constructor.
   * @param \Drupal\simple_sitemap\Simplesitemap $generator
   * @param \Drupal\simple_sitemap\EntityHelper $entityHelper
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
92
   */
Pawel G's avatar
Pawel G committed
93 94
  public function __construct(
    Simplesitemap $generator,
95
    EntityHelper $entityHelper,
Pawel G's avatar
Pawel G committed
96 97
    AccountProxyInterface $current_user
  ) {
98
    $this->generator = $generator;
99
    $this->entityHelper = $entityHelper;
100
    $this->currentUser = $current_user;
101
  }
Pawel G's avatar
Pawel G committed
102

103
  /**
Pawel G's avatar
Pawel G committed
104 105
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   * @return bool
106
   */
Pawel G's avatar
Pawel G committed
107
  public function processForm(FormStateInterface $form_state) {
Pawel G's avatar
Pawel G committed
108
    $this->formState = $form_state;
109
    $this->cleanUpFormInfo();
110
    $this->getEntityDataFromFormEntity();
Pawel G's avatar
Pawel G committed
111
    return $this->supports();
112 113
  }

114
  /**
Pawel G's avatar
Pawel G committed
115
   * @param string $entity_category
116 117
   * @return $this
   */
118 119
  public function setEntityCategory($entity_category) {
    $this->entityCategory = $entity_category;
120
    return $this;
121 122
  }

123
  /**
124
   * @return null|string
125
   */
126 127 128 129 130 131 132 133
  public function getEntityCategory() {
    return $this->entityCategory;
  }

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

139 140 141 142 143 144 145
  /**
   * @return string
   */
  public function getEntityTypeId() {
    return $this->entityTypeId;
  }

146
  /**
Pawel G's avatar
Pawel G committed
147
   * @param string $bundle_name
148 149
   * @return $this
   */
150 151
  public function setBundleName($bundle_name) {
    $this->bundleName = $bundle_name;
152
    return $this;
153 154
  }

155 156 157 158 159 160 161
  /**
   * @return string
   */
  public function getBundleName() {
    return $this->bundleName;
  }

162
  /**
Pawel G's avatar
Pawel G committed
163
   * @param string $instance_id
164 165
   * @return $this
   */
166 167
  public function setInstanceId($instance_id) {
    $this->instanceId = $instance_id;
168
    return $this;
169 170
  }

171 172 173 174 175 176 177
  /**
   * @return string
   */
  public function getInstanceId() {
    return $this->instanceId;
  }

Pawel G's avatar
Pawel G committed
178
  /**
Pawel G's avatar
Pawel G committed
179
   * @return bool
Pawel G's avatar
Pawel G committed
180
   */
Pawel G's avatar
Pawel G committed
181
  protected function supports() {
Pawel G's avatar
Pawel G committed
182 183

    // Do not alter the form if user lacks certain permissions.
Pawel G's avatar
Pawel G committed
184
    if (!$this->currentUser->hasPermission('administer sitemap settings')) {
Pawel G's avatar
Pawel G committed
185
      return FALSE;
Pawel G's avatar
Pawel G committed
186
    }
Pawel G's avatar
Pawel G committed
187 188

    // Do not alter the form if it is irrelevant to sitemap generation.
189
    elseif (empty($this->getEntityCategory())) {
Pawel G's avatar
Pawel G committed
190
      return FALSE;
Pawel G's avatar
Pawel G committed
191
    }
Pawel G's avatar
Pawel G committed
192 193

    // Do not alter the form if entity is not enabled in sitemap settings.
194
    elseif (!$this->generator->entityTypeIsEnabled($this->getEntityTypeId())) {
Pawel G's avatar
Pawel G committed
195
      return FALSE;
Pawel G's avatar
Pawel G committed
196
    }
Pawel G's avatar
Pawel G committed
197 198 199

    // Do not alter the form, if sitemap is disabled for the entity type of this
    // entity instance.
200 201
    elseif ($this->getEntityCategory() == 'instance'
      && !$this->generator->bundleIsIndexed($this->getEntityTypeId(), $this->getBundleName())) {
Pawel G's avatar
Pawel G committed
202
      return FALSE;
Pawel G's avatar
Pawel G committed
203
    }
Pawel G's avatar
Pawel G committed
204 205

    return TRUE;
Pawel G's avatar
Pawel G committed
206 207
  }

208
  /**
Pawel G's avatar
Pawel G committed
209
   * @param array $form_fragment
210
   */
Pawel G's avatar
Pawel G committed
211
  public function displayRegenerateNow(&$form_fragment) {
Pawel G's avatar
Pawel G committed
212
    $form_fragment['simple_sitemap_regenerate_now'] = [
213
      '#type' => 'checkbox',
214 215
      '#title' => $this->t('Regenerate sitemap after hitting <em>Save</em>'),
      '#description' => $this->t('This setting will regenerate the whole sitemap including the above changes.'),
216
      '#default_value' => FALSE,
Pawel G's avatar
Pawel G committed
217
    ];
Pawel G's avatar
Pawel G committed
218
    if ($this->generator->getSetting('cron_generate')) {
219
      $form_fragment['simple_sitemap_regenerate_now']['#description'] .= '</br>' . $this->t('Otherwise the sitemap will be regenerated during a future cron run.');
220 221
    }
  }
222 223

  /**
224
   * @param array $form_fragment
225 226 227
   * @param bool $multiple
   * @return $this
   */
228
  public function displayEntitySettings(&$form_fragment, $multiple = FALSE) {
229
    $prefix = $multiple ? $this->getEntityTypeId() . '_' : '';
230

231
    if ($this->getEntityCategory() === 'instance') {
232 233
      $bundle_settings = $this->generator->getBundleSettings($this->getEntityTypeId(), $this->getBundleName());
      $settings = NULL !== $this->getInstanceId() ? $this->generator->getEntityInstanceSettings($this->getEntityTypeId(), $this->getInstanceId()) : $bundle_settings;
234
    }
235
    else {
236
      $settings = $this->generator->getBundleSettings($this->getEntityTypeId(), $this->getBundleName());
237 238 239
    }
    $index = isset($settings['index']) ? $settings['index'] : 0;
    $priority = isset($settings['priority']) ? $settings['priority'] : self::PRIORITY_DEFAULT;
240
    $changefreq = !empty($settings['changefreq']) ? $settings['changefreq'] : '';
241
    $include_images = !empty($settings['include_images']) ? $settings['include_images'] : 0;
242
    $bundle_name = !empty($this->getBundleName()) ? $this->getBundleName() : $this->t('undefined');
243 244 245 246 247 248

    if (!$multiple) {
      $form_fragment[$prefix . 'simple_sitemap_index_content'] = [
        '#type' => 'radios',
        '#default_value' => $index,
        '#options' => [
249 250
          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'),
Pawel G's avatar
Pawel G committed
251
        ],
252
      ];
253 254
      if ($this->getEntityCategory() === 'instance' && isset($bundle_settings['index'])) {
        $form_fragment[$prefix . 'simple_sitemap_index_content']['#options'][$bundle_settings['index']] .= ' <em>(' . $this->t('default') . ')</em>';
255 256 257 258 259
      }
    }

    $form_fragment[$prefix . 'simple_sitemap_priority'] = [
      '#type' => 'select',
260
      '#title' => $this->t('Priority'),
261 262 263
      '#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.'),
264
      '#default_value' => $priority,
265
      '#options' => $this->getPrioritySelectValues(),
266
    ];
267

268 269
    if ($this->getEntityCategory() === 'instance' && isset($bundle_settings['priority'])) {
      $form_fragment[$prefix . 'simple_sitemap_priority']['#options'][$this->formatPriority($bundle_settings['priority'])] .= ' (' . $this->t('default') . ')';
270
    }
271 272 273 274

    $form_fragment[$prefix . 'simple_sitemap_changefreq'] = [
      '#type' => 'select',
      '#title' => $this->t('Change frequency'),
275 276 277
      '#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.'),
278 279 280 281
      '#default_value' => $changefreq,
      '#options' => $this->getChangefreqSelectValues(),
    ];

282 283 284 285 286 287 288 289
    if ($this->getEntityCategory() === 'instance' && isset($bundle_settings['changefreq'])) {
      $form_fragment[$prefix . 'simple_sitemap_changefreq']['#options'][$bundle_settings['changefreq']] .= ' (' . $this->t('default') . ')';
    }

    $form_fragment[$prefix . 'simple_sitemap_include_images'] = [
      '#type' => 'select',
      '#title' => $this->t('Include images'),
      '#description' => $this->getEntityCategory() === 'instance'
Pawel G's avatar
Pawel G committed
290 291
        ? $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.'),
292 293 294 295 296 297
      '#default_value' => $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') . ')';
298 299
    }

Pawel G's avatar
Pawel G committed
300
    return $this;
301 302 303 304 305 306 307
  }

  /**
   * Checks if this particular form is a bundle form, or a bundle instance form
   * and gathers sitemap settings from the database.
   *
   * @return bool
Pawel G's avatar
Pawel G committed
308
   *   TRUE if this is a bundle or bundle instance form, FALSE otherwise.
309
   */
310
  protected function getEntityDataFromFormEntity() {
311 312
    $form_entity = $this->getFormEntity();
    if ($form_entity !== FALSE) {
313
      $entity_type_id = $form_entity->getEntityTypeId();
Pawel G's avatar
Pawel G committed
314
      $sitemap_entity_types = $this->entityHelper->getSupportedEntityTypes();
315
      if (isset($sitemap_entity_types[$entity_type_id])) {
316
        $this->setEntityCategory('instance');
317 318
      }
      else {
Pawel G's avatar
Pawel G committed
319 320 321 322 323
        /**
         * @var \Drupal\Core\Entity\EntityType $sitemap_entity_type
         */
        foreach ($sitemap_entity_types as $sitemap_entity_type) {
          if ($sitemap_entity_type->getBundleEntityType() == $entity_type_id) {
324
            $this->setEntityCategory('bundle');
325
            break;
326 327 328
          }
        }
      }
329

330
      // Menu fix.
331
      $this->setEntityCategory(NULL === $this->getEntityCategory() && $entity_type_id == 'menu' ? 'bundle' : $this->getEntityCategory());
332

333
      switch ($this->getEntityCategory()) {
334
        case 'bundle':
335 336 337
          $this->setEntityTypeId($this->entityHelper->getBundleEntityTypeId($form_entity));
          $this->setBundleName($form_entity->id());
          $this->setInstanceId(NULL);
338 339 340
          break;

        case 'instance':
341 342
          $this->setEntityTypeId($entity_type_id);
          $this->setBundleName($this->entityHelper->getEntityInstanceBundleName($form_entity));
Pawel G's avatar
Pawel G committed
343
          // New menu link's id is '' instead of NULL, hence checking for empty.
344
          $this->setInstanceId(!empty($form_entity->id()) ? $form_entity->id() : NULL);
345 346 347 348 349 350
          break;

        default:
          return FALSE;
      }
      return TRUE;
351 352 353 354 355 356 357
    }
    return FALSE;
  }

  /**
   * Gets the object entity of the form if available.
   *
Pawel G's avatar
Pawel G committed
358
   * @return \Drupal\Core\Entity\Entity|false
Pawel G's avatar
Pawel G committed
359 360
   *   Entity or FALSE if non-existent or if form operation is
   *   'delete'.
361
   */
362
  protected function getFormEntity() {
363
    $form_object = $this->formState->getFormObject();
364
    if (NULL !== $form_object
365
      && method_exists($form_object, 'getOperation')
366
      && method_exists($form_object, 'getEntity')
367
      && in_array($form_object->getOperation(), self::$allowedFormOperations)) {
368 369 370 371 372
      return $form_object->getEntity();
    }
    return FALSE;
  }

373 374 375 376 377 378 379 380 381 382 383 384 385
  /**
   * 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;
  }

386 387 388 389
  /**
   * Gets new entity Id after entity creation.
   * To be used in an entity form submit.
   *
Pawel G's avatar
Pawel G committed
390
   * @return int
Pawel G's avatar
Pawel G committed
391
   *   Entity ID.
392
   */
Pawel G's avatar
Pawel G committed
393 394
  public function getFormEntityId() {
    return $this->formState->getFormObject()->getEntity()->id();
395 396 397 398 399 400
  }

  /**
   * Checks if simple_sitemap values have been changed after submitting the form.
   * To be used in an entity form submit.
   *
401
   * @param $form
402
   * @param array $values
Pawel G's avatar
Pawel G committed
403
   *
404
   * @return bool
Pawel G's avatar
Pawel G committed
405
   *   TRUE if simple_sitemap form values have been altered by the user.
406
   */
407
  public function valuesChanged($form, array $values) {
Pawel G's avatar
Pawel G committed
408
    foreach (self::$valuesToCheck as $field_name) {
409
      if (isset($values[$field_name]) && $values[$field_name] != $form['simple_sitemap'][$field_name]['#default_value']) {
410 411 412 413 414
        return TRUE;
      }
    }
    return FALSE;
  }
Pawel G's avatar
Pawel G committed
415 416 417 418

  /**
   * Gets the values needed to display the priority dropdown setting.
   *
419
   * @return array
420
   *   Select options.
Pawel G's avatar
Pawel G committed
421
   */
422
  public function getPrioritySelectValues() {
Pawel G's avatar
Pawel G committed
423
    $options = [];
Pawel G's avatar
Pawel G committed
424
    foreach (range(0, self::PRIORITY_HIGHEST) as $value) {
425
      $value = $this->formatPriority($value / self::PRIORITY_DIVIDER);
426
      $options[$value] = $value;
Pawel G's avatar
Pawel G committed
427 428 429
    }
    return $options;
  }
430

431 432 433 434 435 436 437 438
  /**
   * Gets the values needed to display the changefreq dropdown setting.
   *
   * @return array
   *   Select options.
   */
  public function getChangefreqSelectValues() {
    $options = ['' => t('- Not specified -')];
439
    foreach (self::$changefreqValues as $setting) {
440 441 442 443 444 445 446 447 448
      $options[$setting] = t($setting);
    }
    return $options;
  }

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

452
  /**
453
   * @param string $priority
454 455 456
   * @return string
   */
  public function formatPriority($priority) {
Pawel G's avatar
Pawel G committed
457
    return number_format((float) $priority, 1, '.', '');
458 459
  }

460
  /**
461
   * @param string|int $priority
462 463
   * @return bool
   */
464
  public static function isValidPriority($priority) {
465
    return is_numeric($priority) && $priority >= 0 && $priority <= 1;
466
  }
467 468 469 470 471 472

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