final class MappingViewsHandlersEvent in Search API 8

Wraps a mapping Views handlers event.

Hierarchy

• class \Drupal\search_api\Event\MappingViewsHandlersEvent extends \Symfony\Component\EventDispatcher\Event

1 file declares its use of MappingViewsHandlersEvent

search_api.views.inc in ./search_api.views.inc

Views hook implementations for the Search API module.

File

src/Event/MappingViewsHandlersEvent.php, line 10

Namespace

Drupal\search_api\Event

final class MappingViewsHandlersEvent extends Event {

  /**
   * The Views handler mapping.
   *
   * @var array
   */
  protected $handlerMapping;

  /**
   * Constructs a new class instance.
   *
   * @param array $handlerMapping
   *   The Views handler mapping.
   */
  public function __construct(array &$handlerMapping) {
    $this->handlerMapping =& $handlerMapping;
  }

  /**
   * Retrieves a reference to the Views handler mapping.
   *
   * @return array
   *   An associative array with data types as the keys and Views table data
   *   definition items as the values. In addition to all normally defined
   *   Search API data types, keys can also be "options" for any field with an
   *   options list, "entity" for general entity-typed fields or
   *   "entity:ENTITY_TYPE" (with "ENTITY_TYPE" being the machine name of an
   *   entity type) for entities of that type.
   */
  public function &getHandlerMapping() {
    return $this->handlerMapping;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MappingViewsHandlersEvent::$handlerMapping	protected	property	The Views handler mapping.
MappingViewsHandlersEvent::getHandlerMapping	public	function	Retrieves a reference to the Views handler mapping.
MappingViewsHandlersEvent::__construct	public	function	Constructs a new class instance.