You are here

class AmpAnalytics in Accelerated Mobile Pages (AMP) 8

Same name and namespace in other branches
  1. 8.3 src/Element/AmpAnalytics.php \Drupal\amp\Element\AmpAnalytics
  2. 8.2 src/Element/AmpAnalytics.php \Drupal\amp\Element\AmpAnalytics

Provides a render element for amp-analytics.

By default, this element sets #theme so that the 'amp_analytics' theme hook is used for rendering, and attaches the js needed for the amp-analytics component.

Properties:

  • #account: An array with iframe details. See template_preprocess_amp_iframe() for documentation of the properties in this array.

Plugin annotation

@RenderElement("amp_analytics");

Hierarchy

Expanded class hierarchy of AmpAnalytics

1 #type use of AmpAnalytics
amp_page_bottom in ./amp.module
Implements hook_page_bottom for page bottom.

File

src/Element/AmpAnalytics.php, line 25
Contains \Drupal\amp\Element\AmpAnalytics.

Namespace

Drupal\amp\Element
View source
class AmpAnalytics extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#account' => NULL,
      '#attributes' => [],
      '#pre_render' => array(
        array(
          $class,
          'preRenderAnalytics',
        ),
      ),
      '#theme' => 'amp_analytics',
      '#cache' => [
        'contexts' => [
          'url.query_args:amp',
        ],
      ],
    );
  }

  /**
   * Pre-render callback: Attaches the amp-analytics library.
   */
  public static function preRenderAnalytics($element) {
    $element['#attached']['library'][] = 'amp/amp.analytics';
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AmpAnalytics::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
AmpAnalytics::preRenderAnalytics public static function Pre-render callback: Attaches the amp-analytics library.
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.