class CertificateConfigForm in Certificate 4.x

Class CertificateConfigForm.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\certificate\Form\CertificateConfigForm

Expanded class hierarchy of CertificateConfigForm

1 file declares its use of CertificateConfigForm

certificate.module in ./certificate.module

1 string reference to 'CertificateConfigForm'

certificate.routing.yml in ./certificate.routing.yml: certificate.routing.yml

File

src/Form/CertificateConfigForm.php, line 14

Namespace

Drupal\certificate\Form

View source

class CertificateConfigForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->config('certificate.settings');
    $certificate_mappers = Drupal::service('plugin.manager.certificate_mapper');
    $mapper_definitions = $certificate_mappers
      ->getDefinitions();

    // Certificate Snapshots
    $form['certificate']['snapshot_fieldset'] = array(
      '#title' => $this
        ->t('Certificate Snapshots'),
      '#type' => 'fieldset',
    );
    $form['certificate']['snapshot_fieldset']['snapshots'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enabled'),
      '#description' => $this
        ->t('Certificates will only be generated once per node/user'),
      '#default_value' => $settings
        ->get("snapshots"),
    );

    // Global mappings
    $form['certificate']['maps'] = array(
      '#title' => $this
        ->t('Global Certificate Mappings'),
      '#type' => 'fieldset',
      '#tree' => TRUE,
    );

    // Get certs and prep options
    foreach ($mapper_definitions as $map_type => $map) {
      $plugin = $certificate_mappers
        ->createInstance($map_type, [
        'of' => 'configuration values',
      ]);
      $form['certificate']['maps'][$map_type] = array(
        '#title' => Html::escape($map['label']),
        '#type' => 'details',
        '#group' => TRUE,
        '#description' => Xss::filterAdmin($map['description']),
        '#open' => FALSE,
      );
      if ($plugin
        ->hasDependencies()) {
        $keys = $plugin
          ->getMapKeys();
        if (!empty($keys)) {
          foreach ($keys as $key => $title) {
            $form['certificate']['maps'][$map_type][$key] = array(
              '#type' => 'select',
              '#title' => Xss::filter($title),
              '#options' => $this
                ->getCertificateTemplateOptions(),
              '#default_value' => $settings
                ->get("maps.{$map_type}.{$key}") ?? '',
            );
          }
        }
        else {
          $form['certificate']['maps'][$map_type]['empty'] = array(
            '#markup' => '<p>' . $this
              ->t('There are no mappings available for %title.', array(
              '%title' => $map['label'],
            )) . '</p>',
          );
        }
      }
      else {
        foreach ($map['required'] as $module) {
          $modules[$module] = \Drupal::moduleHandler()
            ->getName($module);
        }
        $form['certificate']['maps'][$map_type]['#description'] = $this
          ->t('The following modules allow use of %title mappings.', array(
          '%title' => $map['label'],
        ));
        $form['certificate']['maps'][$map_type][] = array(
          '#theme' => 'item_list',
          '#list_type' => 'ul',
          '#items' => $modules,
        );
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('certificate.settings');
    $form_state
      ->cleanValues();
    $vals = $form_state
      ->getValues();
    foreach ($vals as $key => $value) {
      $config
        ->set($key, $value);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Return a list of certificate templates suitable as options in a select list
   */
  public static function getCertificateTemplateOptions() {
    $options = [
      '-1' => t('- prevent certificate -'),
    ];
    $certificates = Drupal::entityTypeManager()
      ->getStorage('certificate_template')
      ->loadMultiple();
    foreach ($certificates as $cid => $cert_ent) {
      $options[$cert_ent
        ->get('cid')->value] = $cert_ent
        ->label();
    }
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CertificateConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
CertificateConfigForm::getCertificateTemplateOptions	public static	function	Return a list of certificate templates suitable as options in a select list
CertificateConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CertificateConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CertificateConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	18
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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	72
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.

You are here

class CertificateConfigForm in Certificate 4.x

Hierarchy

File

Namespace

Members

API Navigation