interface SmartIpDataSourceInterface in Smart IP 8.3

Provides an interface for Smart IP's data source modules.

@package Drupal\smart_ip

Hierarchy

• interface \Drupal\smart_ip\SmartIpDataSourceInterface

File

src/SmartIpDataSourceInterface.php, line 15

Contains \Drupal\smart_ip\SmartIpDataSourceInterface.

Namespace

Drupal\smart_ip

interface SmartIpDataSourceInterface {

  /**
   * Smart IP data source module's source ID.
   *
   * @return string
   *   Smart IP data source module's source ID.
   */
  public static function sourceId();

  /**
   * Get the config name of this Smart IP data source module.
   *
   * @return string
   *   Config name of this Smart IP data source module.
   */
  public static function configName();

  /**
   * Act on \Drupal\smart_ip\SmartIp::query() when executed and if selected as
   * Smart IP data source, query the IP address against its database.
   *
   * @param \Drupal\smart_ip\GetLocationEvent $event
   *   Smart IP query location override event for event listeners.
   */
  public function processQuery(GetLocationEvent $event);

  /**
   * Add Smart IP source module's config name.
   *
   * @param \Drupal\smart_ip\AdminSettingsEvent $event
   *   Smart IP admin settings override event for event listeners.
   */
  public function includeEditableConfigNames(AdminSettingsEvent $event);

  /**
   * Add the form elements of this Smart IP data source to main admin settings
   * page of Smart IP.
   *
   * @param \Drupal\smart_ip\AdminSettingsEvent $event
   *   Smart IP admin settings override event for event listeners.
   */
  public function formSettings(AdminSettingsEvent $event);

  /**
   * Act on validation of main Smart IP admin settings form.
   *
   * @param \Drupal\smart_ip\AdminSettingsEvent $event
   *   Smart IP admin settings override event for event listeners.
   */
  public function validateFormSettings(AdminSettingsEvent $event);

  /**
   * Act on submission of main Smart IP admin settings form.
   *
   * @param \Drupal\smart_ip\AdminSettingsEvent $event
   *   Smart IP admin settings override event for event listeners.
   */
  public function submitFormSettings(AdminSettingsEvent $event);

  /**
   * Act on manual database update.
   *
   * @param \Drupal\smart_ip\DatabaseFileEvent $event
   *   Smart IP database file related events for event listeners.
   */
  public function manualUpdate(DatabaseFileEvent $event);

  /**
   * Act on Drupal cron run.
   *
   * @param \Drupal\smart_ip\DatabaseFileEvent $event
   *   Smart IP database file related events for event listeners.
   */
  public function cronRun(DatabaseFileEvent $event);

}

Members

Name	Modifiers	Type	Description	Overrides
SmartIpDataSourceInterface::configName	public static	function	Get the config name of this Smart IP data source module.	6
SmartIpDataSourceInterface::cronRun	public	function	Act on Drupal cron run.	6
SmartIpDataSourceInterface::formSettings	public	function	Add the form elements of this Smart IP data source to main admin settings page of Smart IP.	6
SmartIpDataSourceInterface::includeEditableConfigNames	public	function	Add Smart IP source module's config name.	1
SmartIpDataSourceInterface::manualUpdate	public	function	Act on manual database update.	6
SmartIpDataSourceInterface::processQuery	public	function	Act on \Drupal\smart_ip\SmartIp::query() when executed and if selected as Smart IP data source, query the IP address against its database.	6
SmartIpDataSourceInterface::sourceId	public static	function	Smart IP data source module's source ID.	6
SmartIpDataSourceInterface::submitFormSettings	public	function	Act on submission of main Smart IP admin settings form.	6
SmartIpDataSourceInterface::validateFormSettings	public	function	Act on validation of main Smart IP admin settings form.	6