You are here

Home » API reference » Accelerated Mobile Pages (AMP) 8 » AmpMetadata.php

class AmpMetadata in Accelerated Mobile Pages (AMP) 8

Defines the AMP Metadata entity.

Plugin annotation


@ConfigEntityType(
  id = "amp_metadata",
  label = @Translation("AMP Metadata"),
  handlers = {
    "list_builder" = "Drupal\amp\AmpMetadataListBuilder",
    "form" = {
      "add" = "Drupal\amp\Form\AmpMetadataForm",
      "edit" = "Drupal\amp\Form\AmpMetadataForm",
      "delete" = "Drupal\amp\Form\AmpMetadataDeleteForm"
    },
    "route_provider" = {
      "html" = "Drupal\amp\AmpMetadataHtmlRouteProvider",
    },
  },
  config_prefix = "metadata",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  lookup_keys = {
    "globalToggle",
    "nodeTypeId"
  },
  links = {
    "canonical" = "/admin/config/content/amp/metadata/{amp_metadata}",
    "add-form" = "/admin/config/content/amp/metadata/add",
    "edit-form" = "/admin/config/content/amp/metadata/{amp_metadata}/edit",
    "delete-form" = "/admin/config/content/amp/metadata/{amp_metadata}/delete",
    "collection" = "/admin/config/content/amp/metadata"
  }
)

Hierarchy

Expanded class hierarchy of AmpMetadata

1 file declares its use of AmpMetadata
AmpMetadataForm.php in src/Form/AmpMetadataForm.php

File

src/Entity/AmpMetadata.php, line 44

Namespace

Drupal\amp\Entity
View source 
class AmpMetadata extends ConfigEntityBase implements AmpMetadataInterface {

  /**
   * The AMP Metadata ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The AMP Metadata label.
   *
   * @var string
   */
  protected $label;

  /**
   * The toggle for whether these settings apply globally or per content-type.
   *
   * @var boolean
   */
  protected $globalToggle;

  /**
   * The ID for a content type if these settings apply per content-type.
   *
   * @var string
   */
  protected $nodeTypeId;

  /**
   * The organization name.
   *
   * @var string
   */
  protected $organizationName;

  /**
   * The organization logo fid.
   *
   * @var string
   */
  protected $organizationLogoFid;

  /**
   * 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.
   *
   * @var string
   */
  protected $organizationLogoImageStyleId;

  /**
   * The content schema type.
   *
   * Values can include:
   * - 'Article'
   * - 'NewsArticle'
   * - 'BlogPosting'
   *
   * @var string
   */
  protected $contentSchemaType;

  /**
   * 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.
   *
   * @var string
   */
  protected $contentHeadlineToken;

  /**
   * The content author token.
   *
   * Typically this will be a token for the node author in order to correctly
   * show the author for each node.
   *
   * @var string
   */
  protected $contentAuthorToken;

  /**
   * 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.
   *
   * @var string
   */
  protected $contentDescriptionToken;

  /**
   * The content image token.
   *
   * @var string
   */
  protected $contentImageToken;

  /**
   * The content image style ID.
   *
   * The image style should output an image at least 696px wide: an image style
   * applied to the token image can help ensure that width.
   *
   * @var string
   */
  protected $contentImageStyleId;

  /**
   * {@inheritdoc}
   */
  public function isGlobal() {
    return $this->globalToggle;
  }

