class AdminSettingsEvent in Smart IP 8.4

Provides Smart IP admin settings override event for event listeners.

@package Drupal\smart_ip

Hierarchy

• class \Drupal\smart_ip\AdminSettingsEvent extends \Symfony\Component\EventDispatcher\Event

6 files declare their use of AdminSettingsEvent

SmartIpEventSubscriber.php in modules/device_geolocation/src/EventSubscriber/SmartIpEventSubscriber.php

Contains \Drupal\device_geolocation\EventSubscriber\SmartIpEventSubscriber.

SmartIpEventSubscriber.php in modules/smart_ip_maxmind_geoip2_bin_db/src/EventSubscriber/SmartIpEventSubscriber.php

Contains \Drupal\smart_ip_maxmind_geoip2_bin_db\EventSubscriber\SmartIpEventSubscriber.

SmartIpEventSubscriber.php in modules/smart_ip_ipinfodb_web_service/src/EventSubscriber/SmartIpEventSubscriber.php

Contains \Drupal\smart_ip_ipinfodb_web_service\EventSubscriber\SmartIpEventSubscriber.

SmartIpEventSubscriber.php in modules/smart_ip_ip2location_bin_db/src/EventSubscriber/SmartIpEventSubscriber.php

Contains \Drupal\smart_ip_ip2location_bin_db\EventSubscriber\SmartIpEventSubscriber.

SmartIpEventSubscriber.php in modules/smart_ip_abstract_web_service/src/EventSubscriber/SmartIpEventSubscriber.php

Contains \Drupal\smart_ip_abstract_web_service\EventSubscriber\SmartIpEventSubscriber.

... See full list

1 string reference to 'AdminSettingsEvent'

smart_ip.services.yml in ./smart_ip.services.yml

smart_ip.services.yml

1 service uses AdminSettingsEvent

smart_ip.admin_settings_event in ./smart_ip.services.yml

Drupal\smart_ip\AdminSettingsEvent

File

src/AdminSettingsEvent.php, line 18

Contains \Drupal\smart_ip\AdminSettingsEvent.

Namespace

Drupal\smart_ip

class AdminSettingsEvent extends Event {

  /**
   * Contains array of configuration names that will be editable.
   *
   * @var array
   */
  protected $editableConfigNames;

  /**
   * Contains Smart IP admin settings $form.
   *
   * @var array
   */
  protected $form;

  /**
   * Contains Smart IP admin settings $form.
   *
   * @var \Drupal\Core\Form\FormStateInterface
   */
  protected $formState;

  /**
   * Get Form.
   *
   * @return array
   *   An associative array containing the structure of the form.
   */
  public function getForm() {
    return $this->form;
  }

  /**
   * Set Form.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   */
  public function setForm(array $form) {
    $this->form = $form;
  }

  /**
   * Form State.
   *
   * @return \Drupal\Core\Form\FormStateInterface
   *   The current state of the form.
   */
  public function getFormState() {
    return $this->formState;
  }

  /**
   * Set the state of form.
   *
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The current state of the form.
   */
  public function setFormState(FormStateInterface $formState) {
    $this->formState = $formState;
  }

  /**
   * Get the config names.
   *
   * @return array
   *   Config names.
   */
  public function getEditableConfigNames() {
    return $this->editableConfigNames;
  }

  /**
   * Set the config names.
   *
   * @param array $editableConfigNames
   *   Config names.
   */
  public function setEditableConfigNames(array $editableConfigNames) {
    $this->editableConfigNames = $editableConfigNames;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdminSettingsEvent::$editableConfigNames	protected	property	Contains array of configuration names that will be editable.
AdminSettingsEvent::$form	protected	property	Contains Smart IP admin settings $form.
AdminSettingsEvent::$formState	protected	property	Contains Smart IP admin settings $form.
AdminSettingsEvent::getEditableConfigNames	public	function	Get the config names.
AdminSettingsEvent::getForm	public	function	Get Form.
AdminSettingsEvent::getFormState	public	function	Form State.
AdminSettingsEvent::setEditableConfigNames	public	function	Set the config names.
AdminSettingsEvent::setForm	public	function	Set Form.
AdminSettingsEvent::setFormState	public	function	Set the state of form.