You are here

Home » API reference » Content Planner 8 » SettingsForm.php

class SettingsForm in Content Planner 8

Same name in this branch
  1. 8 modules/content_kanban/src/Form/SettingsForm.php \Drupal\content_kanban\Form\SettingsForm
  2. 8 modules/content_calendar/src/Form/SettingsForm.php \Drupal\content_calendar\Form\SettingsForm

Defines a form that configures forms module settings.

Hierarchy

Expanded class hierarchy of SettingsForm

1 file declares its use of SettingsForm
CalendarEntry.php in modules/content_calendar/src/Component/CalendarEntry.php
1 string reference to 'SettingsForm'
content_calendar.routing.yml in modules/content_calendar/content_calendar.routing.yml
modules/content_calendar/content_calendar.routing.yml

File

modules/content_calendar/src/Form/SettingsForm.php, line 16

Namespace

Drupal\content_calendar\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * @var \Drupal\content_calendar\ContentTypeConfigService
   */
  protected $contentTypeConfigService;

  /**
   * @var \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * Config name.
   */
  const CONFIG_NAME = 'content_calendar.settings';

  /**
   * The default background color value for unpublished content.
   */
  const DEFAULT_BG_COLOR_UNPUBLISHED_CONTENT = '#fff4f4';

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $this->contentTypeConfigService = \Drupal::service('content_calendar.content_type_config_service');

    // Get config.
    $this->config = $this
      ->config(self::CONFIG_NAME);
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'content_calendar.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {

    // Get select options for content types.
    $content_type_options = $this
      ->getConfiguredContentTypes();
    if (!$content_type_options) {
      $message = $this
        ->t('Content Calendar can only be used with Scheduler. At least one Content Type needs to have the scheduling options enabled.');
      $this
        ->messenger()
        ->addMessage($message, 'error');
      return [];
    }

    // Build Content Type configuration.
    $this
      ->buildContentTypeConfiguration($form, $form_state);

    // Build Calendar Options.
    $this
      ->buildCalendarOptions($form, $form_state);

    // Build form.
    $build_form = parent::buildForm($form, $form_state);
    return $build_form;
  }

  /**
   * Build Content Type select options.
   *
   * @return array
   */
  protected function getConfiguredContentTypes() {
    $display_options = [];

    // Load Node Type configurations.
    $node_types = NodeType::loadMultiple();
    foreach ($node_types as $node_type_key => $node_type) {
      if ($scheduler = $node_type
        ->getThirdPartySettings('scheduler')) {
        if ($scheduler['publish_enable'] == TRUE) {
          $display_options[$node_type_key] = $node_type
            ->label();
        }
      }
    }
    return $display_options;
  }

  /**
   * Build Content type configuration.
   *
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  protected function buildContentTypeConfiguration(array &$form, FormStateInterface $form_state) {

    // Get select options for content types.
    $content_type_options = $this
      ->getConfiguredContentTypes();

    // Get all config entities.
    $entities = $this->contentTypeConfigService
      ->loadAllEntities();

    // Get all config entities keys.
    $entity_keys = array_keys($entities);
    $form['content_type_configuration'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Content Type Configuration'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    ];
    $form['content_type_configuration']['content_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Which Content Types need to be displayed?'),
      '#description' => $this
        ->t('Only Content Types enabled for Scheduler are listed here'),
      '#required' => TRUE,
      '#options' => $content_type_options,
      '#default_value' => $entity_keys,
    ];
    if ($entities) {
      $rows = [];
      foreach ($entities as $entity_key => $entity) {
        $options = [
          'query' => [
            'destination' => Url::fromRoute('content_calendar.settings')
              ->toString(),
          ],
        ];
        $edit_link = Link::createFromRoute($this
          ->t('Configure'), 'entity.content_type_config.edit_form', [
          'content_type_config' => $entity_key,
        ], $options);
        $row = [
          $entity
            ->label(),
          $entity
            ->id(),
          $entity
            ->getColor(),
          $edit_link
            ->toString(),
        ];
        $rows[] = $row;
      }
      $headers = [
        $this
          ->t('Content Type'),
        $this
          ->t('ID'),
        $this
          ->t('Color'),
        $this
          ->t('Actions'),
      ];
      $form['content_type_configuration']['table'] = [
        '#type' => 'table',
        '#header' => $headers,
        '#rows' => $rows,
        '#weight' => 20,
      ];
    }
  }

  /**
   * Build the form elements for the calendar options.
   *
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  protected function buildCalendarOptions(array &$form, FormStateInterface $form_state) {

    // Fieldset.
    $form['options'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Display Options'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    ];

    // Show user thumb checkbox.
    $user_picture_field_exists = !$this
      ->config('field.field.user.user.user_picture')
      ->isNew();
    $form['options']['show_user_thumb'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show thumbnail image of User image'),
      '#description' => $this
        ->t('This option is only available, if the User account has the "user_picture" field. See Account configuration.'),
      '#disabled' => !$user_picture_field_exists,
      '#default_value' => $this->config
        ->get('show_user_thumb'),
    ];
    $form['options']['bg_color_unpublished_content'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Background color for unpublished content'),
      '#description' => $this
        ->t("Define the background color for unpublished content. Use a css color in word format (e.x. red) or a hexadecimal value (e.x. #ffcc00). When empty the default value will be used."),
      '#maxlength' => 20,
      '#default_value' => $this->config
        ->get('bg_color_unpublished_content'),
    ];
  }

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

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

    // Save show user image thumbnail option.
    $this
      ->config(self::CONFIG_NAME)
      ->set('show_user_thumb', $values['show_user_thumb'])
      ->set('bg_color_unpublished_content', $values['bg_color_unpublished_content'])
      ->save();

    // Get selected Content Types.
    $selected_content_types = $this
      ->getSelectedContentTypes($form_state);

    // Load config entities.
    $config_entities = $this->contentTypeConfigService
      ->loadAllEntities();

    // Check which config entity needs to be added.
    $this
      ->addNewConfigEntities($selected_content_types, $config_entities);

    // Check which config entity needs to be deleted.
    $this
      ->deleteObsoleteConfigEntities($selected_content_types, $config_entities);
  }

  /**
   * Get selected content types.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return array
   */
  protected function getSelectedContentTypes(FormStateInterface &$form_state) {

    // Get values.
    $values = $form_state
      ->getValues();

    // Save Content types to be displayed.
    $selected_content_types = [];
    foreach ($values['content_types'] as $key => $selected) {
      if ($selected) {
        $selected_content_types[] = $key;
      }
    }
    return $selected_content_types;
  }

  /**
   * Check which config entity needs to be deleted.
   *
   * @param array $selected_content_types
   * @param \Drupal\content_calendar\Entity\ContentTypeConfig[] $config_entities
   */
  protected function addNewConfigEntities(array $selected_content_types, array &$config_entities) {

    // Get entity keys.
    $entity_keys = array_keys($config_entities);
    foreach ($selected_content_types as $selected_content_type) {
      if (!in_array($selected_content_type, $entity_keys)) {
        if ($node_type = NodeType::load($selected_content_type)) {
          $this->contentTypeConfigService
            ->createEntity($selected_content_type, $node_type
            ->label());
          $this
            ->messenger()
            ->addMessage(t('Content Type @name has been added and can be configured below.', [
            '@name' => $node_type
              ->label(),
          ]));
        }
      }
    }
  }

  /**
   * Check which config entity needs to be deleted.
   *
   * @param array $selected_content_types
   * @param \Drupal\content_calendar\Entity\ContentTypeConfig[] $config_entities
   */
  protected function deleteObsoleteConfigEntities(array $selected_content_types, array &$config_entities) {
    foreach ($config_entities as $config_entity_id => $config_entity) {
      if (!in_array($config_entity_id, $selected_content_types)) {
        $this
          ->messenger()
          ->addMessage(t('Content Type @name has been removed from Content Calendar.', [
          '@name' => $config_entity
            ->label(),
        ]));
        $config_entity
          ->delete();
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
SettingsForm::$config protected property
SettingsForm::$contentTypeConfigService protected property
SettingsForm::addNewConfigEntities protected function Check which config entity needs to be deleted.
SettingsForm::buildCalendarOptions protected function Build the form elements for the calendar options.
SettingsForm::buildContentTypeConfiguration protected function Build Content type configuration.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::CONFIG_NAME constant Config name.
SettingsForm::DEFAULT_BG_COLOR_UNPUBLISHED_CONTENT constant The default background color value for unpublished content.
SettingsForm::deleteObsoleteConfigEntities protected function Check which config entity needs to be deleted.
SettingsForm::getConfiguredContentTypes protected function Build Content Type select options.
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::getSelectedContentTypes protected function Get selected content types.
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::__construct public function Constructor. Overrides ConfigFormBase::__construct
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.