scheduler.admin.inc in Scheduler 8

Administration forms for the Scheduler module.

File

scheduler.admin.inc

<?php

/**
 * @file
 * Administration forms for the Scheduler module.
 */
use Drupal\Core\Form\FormStateInterface;
use Drupal\node\NodeTypeInterface;

/**
 * Helper function for the real hook_form_node_type_form_alter().
 *
 * @see scheduler_form_node_type_form_alter()
 */
function _scheduler_form_node_type_form_alter(array &$form, FormStateInterface $form_state) {
  $config = \Drupal::config('scheduler.settings');

  /** @var \Drupal\node\NodeTypeInterface $type */
  $type = $form_state
    ->getFormObject()
    ->getEntity();
  $form['#attached']['library'][] = 'scheduler/admin';
  $form['#attached']['library'][] = 'scheduler/vertical-tabs';
  $form['scheduler'] = [
    '#type' => 'details',
    '#title' => t('Scheduler'),
    '#weight' => 35,
    '#group' => 'additional_settings',
  ];

  // Publishing options.
  $form['scheduler']['publish'] = [
    '#type' => 'details',
    '#title' => t('Publishing'),
    '#weight' => 1,
    '#group' => 'scheduler',
    '#open' => TRUE,
  ];
  $form['scheduler']['publish']['scheduler_publish_enable'] = [
    '#type' => 'checkbox',
    '#title' => t('Enable scheduled publishing for this content type'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'publish_enable', $config
      ->get('default_publish_enable')),
  ];
  $form['scheduler']['publish']['scheduler_publish_touch'] = [
    '#type' => 'checkbox',
    '#title' => t('Change content creation time to match the scheduled publish time'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'publish_touch', $config
      ->get('default_publish_touch')),
    '#states' => [
      'visible' => [
        ':input[name="scheduler_publish_enable"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['scheduler']['publish']['scheduler_publish_required'] = [
    '#type' => 'checkbox',
    '#title' => t('Require scheduled publishing'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'publish_required', $config
      ->get('default_publish_required')),
    '#states' => [
      'visible' => [
        ':input[name="scheduler_publish_enable"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['scheduler']['publish']['scheduler_publish_revision'] = [
    '#type' => 'checkbox',
    '#title' => t('Create a new revision on publishing'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'publish_revision', $config
      ->get('default_publish_revision')),
    '#states' => [
      'visible' => [
        ':input[name="scheduler_publish_enable"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['scheduler']['publish']['advanced'] = [
    '#type' => 'details',
    '#title' => t('Advanced options'),
    '#open' => FALSE,
    '#states' => [
      'visible' => [
        ':input[name="scheduler_publish_enable"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['scheduler']['publish']['advanced']['scheduler_publish_past_date'] = [
    '#type' => 'radios',
    '#title' => t('Action to be taken for publication dates in the past'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'publish_past_date', $config
      ->get('default_publish_past_date')),
    '#options' => [
      'error' => t('Display an error message - do not allow dates in the past'),
      'publish' => t('Publish the content immediately after saving'),
      'schedule' => t('Schedule the content for publication on the next cron run'),
    ],
  ];
  $form['scheduler']['publish']['advanced']['scheduler_publish_past_date_created'] = [
    '#type' => 'checkbox',
    '#title' => t("Change content creation time to match the published time for dates before the content was created"),
    '#description' => t("The created time will only be altered when the scheduled publishing time is earlier than the existing content creation time"),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'publish_past_date_created', $config
      ->get('default_publish_past_date_created')),
    // This option is not relevant if the full 'change creation time' option is
    // selected, or when past dates are not allowed. Hence only show it when
    // the main option is not checked and the past dates option is not 'error'.
    '#states' => [
      'visible' => [
        ':input[name="scheduler_publish_touch"]' => [
          'checked' => FALSE,
        ],
        ':input[name="scheduler_publish_past_date"]' => [
          '!value' => 'error',
        ],
      ],
    ],
  ];

  // Unpublishing options.
  $form['scheduler']['unpublish'] = [
    '#type' => 'details',
    '#title' => t('Unpublishing'),
    '#weight' => 2,
    '#group' => 'scheduler',
    '#open' => TRUE,
  ];
  $form['scheduler']['unpublish']['scheduler_unpublish_enable'] = [
    '#type' => 'checkbox',
    '#title' => t('Enable scheduled unpublishing for this content type'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'unpublish_enable', $config
      ->get('default_unpublish_enable')),
  ];
  $form['scheduler']['unpublish']['scheduler_unpublish_required'] = [
    '#type' => 'checkbox',
    '#title' => t('Require scheduled unpublishing'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'unpublish_required', $config
      ->get('default_unpublish_required')),
    '#states' => [
      'visible' => [
        ':input[name="scheduler_unpublish_enable"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['scheduler']['unpublish']['scheduler_unpublish_revision'] = [
    '#type' => 'checkbox',
    '#title' => t('Create a new revision on unpublishing'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'unpublish_revision', $config
      ->get('default_unpublish_revision')),
    '#states' => [
      'visible' => [
        ':input[name="scheduler_unpublish_enable"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];

  // The 'node_edit_layout' fieldset contains options to alter the layout of
  // node edit pages.
  $form['scheduler']['node_edit_layout'] = [
    '#type' => 'details',
    '#title' => t('Node edit page'),
    '#weight' => 3,
    '#group' => 'scheduler',
    // The #states processing only caters for AND and does not do OR. So to set
    // the state to visible if either of the boxes are ticked we use the fact
    // that logical 'X = A or B' is equivalent to 'not X = not A and not B'.
    '#states' => [
      '!visible' => [
        ':input[name="scheduler_publish_enable"]' => [
          '!checked' => TRUE,
        ],
        ':input[name="scheduler_unpublish_enable"]' => [
          '!checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['scheduler']['node_edit_layout']['scheduler_fields_display_mode'] = [
    '#type' => 'radios',
    '#title' => t('Display scheduling options as'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'fields_display_mode', $config
      ->get('default_fields_display_mode')),
    '#options' => [
      'vertical_tab' => t('Vertical tab'),
      'fieldset' => t('Separate fieldset'),
    ],
    '#description' => t('Use this option to specify how the scheduling options will be displayed when editing a node.'),
  ];
  $form['scheduler']['node_edit_layout']['scheduler_expand_fieldset'] = [
    '#type' => 'radios',
    '#title' => t('Expand fieldset or vertical tab'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'expand_fieldset', $config
      ->get('default_expand_fieldset')),
    '#options' => [
      'when_required' => t('Expand only when a scheduled date exists or when a date is required'),
      'always' => t('Always open the fieldset or vertical tab'),
    ],
  ];
  $form['scheduler']['node_edit_layout']['scheduler_show_message_after_update'] = [
    '#type' => 'checkbox',
    '#prefix' => '<strong>' . t('Show message') . '</strong>',
    '#title' => t('Show a confirmation message when scheduled content is saved'),
    '#default_value' => $type
      ->getThirdPartySetting('scheduler', 'show_message_after_update', $config
      ->get('default_show_message_after_update')),
  ];
  $form['#entity_builders'][] = 'scheduler_form_node_type_form_builder';
}

/**
 * Entity builder for the node type form with scheduler options.
 */
function scheduler_form_node_type_form_builder($entity_type, NodeTypeInterface $type, &$form, FormStateInterface $form_state) {
  $type
    ->setThirdPartySetting('scheduler', 'expand_fieldset', $form_state
    ->getValue('scheduler_expand_fieldset'));
  $type
    ->setThirdPartySetting('scheduler', 'fields_display_mode', $form_state
    ->getValue('scheduler_fields_display_mode'));
  $type
    ->setThirdPartySetting('scheduler', 'publish_enable', $form_state
    ->getValue('scheduler_publish_enable'));
  $type
    ->setThirdPartySetting('scheduler', 'publish_past_date', $form_state
    ->getValue('scheduler_publish_past_date'));
  $type
    ->setThirdPartySetting('scheduler', 'publish_past_date_created', $form_state
    ->getValue('scheduler_publish_past_date_created'));
  $type
    ->setThirdPartySetting('scheduler', 'publish_required', $form_state
    ->getValue('scheduler_publish_required'));
  $type
    ->setThirdPartySetting('scheduler', 'publish_revision', $form_state
    ->getValue('scheduler_publish_revision'));
  $type
    ->setThirdPartySetting('scheduler', 'publish_touch', $form_state
    ->getValue('scheduler_publish_touch'));
  $type
    ->setThirdPartySetting('scheduler', 'show_message_after_update', $form_state
    ->getValue('scheduler_show_message_after_update'));
  $type
    ->setThirdPartySetting('scheduler', 'unpublish_enable', $form_state
    ->getValue('scheduler_unpublish_enable'));
  $type
    ->setThirdPartySetting('scheduler', 'unpublish_required', $form_state
    ->getValue('scheduler_unpublish_required'));
  $type
    ->setThirdPartySetting('scheduler', 'unpublish_revision', $form_state
    ->getValue('scheduler_unpublish_revision'));
}

Functions

Name	Description
scheduler_form_node_type_form_builder	Entity builder for the node type form with scheduler options.
_scheduler_form_node_type_form_alter	Helper function for the real hook_form_node_type_form_alter().