class RngContactSettingsForm in RNG Contact 8

Configure RNG Contact settings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\rng_contact\Form\RngContactSettingsForm

Expanded class hierarchy of RngContactSettingsForm

1 string reference to 'RngContactSettingsForm'

rng_contact.routing.yml in ./rng_contact.routing.yml: rng_contact.routing.yml

File

src/Form/RngContactSettingsForm.php, line 15

Namespace

Drupal\rng_contact\Form

View source

class RngContactSettingsForm extends ConfigFormBase {

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * Constructs a RngContactSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityFieldManagerInterface $entity_field_manager) {
    parent::__construct($config_factory);
    $this->entityFieldManager = $entity_field_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form['table_help'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $this
        ->t('Select email fields Courier should use when communicating with contacts.'),
    ];
    $form['table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Contact type'),
        $this
          ->t('Email field'),
      ],
      '#empty' => $this
        ->t('There are no people types available.'),
    ];
    foreach (RngContactType::loadMultiple() as $contact_type) {
      $row = [];
      $row['label'] = [
        '#markup' => $contact_type
          ->label(),
      ];

      /** @var \Drupal\rng_contact\Entity\RngContactTypeInterface $contact_type */
      $field_definitions = $this->entityFieldManager
        ->getFieldDefinitions('rng_contact', $contact_type
        ->id());
      $field_options = [];
      foreach ($field_definitions as $field_definition) {
        $field_type = $field_definition
          ->getType();
        if ($field_type == 'email') {
          $field_options[$field_definition
            ->getName()] = $field_definition
            ->getLabel();
        }
      }
      $row['email_field'] = [
        '#type' => 'select',
        '#title_display' => 'invisible',
        '#empty_option' => $this
          ->t('- Disable -'),
        '#empty_value' => NULL,
        '#options' => $field_options,
        '#default_value' => $contact_type
          ->getCourierEmailField(),
      ];
      $form['table'][$contact_type
        ->id()] = $row;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    foreach ($form_state
      ->getValue('table') as $contact_type_id => $row) {

      /** @var \Drupal\rng_contact\Entity\RngContactTypeInterface $contact_type */
      $contact_type = RngContactType::load($contact_type_id);
      $email_field = !empty($row['email_field']) ? $row['email_field'] : NULL;
      $contact_type
        ->setCourierEmailField($email_field);
      $contact_type
        ->save();
    }
    drupal_set_message($this
      ->t('Settings updated.'));
  }

}

Members

Name	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.
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.
RngContactSettingsForm::$entityFieldManager	protected	property	The entity field manager.
RngContactSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
RngContactSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
RngContactSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RngContactSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
RngContactSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
RngContactSettingsForm::__construct	public	function	Constructs a RngContactSettingsForm object. 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.

You are here

class RngContactSettingsForm in RNG Contact 8

Hierarchy

File

Namespace

Members

API Navigation