class AmpAnalytics in Accelerated Mobile Pages (AMP) 8.2
Same name and namespace in other branches
- 8.3 src/Element/AmpAnalytics.php \Drupal\amp\Element\AmpAnalytics
 - 8 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
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\amp\Element\AmpAnalytics
 
 
 - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
 
 - class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
 
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 20  
Namespace
Drupal\amp\ElementView 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
| 
            Name | 
                  Modifiers | Type | Description | Overrides | 
|---|---|---|---|---|
| 
            AmpAnalytics:: | 
                  public | function | 
            Returns the element properties for this element. Overrides ElementInterface:: | 
                  |
| 
            AmpAnalytics:: | 
                  public static | function | Pre-render callback: Attaches the amp-analytics library. | |
| 
            DependencySerializationTrait:: | 
                  protected | property | An array of entity type IDs keyed by the property name of their storages. | |
| 
            DependencySerializationTrait:: | 
                  protected | property | An array of service IDs keyed by property name used for serialization. | |
| 
            DependencySerializationTrait:: | 
                  public | function | 1 | |
| 
            DependencySerializationTrait:: | 
                  public | function | 2 | |
| 
            MessengerTrait:: | 
                  protected | property | The messenger. | 29 | 
| 
            MessengerTrait:: | 
                  public | function | Gets the messenger. | 29 | 
| 
            MessengerTrait:: | 
                  public | function | Sets the messenger. | |
| 
            PluginBase:: | 
                  protected | property | Configuration information passed into the plugin. | 1 | 
| 
            PluginBase:: | 
                  protected | property | The plugin implementation definition. | 1 | 
| 
            PluginBase:: | 
                  protected | property | The plugin_id. | |
| 
            PluginBase:: | 
                  constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
| 
            PluginBase:: | 
                  public | function | 
            Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: | 
                  |
| 
            PluginBase:: | 
                  public | function | 
            Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: | 
                  |
| 
            PluginBase:: | 
                  public | function | 
            Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: | 
                  3 | 
| 
            PluginBase:: | 
                  public | function | 
            Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: | 
                  |
| 
            PluginBase:: | 
                  public | function | Determines if the plugin is configurable. | |
| 
            PluginBase:: | 
                  public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 | 
| 
            RenderElement:: | 
                  public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
| 
            RenderElement:: | 
                  public static | function | Adds members of this group as actual elements for rendering. | |
| 
            RenderElement:: | 
                  public static | function | Form element processing handler for the #ajax form property. | 1 | 
| 
            RenderElement:: | 
                  public static | function | Arranges elements into groups. | |
| 
            RenderElement:: | 
                  public static | function | 
            Sets a form element's class attribute. Overrides ElementInterface:: | 
                  |
| 
            StringTranslationTrait:: | 
                  protected | property | The string translation service. | 1 | 
| 
            StringTranslationTrait:: | 
                  protected | function | Formats a string containing a count of items. | |
| 
            StringTranslationTrait:: | 
                  protected | function | Returns the number of plurals supported by a given language. | |
| 
            StringTranslationTrait:: | 
                  protected | function | Gets the string translation service. | |
| 
            StringTranslationTrait:: | 
                  public | function | Sets the string translation service to use. | 2 | 
| 
            StringTranslationTrait:: | 
                  protected | function | Translates a string to the current language or to a given language. |