You are here

interface LingotekProfileInterface in Lingotek Translation 8

Same name and namespace in other branches
  1. 8.2 src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  2. 4.0.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  3. 3.0.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  4. 3.1.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  5. 3.2.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  6. 3.3.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  7. 3.4.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  8. 3.5.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  9. 3.6.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  10. 3.7.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
  11. 3.8.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface

Provides an interface defining a Lingotek profile entity.

Hierarchy

Expanded class hierarchy of LingotekProfileInterface

All classes that implement LingotekProfileInterface

4 files declare their use of LingotekProfileInterface
LingotekFake.php in tests/modules/lingotek_test/src/LingotekFake.php
LingotekProfile.php in src/Entity/LingotekProfile.php
Contains \Drupal\lingotek\Entity\LingotekProfile.
LingotekProfileFormBase.php in src/Form/LingotekProfileFormBase.php
Contains \Drupal\lingotek\Form\LingotekProfileFormBase.
LingotekProfileFormTest.php in src/Tests/Form/LingotekProfileFormTest.php

File

src/LingotekProfileInterface.php, line 14
Contains \Drupal\lingotek\LingotekProfileInterface.

Namespace

Drupal\lingotek
View source
interface LingotekProfileInterface extends ConfigEntityInterface {

  /**
   * The profile is not being used.
   */
  const USED_NEVER = 0;

  /**
   * The profile is being used in content.
   */
  const USED_IN_CONTENT = 1;

  /**
   * The profile is being used in config.
   */
  const USED_IN_CONFIG = 2;

  /**
   * The profile is being used in config.
   */
  const USED_BY_SETTINGS = 3;

  /**
   * Returns whether this profile is locked.
   *
   * @return bool
   *   Whether the profile is locked or not.
   */
  public function isLocked();

  /**
   * Gets the weight of the profile.
   *
   * @return int
   *   The weight, used to order profiles with larger positive weights sinking
   *   items toward the bottom of lists.
   */
  public function getWeight();

  /**
   * Sets the weight of the profile.
   *
   * @param int $weight
   *   The weight, used to order profiles with larger positive weights sinking
   *   items toward the bottom of lists.
   *
   * @return $this
   */
  public function setWeight($weight);

  /**
   * Returns whether this profile indicates automatic upload of sources.
   *
   * @return bool
   *   Whether the profile indicates automatic upload or not.
   */
  public function hasAutomaticUpload();

  /**
   * Sets whether this profile indicates automatic upload of sources.
   *
   * @param bool $auto_upload
   *   Whether the profile indicates automatic uploads or not.
   */
  public function setAutomaticUpload($auto_upload);

  /**
   * Returns whether this profile indicates automatic download of translations.
   *
   * @return bool
   *   Whether the profile indicates automatic download or not.
   */
  public function hasAutomaticDownload();

  /**
   * Sets whether this profile indicates automatic download of translations.
   *
   * @param bool $auto_download
   *   Whether the profile indicates automatic download or not.
   */
  public function setAutomaticDownload($auto_download);

  /**
   * Gets the TM vault of the profile.
   *
   * @return string
   *   The TM vault identifier, used to upload documents. If 'default', the
   *   default site vault should be used.
   */
  public function getVault();

  /**
   * Sets the TM vault of the profile.
   *
   * @param string $vault
   *   The TM vault identifier, used to upload documents. If 'default', the
   *   default site vault should be used.
   *
   * @return $this
   */
  public function setVault($vault);

  /**
   * Gets the TM project of the profile.
   *
   * @return string
   *   The TM project identifier, used to upload documents. If 'default', the
   *   default site project should be used.
   */
  public function getProject();

  /**
   * Sets the TM vault of the profile.
   *
   * @param string $project
   *   The TM project identifier, used to upload documents. If 'default', the
   *   default site project should be used.
   *
   * @return $this
   */
  public function setProject($project);

  /**
   * Gets the workflow of the profile.
   *
   * @return string
   *   The workflow identifier, used to request translations. If 'default', the
   *   default site workflow should be used.
   */
  public function getWorkflow();

  /**
   * Sets the workflow of the profile.
   *
   * @param string $workflow
   *   The workflow identifier, used to request translations. If 'default', the
   *   default site project should be used.
   *
   * @return $this
   */
  public function setWorkflow($workflow);

  /**
   * Returns whether this profile indicates automatic download of translations for
   * an specific target language.
   *
   * @param string $langcode
   *   The language code.
   *
   * @return bool
   *   Whether the profile indicates automatic download or not.
   */
  public function hasAutomaticDownloadForTarget($langcode);

  /**
   * Gets the workflow to be used for a given language.
   *
   * @param string $langcode
   *   The language code.
   *
   * @return string
   *   The workflow identifier, used to request translations. If 'default', the
   *   default site workflow should be used.
   */
  public function getWorkflowForTarget($langcode);

  /**
   * Checks if the profile has custom settings for a given target language.
   *
   * @param string $langcode
   *   The language code.
   *
   * @return bool
   *   TRUE if there are customizations, FALSE if not.
   */
  public function hasCustomSettingsForTarget($langcode);

}

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
LingotekProfileInterface::getProject public function Gets the TM project of the profile. 1
LingotekProfileInterface::getVault public function Gets the TM vault of the profile. 1
LingotekProfileInterface::getWeight public function Gets the weight of the profile. 1
LingotekProfileInterface::getWorkflow public function Gets the workflow of the profile. 1
LingotekProfileInterface::getWorkflowForTarget public function Gets the workflow to be used for a given language. 1
LingotekProfileInterface::hasAutomaticDownload public function Returns whether this profile indicates automatic download of translations. 1
LingotekProfileInterface::hasAutomaticDownloadForTarget public function Returns whether this profile indicates automatic download of translations for an specific target language. 1
LingotekProfileInterface::hasAutomaticUpload public function Returns whether this profile indicates automatic upload of sources. 1
LingotekProfileInterface::hasCustomSettingsForTarget public function Checks if the profile has custom settings for a given target language. 1
LingotekProfileInterface::isLocked public function Returns whether this profile is locked. 1
LingotekProfileInterface::setAutomaticDownload public function Sets whether this profile indicates automatic download of translations. 1
LingotekProfileInterface::setAutomaticUpload public function Sets whether this profile indicates automatic upload of sources. 1
LingotekProfileInterface::setProject public function Sets the TM vault of the profile. 1
LingotekProfileInterface::setVault public function Sets the TM vault of the profile. 1
LingotekProfileInterface::setWeight public function Sets the weight of the profile. 1
LingotekProfileInterface::setWorkflow public function Sets the workflow of the profile. 1
LingotekProfileInterface::USED_BY_SETTINGS constant The profile is being used in config.
LingotekProfileInterface::USED_IN_CONFIG constant The profile is being used in config.
LingotekProfileInterface::USED_IN_CONTENT constant The profile is being used in content.
LingotekProfileInterface::USED_NEVER constant The profile is not being used.
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