abstract class SolrAdminFormBase in Search API Solr 4.x

Base form for Solr admin forms.

@package Drupal\search_api_solr_admin\Form

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\search_api_solr_admin\Form\SolrAdminFormBase uses \Drupal\search_api\LoggerTrait

File

modules/search_api_solr_admin/src/Form/SolrAdminFormBase.php, line 16

Namespace

Drupal\search_api_solr_admin\Form

abstract class SolrAdminFormBase extends FormBase {
  use LoggerTrait {
    getLogger as getSearchApiLogger;
  }

  /**
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The Search API server entity.
   *
   * @var \Drupal\search_api\ServerInterface
   */
  protected $search_api_server;

  /**
   * The Search API server entity.
   *
   * @var \Drupal\search_api_solr_admin\Utility\SolrAdminCommandHelper
   */
  protected $commandHelper;

  /**
   * SolrDeleteCollectionForm constructor.
   *
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(MessengerInterface $messenger, SolrAdminCommandHelper $commandHelper) {
    $this->messenger = $messenger;
    $this->commandHelper = $commandHelper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('messenger'), $container
      ->get('search_api_solr_admin.command_helper'));
  }
  protected function getLogger($channel = '') {
    return $this
      ->getSearchApiLogger();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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
FormInterface::buildForm	public	function	Form constructor.	192
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	264
FormInterface::submitForm	public	function	Form submission handler.	214
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
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.
SolrAdminFormBase::$commandHelper	protected	property	The Search API server entity.
SolrAdminFormBase::$messenger	protected	property	Overrides MessengerTrait::$messenger
SolrAdminFormBase::$search_api_server	protected	property	The Search API server entity.
SolrAdminFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SolrAdminFormBase::getLogger	protected	function	Gets the logger for a specific channel. Overrides LoggerChannelTrait::getLogger
SolrAdminFormBase::__construct	public	function	SolrDeleteCollectionForm constructor.
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.