interface ShareMessageInterface in Share Message 8

Define interface for ShareMessage entity.

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\sharemessage\ShareMessageInterface

Expanded class hierarchy of ShareMessageInterface

All classes that implement ShareMessageInterface

2 files declare their use of ShareMessageInterface

sharemessage.api.php in ./sharemessage.api.php: Hooks provided by Share Message module.
ShareMessage.php in src/Entity/ShareMessage.php

File

src/ShareMessageInterface.php, line 10

Namespace

Drupal\sharemessage

View source

interface ShareMessageInterface extends ConfigEntityInterface {

  /**
   * Sets the internal Share Message label.
   *
   * @param string $label
   *   A human-readable label representing the internal Share Message label.
   *
   * @return $this
   */
  public function setLabel($label);

  /**
   * Sets the Share Message title used when sharing.
   *
   * @param string $title
   *   The title of the Share Message to be set.
   *
   * @return $this
   */
  public function setTitle($title);

  /**
   * Returns the plugin instance.
   *
   * @return \Drupal\sharemessage\SharePluginInterface
   *   The plugin instance for this Share Message.
   */
  public function getPlugin();

  /**
   * Returns the Share Message plugin ID.
   *
   * @return string
   *   The Share Message plugin ID used by this Share Message.
   */
  public function getPluginId();

  /**
   * Sets the plugin ID.
   *
   * @param string $plugin_id
   *   The Share Message plugin ID to be set.
   *
   * @return $this
   */
  public function setPluginID($plugin_id);

  /**
   * Checks whether the Share Message plugin of this Share Message exists.
   *
   * @return bool
   *   TRUE if the Share Message plugin exists, FALSE otherwise.
   */
  public function hasPlugin();

  /**
   * Gets the definition of the plugin implementation.
   *
   * @return array
   *   The plugin definition, as returned by the discovery object used by the
   *   plugin manager.
   */
  public function getPluginDefinition();

  /**
   * Gets the default settings.
   *
   * @param string $key
   *   The settings key.
   *
   * @return mixed
   *   The default settings.
   */
  public function getSetting($key);

  /**
   * Sets an additional runtime context for tokenizing.
   *
   * @param array $context
   *   The context that will be used for following token replacements when this
   *   Share Message is shown.
   */
  public function setRuntimeContext(array $context);

  /**
   * Gets a context for tokenizing.
   *
   * @param string $view_mode
   *   (optional) The view mode that should be used to render the item.
   *
   * @return array
   *   An array containing the following elements:
   *     - sharemessage: This entity.
   *     - node: The node target for the current request, if any.
   *   The array is altered by modules implementing
   *   hook_sharemessage_token_context().
   */
  public function getContext($view_mode = 'full');

  /**
   * Returns Open Graph meta tags for <head>.
   *
   * @param array $context
   *   The context for the token replacements.
   *
   * @return array
   *   An array containing the Open Graph meta tags:
   *     - title
   *     - image: If at least one image Url is given.
   *     - video, video:width, video:height, video:type:
   *       If at least one video Url is given.
   *     - url
   *     - description
   *     - type
   */
  public function buildOGTags($context);

  /**
   * Adds meta tags in order to share images on Twitter.
   *
   * @param array $context
   *   The context for the token replacements.
   *
   * @return array
   *   The twitter tags.
   */
  public function buildTwitterCardTags($context);

  /**
   * Tokenizes a field, if it is set.
   *
   * @param string $property_value
   *   A field value.
   * @param array $context
   *   A context array for Token::replace().
   * @param string $default
   *   (optional) Default value if field value is not set.
   *
   * @return string
   *   If existent, the field value with tokens replace, the default otherwise.
   */
  public function getTokenizedField($property_value, $context, $default = '');

  /**
   * Gets the Share Message URL.
   *
   * @param array $context
   *   The context for the token replacements.
   *
   * @return string
   *   The URL for this Share Message.
   */
  public function getUrl($context);

  /**
   * Gets the selected entity type.
   *
   * @return string
   *   The entity type.
   */
  public function getExtraFieldEntityType();

  /**
   * Sets the selected entity type.
   *
   * @param string $extra_field_entity_type
   *   The entity type to be set.
   */
  public function setExtraFieldEntityType($extra_field_entity_type);

  /**
   * Gets the enabled entity type bundles list.
   *
   * @return array
   *   The entity type bundles list.
   */
  public function getExtraFieldBundles();

  /**
   * Sets the enabled entity type bundles list.
   *
   * @param string[] $extra_field_bundles
   *   The entity type bundles list to be set.
   */
  public function setExtraFieldBundles(array $extra_field_bundles);

}

Members

Name	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
ShareMessageInterface::buildOGTags	public	function	Returns Open Graph meta tags for <head>.	1
ShareMessageInterface::buildTwitterCardTags	public	function	Adds meta tags in order to share images on Twitter.	1
ShareMessageInterface::getContext	public	function	Gets a context for tokenizing.	1
ShareMessageInterface::getExtraFieldBundles	public	function	Gets the enabled entity type bundles list.	1
ShareMessageInterface::getExtraFieldEntityType	public	function	Gets the selected entity type.	1
ShareMessageInterface::getPlugin	public	function	Returns the plugin instance.	1
ShareMessageInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	1
ShareMessageInterface::getPluginId	public	function	Returns the Share Message plugin ID.	1
ShareMessageInterface::getSetting	public	function	Gets the default settings.	1
ShareMessageInterface::getTokenizedField	public	function	Tokenizes a field, if it is set.	1
ShareMessageInterface::getUrl	public	function	Gets the Share Message URL.	1
ShareMessageInterface::hasPlugin	public	function	Checks whether the Share Message plugin of this Share Message exists.	1
ShareMessageInterface::setExtraFieldBundles	public	function	Sets the enabled entity type bundles list.	1
ShareMessageInterface::setExtraFieldEntityType	public	function	Sets the selected entity type.	1
ShareMessageInterface::setLabel	public	function	Sets the internal Share Message label.	1
ShareMessageInterface::setPluginID	public	function	Sets the plugin ID.	1
ShareMessageInterface::setRuntimeContext	public	function	Sets an additional runtime context for tokenizing.	1
ShareMessageInterface::setTitle	public	function	Sets the Share Message title used when sharing.	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 ShareMessageInterface in Share Message 8

Hierarchy

File

Namespace

Members

API Navigation