class Event in GA Push 8

Provides a 'Ga Push Event' action.

Plugin annotation


@RulesAction(
  id = "ga_push_event",
  label = @Translation("Ga push: event"),
  category = @Translation("GA Push"),
  context = {
    "method" = @ContextDefinition("string",
      label = @Translation("Method"),
      description = @Translation("Select the method. If none is selected default method will be used."),
      required = FALSE,
    ),
    "event" = @ContextDefinition("string",
      label = @Translation("Event"),
      description = @Translation("The event name for Data Layer."),
      required = FALSE,
    ),
    "category" = @ContextDefinition("string",
      label = @Translation("Category"),
      description = @Translation("The name you supply for the group of objects you want to track.")
    ),
    "action" = @ContextDefinition("string",
      label = @Translation("Action"),
      description = @Translation("A string that is uniquely paired with each category, and commonly used to define the type of user interaction for the web object.")
    ),
    "label" = @ContextDefinition("string",
      label = @Translation("Label"),
      description = @Translation("An optional string to provide additional dimensions to the event data."),
      required = FALSE
    ),
    "value" = @ContextDefinition("integer",
      label = @Translation("Value"),
      description = @Translation("An integer that you can use to provide numerical data about the user event."),
      required = FALSE
    ),
    "non-interaction" = @ContextDefinition("boolean",
      label = @Translation("Non interaction"),
      description = @Translation("A boolean that when set to true, indicates that the event hit will not be used in bounce-rate calculation."),
      default_value = FALSE,
      required = FALSE
    )
  },
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\rules\Core\RulesActionBase implements RulesActionInterface uses ContextProviderTrait, ConfigurationAccessControlTrait, ExecutablePluginTrait
    class \Drupal\ga_push\Plugin\RulesAction\Base
    class \Drupal\ga_push\Plugin\RulesAction\Event

Expanded class hierarchy of Event

File

src/Plugin/RulesAction/Event.php, line 50

Namespace

Drupal\ga_push\Plugin\RulesAction

View source

class Event extends Base {

  /**
   * Executes the action with the given context.
   */
  protected function doExecute() {
    $event = [
      'eventCategory' => $this
        ->getContextValue('category'),
      'eventAction' => $this
        ->getContextValue('action'),
      'eventLabel' => $this
        ->getContextValue('label'),
      'eventValue' => $this
        ->getContextValue('value'),
      'nonInteraction' => $this
        ->getContextValue('non-interaction'),
    ];

    // Retrieve selected method or the default one.
    $method = $this
      ->getMethod();
    if ($this
      ->isDatalayerMethod()) {
      $event['event'] = $this
        ->getContextValue('event');
    }
    ga_push_add_event($event, $method);
  }

  /**
   * Check if selected method is datalayer.
   *
   * @return bool
   *   Is datalayer method?
   */
  public function isDatalayerMethod() {
    $method = $this
      ->getContextValue('method');
    return $method == GA_PUSH_METHOD_DATALAYER_JS || $this
      ->getDefaultMethod() == GA_PUSH_METHOD_DATALAYER_JS;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Base::getDefaultMethod	public	function	Return default method.
Base::getMethod	public	function	Get ga push method type.
ConfigurationAccessControlTrait::checkConfigurationAccess	public	function	Checks configuration permission.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__construct	public	function	Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides PluginBase::__construct	4
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
ContextProviderTrait::$providedContext	protected	property	The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext	public	function
ContextProviderTrait::getProvidedContextDefinition	public	function
ContextProviderTrait::getProvidedContextDefinitions	public	function
ContextProviderTrait::setProvidedValue	public	function
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
Event::doExecute	protected	function	Executes the action with the given context.
Event::isDatalayerMethod	public	function	Check if selected method is datalayer.
ExecutablePluginTrait::getLabelValue	protected	function	Get the translated label from the plugin definition.
ExecutablePluginTrait::summary	public	function	Get the translated summary from the label annotation.	4
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RulesActionBase::$configuration	protected	property	The plugin configuration. Overrides PluginBase::$configuration
RulesActionBase::access	public	function	Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata	public	function	Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext	public	function	Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext	14
RulesActionBase::calculateDependencies	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::defaultConfiguration	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute	2
RulesActionBase::executeMultiple	public	function	@todo this documentation is not actually inherited from any interface. Do we need this empty implementation?
RulesActionBase::getConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginBase::getContextValue
RulesActionBase::refineContextDefinitions	public	function	Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions	5
RulesActionBase::setConfiguration	public	function	@todo this documentation is not actually inherited from any interface.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class Event in GA Push 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation