You are here

Home » API reference » Doubleclick for Publishers (DFP) 8 » TagInterface.php

interface TagInterface in Doubleclick for Publishers (DFP) 8

An interface for the DFP Ad tag configuration entity.

Hierarchy

Expanded class hierarchy of TagInterface

All classes that implement TagInterface

7 files declare their use of TagInterface
AdminSettings.php in src/Form/AdminSettings.php
Contains \Drupal\dfp\Form\AdminSettings.
DfpHtmlResponseAttachmentsProcessor.php in src/DfpHtmlResponseAttachmentsProcessor.php
Contains \Drupal\dfp\DfpResponseAttachmentsProcessor.
DfpTestBase.php in tests/src/Functional/DfpTestBase.php
Contains \Drupal\Tests\dfp\Functional\DfpTestBase.
Tag.php in src/Form/Tag.php
Contains \Drupal\dfp\Form\Tag.
TagView.php in src/View/TagView.php
Contains \Drupal\dfp\View\TagView.

... See full list

File

src/Entity/TagInterface.php, line 15
Contains \Drupal\dfp\Entity\TagInterface.

Namespace

Drupal\dfp\Entity
View source 
interface TagInterface extends ConfigEntityInterface {
  const ADUNIT_PATTERN_VALIDATION_REGEX = '@[^a-zA-Z0-9\\/\\-_\\.\\[\\]\\:]+@';
  const ADSENSE_TEXT_IMAGE = 'text_image';
  const ADSENSE_IMAGE = 'image';
  const ADSENSE_TEXT = 'text';
  const GOOGLE_SHORT_TAG_SERVICES_URL = 'pubads.g.doubleclick.net/gampad';
  const GOOGLE_TAG_SERVICES_URL = 'www.googletagservices.com/tag/js/gpt.js';

  /**
   * Gets the ad slot.
   *
   * @return string
   *   The ad slot. This is the same as the label for the configuration entity.
   */
  public function slot();

  /**
   * Gets the ad size or sizes.
   *
   * @return string
   *   The ad size or sizes. Example: 300x600,300x250.
   */
  public function size();

  /**
   * Gets ad unit pattern.
   *
   * @return string
   *   The ad unit pattern. May contain tokens.
   */
  public function adunit();

  /**
   * Gets the slug.
   *
   * @return string
   *   The slug.
   */
  public function slug();

  /**
   * Determines whether the tag provides a block plugin.
   *
   * @return bool
   *   TRUE if the tag provides a block plugin, FALSE if not.
   *
   * @see \Drupal\dfp\Plugin\Derivative\TagBlock
   */
  public function hasBlock();

  /**
   * Determines whether to display the tag as a short tag.
   *
   * @return bool
   *   TRUE to display the tag as a short tag, FALSE if not.
   */
  public function shortTag();

  /**
   * Gets the ad targeting.
   *
   * @return array[]
   *   Each value is a array containing two keys: 'target' and 'value'. Both
   *   values are strings. Multiple value values are delimited by a comma.
   */
  public function targeting();

  /**
   * Gets the type of ads displayed when AdSense ads are used for backfill.
   *
   * @return string
   *   The type of ads displayed when AdSense ads are used for backfill.
   */
  public function adsenseAdTypes();

  /**
   * Gets the Adsense channel ID(s) when AdSense ads are used for backfill.
   *
   * @return string
   *   The Adsense channel ID(s) when AdSense ads are used for backfill.
   *   Multiple IDs are delimited by a + sign.
   */
  public function adsenseChannelIds();

  /**
   * Gets the color for a setting when AdSense ads are used for backfill.
   *
   * @param string $setting
   *   The setting to get the color for. Either: 'background', 'border', 'link',
   *   'text' or 'url'.
   *
   * @return string
   *   The color for a setting when AdSense ads are used for backfill. For
   *   example: FFFFFF.
   */
  public function adsenseColor($setting);

  /**
   * Gets the colors used when AdSense ads are used for backfill.
   *
   * @return string[]
   *   An array keyed by setting with hex colors as values.
   */
  public function adsenseColors();

  /**
   * Gets the breakpoints.
   *
   * @return array[]
   *   Each value is a array containing two keys: 'browser_size' and 'ad_sizes'.
   *   The 'browser_size' is a value such as '1024x768'. The 'ad_sizes' value
   *   contains a list of ad sizes to be be used at this 'browser_size'.
   */
  public function breakpoints();

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
TagInterface::adsenseAdTypes public function Gets the type of ads displayed when AdSense ads are used for backfill. 1
TagInterface::adsenseChannelIds public function Gets the Adsense channel ID(s) when AdSense ads are used for backfill. 1
TagInterface::adsenseColor public function Gets the color for a setting when AdSense ads are used for backfill. 1
TagInterface::adsenseColors public function Gets the colors used when AdSense ads are used for backfill. 1
TagInterface::ADSENSE_IMAGE constant
TagInterface::ADSENSE_TEXT constant
TagInterface::ADSENSE_TEXT_IMAGE constant
TagInterface::adunit public function Gets ad unit pattern. 1
TagInterface::ADUNIT_PATTERN_VALIDATION_REGEX constant
TagInterface::breakpoints public function Gets the breakpoints. 1
TagInterface::GOOGLE_SHORT_TAG_SERVICES_URL constant
TagInterface::GOOGLE_TAG_SERVICES_URL constant
TagInterface::hasBlock public function Determines whether the tag provides a block plugin. 1
TagInterface::shortTag public function Determines whether to display the tag as a short tag. 1
TagInterface::size public function Gets the ad size or sizes. 1
TagInterface::slot public function Gets the ad slot. 1
TagInterface::slug public function Gets the slug. 1
TagInterface::targeting public function Gets the ad targeting. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5