PanelsVariantEvent.php in Panels 8.4

Namespace

Drupal\panels

File

src/PanelsVariantEvent.php

<?php

namespace Drupal\panels;

use Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant;
use Symfony\Component\EventDispatcher\Event;

/**
 * Event object for events relating to Panels display variants.
 */
class PanelsVariantEvent extends Event {

  /**
   * The Panels display variant.
   *
   * @var \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant
   */
  protected $variant;

  /**
   * PanelsVariantEvent constructor.
   *
   * @param \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant $variant
   *   The Panels display variant.
   */
  public function __construct(PanelsDisplayVariant $variant) {
    $this->variant = $variant;
  }

  /**
   * Returns the Panels display variant that triggered the event.
   *
   * @return \Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant
   *   The Panels display variant.
   */
  public function getVariant() {
    return $this->variant;
  }

}

Classes

Name	Description
PanelsVariantEvent	Event object for events relating to Panels display variants.