  /**
   * {@inheritdoc}
   */
  public function setGlobal() {
    $this->globalToggle = TRUE;
    $this->nodeTypeId = NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getNodeType() {
    if ($this->globalToggle || empty($this->nodeTypeId)) {
      return NULL;
    }
    else {
      return $this->nodeTypeId;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setNodeType($node_type_id) {
    $this->globalToggle = FALSE;
    $this->nodeTypeId = $node_type_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getOrganizationName() {
    return $this->organizationName;
  }

  /**
   * {@inheritdoc}
   */
  public function setOrganizationName($organization_name) {
    $this->organizationName = $organization_name;
  }

  /**
   * {@inheritdoc}
   */
  public function getOrganizationLogoFid() {
    return $this->organizationLogoFid;
  }

  /**
   * {@inheritdoc}
   */
  public function setOrganizationLogoFid($organization_logo_fid) {
    $this->organizationLogoFid = $organization_logo_fid;
  }

  /**
   * {@inheritdoc}
   */
  public function getOrganizationLogoImageStyleId() {
    return $this->organizationLogoImageStyleId;
  }

  /**
   * {@inheritdoc}
   */
  public function setOrganizationLogoImageStyleId($organization_logo_image_style_id) {
    $this->organizationLogoImageStyleId = $organization_logo_image_style_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getContentSchemaType() {
    return $this->contentSchemaType;
  }

  /**
   * {@inheritdoc}
   */
  public function setContentSchemaType($content_schema_type) {
    $valid_schema_types = [
      'Article',
      'NewsArticle',
      'BlogPosting',
    ];
    if (in_array($content_schema_type, $valid_schema_types)) {
      $this->contentSchemaType = $content_schema_type;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getContentHeadlineToken() {
    return $this->contentHeadlineToken;
  }

  /**
   * {@inheritdoc}
   */
  public function setContentHeadlineToken($content_headline_token) {
    $this->contentHeadlineToken = $content_headline_token;
  }

  /**
   * {@inheritdoc}
   */
  public function getContentAuthorToken() {
    return $this->contentAuthorToken;
  }

  /**
   * {@inheritdoc}
   */
  public function setContentAuthorToken($content_author_token) {
    $this->contentAuthorToken = $content_author_token;
  }

  /**
   * {@inheritdoc}
   */
  public function getContentDescriptionToken() {
    return $this->contentDescriptionToken;
  }

  /**
   * {@inheritdoc}
   */
  public function setContentDescriptionToken($content_description_token) {
    $this->contentDescriptionToken = $content_description_token;
  }

  /**
   * {@inheritdoc}
   */
  public function getContentImageToken() {
    return $this->contentImageToken;
  }

  /**
   * {@inheritdoc}
   */
  public function setContentImageToken($content_image_token) {
    $this->contentImageToken = $content_image_token;
  }

  /**
   * {@inheritdoc}
   */
  public function getContentImageStyleId() {
    return $this->contentImageStyleId;
  }

  /**
   * {@inheritdoc}
   */
  public function setContentImageStyleId($content_image_style_id) {
    $this->contentImageStyleId = $content_image_style_id;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AmpMetadata::$contentAuthorToken protected property The content author token.
AmpMetadata::$contentDescriptionToken protected property The content description token.
AmpMetadata::$contentHeadlineToken protected property The content headline token.
AmpMetadata::$contentImageStyleId protected property The content image style ID.
AmpMetadata::$contentImageToken protected property The content image token.
AmpMetadata::$contentSchemaType protected property The content schema type.
AmpMetadata::$globalToggle protected property The toggle for whether these settings apply globally or per content-type.
AmpMetadata::$id protected property The AMP Metadata ID.
AmpMetadata::$label protected property The AMP Metadata label.
AmpMetadata::$nodeTypeId protected property The ID for a content type if these settings apply per content-type.
AmpMetadata::$organizationLogoFid protected property The organization logo fid.
AmpMetadata::$organizationLogoImageStyleId protected property The organization logo image style ID.
AmpMetadata::$organizationName protected property The organization name.
AmpMetadata::getContentAuthorToken public function Get the content author token. Overrides AmpMetadataInterface::getContentAuthorToken
AmpMetadata::getContentDescriptionToken public function Get the content description token. Overrides AmpMetadataInterface::getContentDescriptionToken
AmpMetadata::getContentHeadlineToken public function Get the content headline token. Overrides AmpMetadataInterface::getContentHeadlineToken
AmpMetadata::getContentImageStyleId public function Get the content image style ID. Overrides AmpMetadataInterface::getContentImageStyleId
AmpMetadata::getContentImageToken public function Get the content image token. Overrides AmpMetadataInterface::getContentImageToken
AmpMetadata::getContentSchemaType public function Get the content schema type. Overrides AmpMetadataInterface::getContentSchemaType
AmpMetadata::getNodeType public function Get the node type for these settings. Overrides AmpMetadataInterface::getNodeType
AmpMetadata::getOrganizationLogoFid public function Get the organization logo FID. Overrides AmpMetadataInterface::getOrganizationLogoFid
AmpMetadata::getOrganizationLogoImageStyleId public function Get the organization logo image style ID. Overrides AmpMetadataInterface::getOrganizationLogoImageStyleId
AmpMetadata::getOrganizationName public function Get the organization name. Overrides AmpMetadataInterface::getOrganizationName
AmpMetadata::isGlobal public function Check if the settings apply globally. Overrides AmpMetadataInterface::isGlobal
AmpMetadata::setContentAuthorToken public function Set the content author token. Overrides AmpMetadataInterface::setContentAuthorToken
AmpMetadata::setContentDescriptionToken public function Set the content description token. Overrides AmpMetadataInterface::setContentDescriptionToken
AmpMetadata::setContentHeadlineToken public function Set the content headline token. Overrides AmpMetadataInterface::setContentHeadlineToken
AmpMetadata::setContentImageStyleId public function Set the content image style ID. Overrides AmpMetadataInterface::setContentImageStyleId
AmpMetadata::setContentImageToken public function Set the content image token. Overrides AmpMetadataInterface::setContentImageToken
AmpMetadata::setContentSchemaType public function Set the content schema type. Overrides AmpMetadataInterface::setContentSchemaType
AmpMetadata::setGlobal public function Apply these settings globally. Overrides AmpMetadataInterface::setGlobal
AmpMetadata::setNodeType public function Apply these settings per node type. Overrides AmpMetadataInterface::setNodeType
AmpMetadata::setOrganizationLogoFid public function Set the organization logo FID. Overrides AmpMetadataInterface::setOrganizationLogoFid
AmpMetadata::setOrganizationLogoImageStyleId public function Set the organization logo image style ID. Overrides AmpMetadataInterface::setOrganizationLogoImageStyleId
AmpMetadata::setOrganizationName public function Set the organization name. Overrides AmpMetadataInterface::setOrganizationName
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
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 Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function