You are here

Home » API reference » Google AdWords Conversion Tracking 8 » GoogleAdWordsInlineJS.php

class GoogleAdWordsInlineJS in Google AdWords Conversion Tracking 8

Plugin implementation of the 'google_adwords_inlinejs' formatter.

Plugin annotation


@FieldFormatter(
  id = "google_adwords_inlinejs",
  label = @Translation("Google AdWords inline"),
  field_types = {
    "google_adwords_tracking"
  }
)

Hierarchy

Expanded class hierarchy of GoogleAdWordsInlineJS

File

src/Plugin/Field/FieldFormatter/GoogleAdWordsInlineJS.php, line 26
Contains \Drupal\google_adwords\Plugin\Field\FieldFormatter\GoogleAdWordsInlineJS.

Namespace

Drupal\google_adwords\Plugin\Field\FieldFormatter
View source 
class GoogleAdWordsInlineJS extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array() + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return array() + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];

    // Implement settings summary.
    return $summary;
  }

  /**
   * {@inheritdoc}
   *
   * @returns [] Empty array
   *   We don't actually want any output, just tracking
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    /**
     * @var \Drupal\google_adwords\GoogleAdwordsTracker $tracker
     */
    $tracker = \Drupal::getContainer()
      ->get('google_adwords.tracker');

    /**
     * @var \Drupal\Core\Config\ImmutableConfig $config
     *   saved settings for google_adwords
     */
    $config = \Drupal::config('google_adwords.settings');

    /**
     * @var \Drupal\Core\Session\AccountProxyInterface $user
     *   Current User
     */
    $user = \Drupal::currentUser();

    /**
     * @var array(string) $roles
     *  array of role ids for the current user
     */
    $roles = $user
      ->getRoles();
    if (is_array($roles)) {

      /**
       * @var string $role_id
       */
      foreach ($roles as $role_id) {

        // look for the first trackeable role

        /**
         * @TODO make this a single array in the $config
         *   There is no need for separate vars here (no efficieny, no memory)
         */
        if (TRUE || $config
          ->get('google_adwords_track_' . $role_id)) {

          // add each item as a themed conversion item
          foreach ($items as $delta => $item) {

            /**
             * @var \Drupal\Core\TypedData\Plugin\DataType\StringData $words
             */
            $words = $item
              ->get('words');
            $tracker
              ->addTracking($config
              ->get('conversion_id'), $config
              ->get('label'), (string) $words
              ->getCastedValue(), $langcode, $config
              ->get('color'), $config
              ->get('format'));
          }

          // break out of our role-checker (as we already passed at least 1 role)
          break;
        }
      }
    }

    /**
     * @return [] an empty array, we don't want output, we just want tracking
     */
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
GoogleAdWordsInlineJS::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
GoogleAdWordsInlineJS::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
GoogleAdWordsInlineJS::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
GoogleAdWordsInlineJS::viewElements public function @returns [] Empty array We don't actually want any output, just tracking Overrides FormatterInterface::viewElements
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.