interface LocalTaskItemInterface in Translation Management Tool 8

Interface for tmgmt_local_task_item entity.

Hierarchy

interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\Core\Entity\EntityChangedInterface
- interface \Drupal\tmgmt_local\LocalTaskItemInterface

Expanded class hierarchy of LocalTaskItemInterface

All classes that implement LocalTaskItemInterface

5 files declare their use of LocalTaskItemInterface

LocalTaskItem.php in translators/tmgmt_local/src/Entity/LocalTaskItem.php
Progress.php in translators/tmgmt_local/src/Plugin/views/field/Progress.php
TaskItemStatus.php in translators/tmgmt_local/src/Plugin/views/field/TaskItemStatus.php
TMGMTLocalBreadcrumbBuilder.php in translators/tmgmt_local/src/Menu/TMGMTLocalBreadcrumbBuilder.php
tmgmt_local.module in translators/tmgmt_local/tmgmt_local.module: Main module file for the local translation module.

File

translators/tmgmt_local/src/LocalTaskItemInterface.php, line 13

Namespace

Drupal\tmgmt_local

View source

interface LocalTaskItemInterface extends ContentEntityInterface, EntityChangedInterface {

  /**
   * Translation task item is untranslated.
   */
  const STATUS_PENDING = 0;

  /**
   * Translation task item is translated and pending review of the job item.
   */
  const STATUS_COMPLETED = 1;

  /**
   * Translation job item has been rejected and the task needs to be updated.
   */
  const STATUS_REJECTED = 2;

  /**
   * The translation task item has been completed and closed.
   */
  const STATUS_CLOSED = 3;

  /**
   * Returns the translation task.
   *
   * @return \Drupal\tmgmt_local\Entity\LocalTask
   *   The LocalTask.
   */
  public function getTask();

  /**
   * Returns the translation job item.
   *
   * @return \Drupal\tmgmt\JobItemInterface
   *   The JobItem.
   */
  public function getJobItem();

  /**
   * Returns the status of the local task item.
   *
   * Can be one of the local task item status constants.
   *
   * @return int
   *   The status of the local task item.
   */
  public function getStatus();

  /**
   * Returns TRUE if the local task is pending.
   *
   * @return bool
   *   TRUE if the local task item is untranslated.
   */
  public function isPending();

  /**
   * Returns TRUE if the local task is translated (fully translated).
   *
   * @return bool
   *   TRUE if the local task item is translated.
   */
  public function isCompleted();

  /**
   * Returns TRUE if the local task is closed (translated and accepted).
   *
   * @return bool
   *   TRUE if the local task item is translated and accepted.
   */
  public function isClosed();

  /**
   * Sets the task item status to completed.
   */
  public function completed();

  /**
   * Sets the task item status to closed.
   */
  public function closed();

  /**
   * Updates the values for a specific substructure in the data array.
   *
   * The values are either set or updated but never deleted.
   *
   * @param string|array $key
   *   Key pointing to the item the values should be applied.
   *   The key can be either be an array containing the keys of a nested array
   *   hierarchy path or a string with '][' or '|' as delimiter.
   * @param array $values
   *   Nested array of values to set.
   * @param bool $replace
   *   (optional) When TRUE, replaces the structure at the provided key instead
   *   of writing into it.
   */
  public function updateData($key, $values = array(), $replace = FALSE);

  /**
   * Gets translation data.
   *
   * The structure is similar to the form API in the way that it is a possibly
   * nested array with the following properties whose presence indicate that the
   * current element is a text that might need to be translated.
   *
   * - #text: The translated text of the corresponding entry in the job item.
   * - #status: The status of the translation.
   *
   * The key can be an alphanumeric string.
   *
   * @param array $key
   *   If present, only the subarray identified by key is returned.
   * @param string $index
   *   Optional index of an attribute below $key.
   *
   * @return array
   *   A structured data array.
   */
  public function getData($key = array(), $index = NULL);

  /**
   * Gets count of all translated data items.
   *
   * @return int
   *   Translated count
   */
  public function getCountTranslated();

  /**
   * Gets count of all untranslated data items.
   *
   * @return int
   *   Translated count
   */
  public function getCountUntranslated();

  /**
   * Gets count of all completed data items.
   *
   * @return int
   *   Translated count
   */
  public function getCountCompleted();

  /**
   * Recalculates statistical word-data: pending, completed, rejected, closed.
   */
  public function recalculateStatistics();

