You are here

Home » API reference » Node read time 8 » ReadingTimeConfigForm.php

class ReadingTimeConfigForm in Node read time 8

Defines a form for enabling reading time field for specific content types.

Hierarchy

Expanded class hierarchy of ReadingTimeConfigForm

1 string reference to 'ReadingTimeConfigForm'
node_read_time.routing.yml in ./node_read_time.routing.yml
node_read_time.routing.yml

File

src/Form/ReadingTimeConfigForm.php, line 14

Namespace

Drupal\node_read_time\Form
View source 
class ReadingTimeConfigForm extends ConfigFormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Class constructor.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entityTypeManager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_type.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('node_read_time.settings');
    $contentTypes = $this->entityTypeManager
      ->getStorage('node_type')
      ->loadMultiple();
    $words_per_minute = !empty($config
      ->get('reading_time')['words_per_minute']) ? $config
      ->get('reading_time')['words_per_minute'] : NULL;
    $unit = !empty($config
      ->get('reading_time')['unit_of_time']) ? $config
      ->get('reading_time')['unit_of_time'] : 'minute';
    $only_minute = $this
      ->t('@minute', [
      '@minute' => 'Only Minute',
    ]);
    $minute_second = $this
      ->t('@second', [
      '@second' => 'Minute and Second',
    ]);
    $default = $this
      ->t('@default', [
      '@default' => 'Default (only minute) without text',
    ]);
    $form['container'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Content types to apply reading time field to.'),
      '#tree' => TRUE,
    ];
    $form['words_per_minute'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Words per minute.'),
      '#default_value' => $words_per_minute,
    ];
    $form['unit_of_time'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Unit of time'),
      '#options' => [
        'default' => $default,
        'minute' => $only_minute,
        'second' => $minute_second,
      ],
      '#default_value' => $unit,
    ];
    foreach ($contentTypes as $type => $obj) {
      $name = $obj
        ->get('name');
      $is_activated = !empty($config
        ->get('reading_time')['container'][$type]['is_activated']) ? $config
        ->get('reading_time')['container'][$type]['is_activated'] : NULL;
      $form['container'][$type]['is_activated'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Activate for @name', [
          '@name' => $name,
        ]),
        '#default_value' => $is_activated,
        '#tree' => TRUE,
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('node_read_time.settings');
    $config
      ->set('reading_time', $form_state
      ->getValues());
    $config
      ->save();
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
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.
ReadingTimeConfigForm::$entityTypeManager protected property The entity type manager.
ReadingTimeConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ReadingTimeConfigForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
ReadingTimeConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ReadingTimeConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ReadingTimeConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ReadingTimeConfigForm::__construct public function Class constructor. Overrides ConfigFormBase::__construct
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.