interface LingotekProfileInterface in Lingotek Translation 3.4.x
Same name and namespace in other branches
- 8 src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 8.2 src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 4.0.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.0.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.1.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.2.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.3.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.5.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.6.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.7.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
- 3.8.x src/LingotekProfileInterface.php \Drupal\lingotek\LingotekProfileInterface
Provides an interface defining a Lingotek profile entity.
Hierarchy
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface; interface \Drupal\lingotek\LingotekFilterProviderInterface
- interface \Drupal\lingotek\LingotekProfileInterface
Expanded class hierarchy of LingotekProfileInterface
All classes that implement LingotekProfileInterface
5 files declare their use of LingotekProfileInterface
- lingotek.post_update.php in ./
lingotek.post_update.php - Post update functions for Lingotek.
- LingotekFake.php in tests/
modules/ lingotek_test/ src/ LingotekFake.php - LingotekFakeBC.php in tests/
modules/ lingotek_test/ src/ LingotekFakeBC.php - LingotekProfile.php in src/
Entity/ LingotekProfile.php - lingotek_test.module in tests/
modules/ lingotek_test/ lingotek_test.module - Provides a fake Lingotek API endpoint and other help for testing purposes.
File
- src/
LingotekProfileInterface.php, line 10
Namespace
Drupal\lingotekView source
interface LingotekProfileInterface extends ConfigEntityInterface, LingotekFilterProviderInterface {
/**
* 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();
/**
* Returns value of append content type to title option.
*
* @return string
* Values will be 'global_setting', 'yes', or 'no'
*/
public function getAppendContentTypeToTitle();
/**
* Sets the value of append content type to title option.
*
* @param string $append_type_to_title
* Values can be 'global_setting', 'yes', or 'no'
*
* @return $this
*/
public function setAppendContentTypeToTitle($append_type_to_title = 'global_setting');
/**
* 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.
*
* @return $this
*/
public function setAutomaticUpload($auto_upload);
/**
* Returns whether this profile indicates automatic request of translations.
*
* @return bool
* Whether the profile indicates automatic request or not.
*/
public function hasAutomaticRequest();
/**
* Sets whether this profile indicates automatic request of translations.
*
* @param bool $auto_request
* Whether the profile indicates automatic request or not.
*
* @return $this
*/
public function setAutomaticRequest($auto_request);
/**
* 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.
*
* @return $this
*/
public function setAutomaticDownload($auto_download);
/**
* Returns whether this profile indicates automatically adding downloads to a worker queue.
*
* @return bool
* Whether the profile indicates automatic adding downloads to a worker queue.
*/
public function hasAutomaticDownloadWorker();
/**
* Sets whether this profile indicates automatically adding downloads to a worker queue.
*
* @param bool $auto_download_worker
* Whether the profile indicates automatic adding downloads to a worker queue.
*
* @return $this
*/
public function setAutomaticDownloadWorker($auto_download_worker);
/**
* 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 request of translations for
* an specific target language.
*
* @param string $langcode
* The language code.
*
* @return bool
* Whether the profile indicates automatic request or not.
*/
public function hasAutomaticRequestForTarget($langcode);
/**
* Sets whether this profile indicates automatic request of translations for
* an specific target language.
*
* @param string $langcode
* The language code.
* @param bool $value
* TRUE if translation should be automatically requested, FALSE if not.
*
* @return $this
*/
public function setAutomaticRequestForTarget($langcode, $value);
/**
* 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);
/**
* Sets whether this profile indicates automatic download of translations for
* an specific target language.
*
* @param string $langcode
* The language code.
* @param bool $value
* TRUE if translation should be automatically downloaded, FALSE if not.
*
* @return $this
*/
public function setAutomaticDownloadForTarget($langcode, $value);
/**
* 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);
/**
* Sets the workflow to be used for a given language.
*
* @param string $langcode
* The language code.
* @param string $value
* The workflow identifier, used to request translation. If 'default', the
* default site workflow should be used.
*
* @return $this
*/
public function setWorkflowForTarget($langcode, $value);
/**
* 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);
/**
* Checks if the profile overrides settings for Intelligence metadata.
*
* @return bool
* TRUE if there are Lingotek Intelligence customizations, FALSE if not.
*/
public function hasIntelligenceMetadataOverrides();
/**
* Set if the profile overrides settings for Intelligence metadata.
*
* @param bool $value
* TRUE if there are Lingotek Intelligence customizations, FALSE if not.
*
* @return $this
*/
public function setIntelligenceMetadataOverrides($value);
/**
* Gets the vault to be used for a given language.
*
* @param string $langcode
* The language code.
*
* @return string
* The vault identifier, used to request translations. If 'default, the
* default site vault should be used.
*/
public function getVaultForTarget($langcode);
/**
* Set the vault to be used for a given language.
*
* @param string $langcode
* The language code.
*
* @param string $value
* The vault identifier, used to request translations. If'default', the
* default site vault should be used.
*
* @return $this
*/
public function setVaultForTarget($langcode, $value);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
LingotekFilterProviderInterface:: |
public | function | Gets the FPRM filter of the profile. | 2 |
LingotekFilterProviderInterface:: |
public | function | Gets the FPRM subfilter of the profile. | 2 |
LingotekFilterProviderInterface:: |
public | function | Sets the FPRM filter of the profile. | 2 |
LingotekFilterProviderInterface:: |
public | function | Sets the FPRM subfilter of the profile. | 2 |
LingotekProfileInterface:: |
public | function | Returns value of append content type to title option. | 1 |
LingotekProfileInterface:: |
public | function | Gets the TM project of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Gets the TM vault of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Gets the vault to be used for a given language. | 1 |
LingotekProfileInterface:: |
public | function | Gets the weight of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Gets the workflow of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Gets the workflow to be used for a given language. | 1 |
LingotekProfileInterface:: |
public | function | Returns whether this profile indicates automatic download of translations. | 1 |
LingotekProfileInterface:: |
public | function | Returns whether this profile indicates automatic download of translations for an specific target language. | 1 |
LingotekProfileInterface:: |
public | function | Returns whether this profile indicates automatically adding downloads to a worker queue. | 1 |
LingotekProfileInterface:: |
public | function | Returns whether this profile indicates automatic request of translations. | 1 |
LingotekProfileInterface:: |
public | function | Returns whether this profile indicates automatic request of translations for an specific target language. | 1 |
LingotekProfileInterface:: |
public | function | Returns whether this profile indicates automatic upload of sources. | 1 |
LingotekProfileInterface:: |
public | function | Checks if the profile has custom settings for a given target language. | 1 |
LingotekProfileInterface:: |
public | function | Checks if the profile overrides settings for Intelligence metadata. | 1 |
LingotekProfileInterface:: |
public | function | Returns whether this profile is locked. | 1 |
LingotekProfileInterface:: |
public | function | Sets the value of append content type to title option. | 1 |
LingotekProfileInterface:: |
public | function | Sets whether this profile indicates automatic download of translations. | 1 |
LingotekProfileInterface:: |
public | function | Sets whether this profile indicates automatic download of translations for an specific target language. | 1 |
LingotekProfileInterface:: |
public | function | Sets whether this profile indicates automatically adding downloads to a worker queue. | 1 |
LingotekProfileInterface:: |
public | function | Sets whether this profile indicates automatic request of translations. | 1 |
LingotekProfileInterface:: |
public | function | Sets whether this profile indicates automatic request of translations for an specific target language. | 1 |
LingotekProfileInterface:: |
public | function | Sets whether this profile indicates automatic upload of sources. | 1 |
LingotekProfileInterface:: |
public | function | Set if the profile overrides settings for Intelligence metadata. | 1 |
LingotekProfileInterface:: |
public | function | Sets the TM vault of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Sets the TM vault of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Set the vault to be used for a given language. | 1 |
LingotekProfileInterface:: |
public | function | Sets the weight of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Sets the workflow of the profile. | 1 |
LingotekProfileInterface:: |
public | function | Sets the workflow to be used for a given language. | 1 |
LingotekProfileInterface:: |
constant | The profile is being used in config. | ||
LingotekProfileInterface:: |
constant | The profile is being used in config. | ||
LingotekProfileInterface:: |
constant | The profile is being used in content. | ||
LingotekProfileInterface:: |
constant | The profile is not being used. | ||
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 5 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 5 |