final class MappingViewsFieldHandlersEvent in Search API 8

Wraps a mapping Views field handlers event.

Hierarchy

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

1 file declares its use of MappingViewsFieldHandlersEvent

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

Views hook implementations for the Search API module.

File

src/Event/MappingViewsFieldHandlersEvent.php, line 10

Namespace

Drupal\search_api\Event

final class MappingViewsFieldHandlersEvent extends Event {

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

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

  /**
   * Retrieves a reference to the Views field handler mapping.
   *
   * @return array
   *   An associative array with property data types as the keys and Views field
   *   handler definitions as the values (that is, just the inner "field"
   *   portion of Views data definition items). In some cases the value might
   *   also be NULL instead, to indicate that properties of this type shouldn't
   *   have field handlers. The data types in the keys might also contain
   *   asterisks (*) as wildcard characters. Data types with wildcards will be
   *   matched only if no specific type exists, and longer type patterns will be
   *   tried before shorter ones. The "*" mapping therefore is the default if no
   *   other match could be found.
   */
  public function &getFieldHandlerMapping() {
    return $this->fieldHandlerMapping;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MappingViewsFieldHandlersEvent::$fieldHandlerMapping	protected	property	The Views field handler mapping.
MappingViewsFieldHandlersEvent::getFieldHandlerMapping	public	function	Retrieves a reference to the Views field handler mapping.
MappingViewsFieldHandlersEvent::__construct	public	function	Constructs a new class instance.