You are here

Home » API reference » Linkit 8.4 » ProfileInterface.php

interface ProfileInterface in Linkit 8.4

Same name and namespace in other branches
  1. 8.5 src/ProfileInterface.php \Drupal\linkit\ProfileInterface

Provides an interface defining a profile entity.

Hierarchy

Expanded class hierarchy of ProfileInterface

All classes that implement ProfileInterface

11 files declare their use of ProfileInterface
AddForm.php in src/Form/Attribute/AddForm.php
Contains \Drupal\linkit\Form\Attribute\AddForm.
AddForm.php in src/Form/Matcher/AddForm.php
Contains \Drupal\linkit\Form\Matcher\AddForm.
DeleteForm.php in src/Form/Attribute/DeleteForm.php
Contains \Drupal\linkit\Form\Attribute\DeleteForm.
DeleteForm.php in src/Form/Matcher/DeleteForm.php
Contains \Drupal\linkit\Form\Matcher\DeleteForm.
EditForm.php in src/Form/Attribute/EditForm.php
Contains \Drupal\linkit\Form\Attribute\EditForm.

... See full list

File

src/ProfileInterface.php, line 15
Contains \Drupal\linkit\ProfileInterface.

Namespace

Drupal\linkit
View source 
interface ProfileInterface extends ConfigEntityInterface {

  /**
   * Gets the profile description.
   *
   * @return string
   *   The profile description.
   */
  public function getDescription();

  /**
   * Sets the profile description.
   *
   * @param string $description
   *   The profile description.
   *
   * @return $this
   */
  public function setDescription($description);

  /**
   * Returns a specific attribute.
   *
   * @param string $attribute_id
   *   The attribute ID.
   *
   * @return \Drupal\linkit\AttributeInterface
   *   The attribute object.
   */
  public function getAttribute($attribute_id);

  /**
   * Returns the attributes for this profile.
   *
   * @return \Drupal\linkit\AttributeCollection|\Drupal\linkit\AttributeInterface[]
   *   The attribute collection.
   */
  public function getAttributes();

  /**
   * Adds an attribute to this profile.
   *
   * @param array $configuration
   *   An array of attribute configuration.
   *
   * @return String
   *   The ID of the attribute.
   */
  public function addAttribute(array $configuration);

  /**
   * Removes an attribute from this profile.
   *
   * @param string $attribute_id
   *  The attribute ID.
   *
   * @return $this
   */
  public function removeAttribute($attribute_id);

  /**
   * Sets the configuration for an attribute instance.
   *
   * @param string $attribute_id
   *   The ID of the attribute to set the configuration for.
   * @param array $configuration
   *   The attribute configuration to set.
   *
   * @return $this
   */
  public function setAttributeConfig($attribute_id, array $configuration);

  /**
   * Returns a specific matcher.
   *
   * @param string $instance_id
   *   The matcher instance ID.
   *
   * @return \Drupal\linkit\MatcherInterface
   *   The matcher object.
   */
  public function getMatcher($instance_id);

  /**
   * Returns the matchers for this profile.
   *
   * @return \Drupal\linkit\MatcherCollection|\Drupal\linkit\MatcherInterface[]
   *   The matcher collection.
   */
  public function getMatchers();

  /**
   * Adds a matcher to this profile.
   *
   * @param array $configuration
   *   An array of matcher configuration.
   *
   * @return string
   *   The instance ID of the matcher.
   */
  public function addMatcher(array $configuration);

  /**
   * Removes a matcher from this profile.
   *
   * @param \Drupal\linkit\MatcherInterface $matcher
   *  The matcher object.
   *
   * @return $this
   */
  public function removeMatcher(MatcherInterface $matcher);

  /**
   * Sets the configuration for a matcher instance.
   *
   * @param string $instance_id
   *   The instance ID of the matcher to set the configuration for.
   * @param array $configuration
   *   The matcher configuration to set.
   *
   * @return $this
   */
  public function setMatcherConfig($instance_id, array $configuration);

}

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
ProfileInterface::addAttribute public function Adds an attribute to this profile. 1
ProfileInterface::addMatcher public function Adds a matcher to this profile. 1
ProfileInterface::getAttribute public function Returns a specific attribute. 1
ProfileInterface::getAttributes public function Returns the attributes for this profile. 1
ProfileInterface::getDescription public function Gets the profile description. 1
ProfileInterface::getMatcher public function Returns a specific matcher. 1
ProfileInterface::getMatchers public function Returns the matchers for this profile. 1
ProfileInterface::removeAttribute public function Removes an attribute from this profile. 1
ProfileInterface::removeMatcher public function Removes a matcher from this profile. 1
ProfileInterface::setAttributeConfig public function Sets the configuration for an attribute instance. 1
ProfileInterface::setDescription public function Sets the profile description. 1
ProfileInterface::setMatcherConfig public function Sets the configuration for a matcher instance. 1
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