  /**
   * Gets a labeled list of all available statuses.
   *
   * @return array
   *   A list of all available statuses.
   */
  public static function getStatuses();

}

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
EntityChangedInterface::getChangedTime	public	function	Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations	public	function	Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime	public	function	Sets the timestamp of the last entity change for the current translation.
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::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
FieldableEntityInterface::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type.	2
FieldableEntityInterface::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle.	2
FieldableEntityInterface::get	public	function	Gets a field item list.	1
FieldableEntityInterface::getFieldDefinition	public	function	Gets the definition of a contained field.	1
FieldableEntityInterface::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields.	1
FieldableEntityInterface::getFields	public	function	Gets an array of all field item lists.	1
FieldableEntityInterface::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields.	1
FieldableEntityInterface::hasField	public	function	Determines whether the entity has a field with the given name.	1
FieldableEntityInterface::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity.	1
FieldableEntityInterface::onChange	public	function	Reacts to changes to a field.	1
FieldableEntityInterface::set	public	function	Sets a field value.	1
FieldableEntityInterface::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity.	1
FieldableEntityInterface::toArray	public	function	Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate	public	function	Validates the currently set values.	1
LocalTaskItemInterface::closed	public	function	Sets the task item status to closed.	1
LocalTaskItemInterface::completed	public	function	Sets the task item status to completed.	1
LocalTaskItemInterface::getCountCompleted	public	function	Gets count of all completed data items.	1
LocalTaskItemInterface::getCountTranslated	public	function	Gets count of all translated data items.	1
LocalTaskItemInterface::getCountUntranslated	public	function	Gets count of all untranslated data items.	1
LocalTaskItemInterface::getData	public	function	Gets translation data.	1
LocalTaskItemInterface::getJobItem	public	function	Returns the translation job item.	1
LocalTaskItemInterface::getStatus	public	function	Returns the status of the local task item.	1
LocalTaskItemInterface::getStatuses	public static	function	Gets a labeled list of all available statuses.	1
LocalTaskItemInterface::getTask	public	function	Returns the translation task.	1
LocalTaskItemInterface::isClosed	public	function	Returns TRUE if the local task is closed (translated and accepted).	1
LocalTaskItemInterface::isCompleted	public	function	Returns TRUE if the local task is translated (fully translated).	1
LocalTaskItemInterface::isPending	public	function	Returns TRUE if the local task is pending.	1
LocalTaskItemInterface::recalculateStatistics	public	function	Recalculates statistical word-data: pending, completed, rejected, closed.	1
LocalTaskItemInterface::STATUS_CLOSED		constant	The translation task item has been completed and closed.
LocalTaskItemInterface::STATUS_COMPLETED		constant	Translation task item is translated and pending review of the job item.
LocalTaskItemInterface::STATUS_PENDING		constant	Translation task item is untranslated.
LocalTaskItemInterface::STATUS_REJECTED		constant	Translation job item has been rejected and the task needs to be updated.
LocalTaskItemInterface::updateData	public	function	Updates the values for a specific substructure in the data array.	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
RevisionableInterface::getLoadedRevisionId	public	function	Gets the loaded Revision ID of the entity.	1
RevisionableInterface::getRevisionId	public	function	Gets the revision identifier of the entity.	1
RevisionableInterface::isDefaultRevision	public	function	Checks if this entity is the default revision.	1
RevisionableInterface::isLatestRevision	public	function	Checks if this entity is the latest revision.	1
RevisionableInterface::isNewRevision	public	function	Determines whether a new revision should be created on save.	1
RevisionableInterface::preSaveRevision	public	function	Acts on a revision before it gets saved.	1
RevisionableInterface::setNewRevision	public	function	Enforces an entity to be saved as a new revision.	1
RevisionableInterface::updateLoadedRevisionId	public	function	Updates the loaded Revision ID with the revision ID.	1
RevisionableInterface::wasDefaultRevision	public	function	Checks whether the entity object was a default revision when it was saved.	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
TranslatableInterface::addTranslation	public	function	Adds a new translation to the translatable object.	1
TranslatableInterface::getTranslation	public	function	Gets a translation of the data.	1
TranslatableInterface::getTranslationLanguages	public	function	Returns the languages the data is translated to.	1
TranslatableInterface::getUntranslated	public	function	Returns the translatable object referring to the original language.	1
TranslatableInterface::hasTranslation	public	function	Checks there is a translation for the given language code.	1
TranslatableInterface::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes.	1
TranslatableInterface::isDefaultTranslation	public	function	Checks whether the translation is the default one.	1
TranslatableInterface::isNewTranslation	public	function	Checks whether the translation is new.	1
TranslatableInterface::isTranslatable	public	function	Returns the translation support status.	1
TranslatableInterface::removeTranslation	public	function	Removes the translation identified by the given language code.	1
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly	public	function	Checks if untranslatable fields should affect only the default translation.	1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision	public	function	Checks whether this is the latest revision affecting this translation.	1
TranslatableRevisionableInterface::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision.	1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced	public	function	Checks if the revision translation affected flag value has been enforced.	1
TranslatableRevisionableInterface::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected.	1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced	public	function	Enforces the revision translation affected flag value.	1

You are here

interface LocalTaskItemInterface in Translation Management Tool 8

Hierarchy

File

Namespace

Members

API Navigation