DeterminingServerFeaturesEvent.php in Search API 8

Namespace

Drupal\search_api\Event

File

src/Event/DeterminingServerFeaturesEvent.php

<?php

namespace Drupal\search_api\Event;

use Drupal\search_api\ServerInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Wraps a determining server features event.
 */
final class DeterminingServerFeaturesEvent extends Event {

  /**
   * Reference to the features supported by the server's backend.
   *
   * @var array
   */
  protected $features;

  /**
   * The search server in question.
   *
   * @var \Drupal\search_api\ServerInterface
   */
  protected $server;

  /**
   * Constructs a new class instance.
   *
   * @param array $features
   *   Reference to the features supported by the server's backend.
   * @param \Drupal\search_api\ServerInterface $server
   *   The search server in question.
   */
  public function __construct(array &$features, ServerInterface $server) {
    $this->features =& $features;
    $this->server = $server;
  }

  /**
   * Retrieves a reference to the features supported by the server's backend.
   *
   * @return array
   *   Reference to the features supported by the server's backend.
   */
  public function &getFeatures() {
    return $this->features;
  }

  /**
   * Retrieves the search server in question.
   *
   * @return \Drupal\search_api\ServerInterface
   *   The search server in question.
   */
  public function getServer() {
    return $this->server;
  }

}

Classes

Name	Description
DeterminingServerFeaturesEvent	Wraps a determining server features event.