interface AmpMetadataInterface in Accelerated Mobile Pages (AMP) 8

Provides an interface for defining AMP Metadata entities.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\amp\AmpMetadataInterface

Expanded class hierarchy of AmpMetadataInterface

All classes that implement AmpMetadataInterface

3 files declare their use of AmpMetadataInterface

AmpMergeMetadata.php in src/Utility/AmpMergeMetadata.php
AmpMetadata.php in src/Entity/AmpMetadata.php
AmpMetadataListBuilder.php in src/AmpMetadataListBuilder.php

File

src/AmpMetadataInterface.php, line 10

Namespace

Drupal\amp

View source

interface AmpMetadataInterface extends ConfigEntityInterface {

  /**
   * Check if the settings apply globally.
   *
   * @return boolean
   *   TRUE if the settings apply globally.
   */
  public function isGlobal();

  /**
   * Apply these settings globally.
   */
  public function setGlobal();

  /**
   * Get the node type for these settings.
   *
   * @return string
   *   The identifier of the node type.
   */
  public function getNodeType();

  /**
   * Apply these settings per node type.
   *
   * @param string $node_type_id
   *   The identifier of the node type.
   */
  public function setNodeType($node_type_id);

  /**
   * Get the organization name.
   *
   * @return string
   *   The name of the organization.
   */
  public function getOrganizationName();

  /**
   * Set the organization name.
   *
   * @param string $organization_name
   *   The name of the organization.
   */
  public function setOrganizationName($organization_name);

  /**
   * Get the organization logo FID.
   *
   * @return string
   *   The fid of the organization logo.
   */
  public function getOrganizationLogoFid();

  /**
   * Set the organization logo FID.
   *
   * @param string $organization_logo_fid
   *   The fid of the organization logo.
   */
  public function setOrganizationLogoFid($organization_logo_fid);

  /**
   * Get the organization logo image style ID.
   *
   * @return string
   *   The ID of the organization logo image style.
   */
  public function getOrganizationLogoImageStyleId();

  /**
   * Set the organization logo image style ID.
   *
   * The image style should output a JPG, PNG or GIF, fitting within a 600x60
   * space. The height must be 60px, unless the width is 600px, and the aspect
   * ratio requires a height smaller than 60px.
   *
   * @param string $organization_logo_image_style_id
   *   The ID of the organization logo image style.
   */
  public function setOrganizationLogoImageStyleId($organization_logo_image_style_id);

  /**
   * Get the content schema type.
   *
   * @return string
   *   The schema type of this content.
   */
  public function getContentSchemaType();

  /**
   * Set the content schema type.
   *
   * Values can include:
   * - 'Article'
   * - 'NewsArticle'
   * - 'BlogPosting'
   *
   * @param string $content_schema_type
   *   The schema type of this content.
   */
  public function setContentSchemaType($content_schema_type);

  /**
   * Get the content headline token.
   *
   * @return string
   *   The token for the content headline.
   */
  public function getContentHeadlineToken();

  /**
   * Set the content headline token.
   *
   * Typically this will be a token for either the node title or a separate
   * field containing a short headline. Should be limited to 110 characters.
   *
   * @param string $content_headline_token
   *   The token for the content headline.
   */
  public function setContentHeadlineToken($content_headline_token);

  /**
   * Get the content author token.
   *
   * @return string
   *   The token for the content author.
   */
  public function getContentAuthorToken();

  /**
   * Set the content author token.
   *
   * Typically this will be a token for the node author in order to correctly
   * show the author for each node.
   *
   * @param string $content_author_token
   *   The token for the content author.
   */
  public function setContentAuthorToken($content_author_token);

  /**
   * Get the content description token.
   *
   * @return string
   *   The token for the content description.
   */
  public function getContentDescriptionToken();

  /**
   * Set the content description token.
   *
   * Typically this will be a token for either the node body summary or a
   * separate field containing the description. Should be limited to 150 chars.
   *
   * @param string $content_description_token
   *   The token for the content description.
   */
  public function setContentDescriptionToken($content_description_token);

  /**
   * Get the content image token.
   *
   * @return string
   *   The token for the content image.
   */
  public function getContentImageToken();

  /**
   * Set the content image token.
   *
   * @param string $content_image_token
   *   The token for the content image.
   */
  public function setContentImageToken($content_image_token);

  /**
   * Get the content image style ID.
   *
   * @return string
   *   The ID for the content image style.
   */
  public function getContentImageStyleId();

  /**
   * Set the content image style ID.
   *
   * The image style should output an image at least 696px wide.
   *
   * @param string $content_image_style_id
   *   The ID for the content image style.
   */
  public function setContentImageStyleId($content_image_style_id);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
AmpMetadataInterface::getContentAuthorToken	public	function	Get the content author token.	1
AmpMetadataInterface::getContentDescriptionToken	public	function	Get the content description token.	1
AmpMetadataInterface::getContentHeadlineToken	public	function	Get the content headline token.	1
AmpMetadataInterface::getContentImageStyleId	public	function	Get the content image style ID.	1
AmpMetadataInterface::getContentImageToken	public	function	Get the content image token.	1
AmpMetadataInterface::getContentSchemaType	public	function	Get the content schema type.	1
AmpMetadataInterface::getNodeType	public	function	Get the node type for these settings.	1
AmpMetadataInterface::getOrganizationLogoFid	public	function	Get the organization logo FID.	1
AmpMetadataInterface::getOrganizationLogoImageStyleId	public	function	Get the organization logo image style ID.	1
AmpMetadataInterface::getOrganizationName	public	function	Get the organization name.	1
AmpMetadataInterface::isGlobal	public	function	Check if the settings apply globally.	1
AmpMetadataInterface::setContentAuthorToken	public	function	Set the content author token.	1
AmpMetadataInterface::setContentDescriptionToken	public	function	Set the content description token.	1
AmpMetadataInterface::setContentHeadlineToken	public	function	Set the content headline token.	1
AmpMetadataInterface::setContentImageStyleId	public	function	Set the content image style ID.	1
AmpMetadataInterface::setContentImageToken	public	function	Set the content image token.	1
AmpMetadataInterface::setContentSchemaType	public	function	Set the content schema type.	1
AmpMetadataInterface::setGlobal	public	function	Apply these settings globally.	1
AmpMetadataInterface::setNodeType	public	function	Apply these settings per node type.	1
AmpMetadataInterface::setOrganizationLogoFid	public	function	Set the organization logo FID.	1
AmpMetadataInterface::setOrganizationLogoImageStyleId	public	function	Set the organization logo image style ID.	1
AmpMetadataInterface::setOrganizationName	public	function	Set the organization name.	1
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
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

You are here

interface AmpMetadataInterface in Accelerated Mobile Pages (AMP) 8

Hierarchy

File

Namespace

Members

API Navigation