You are here

Home » API reference » Translation Management Tool 8 » LocalTaskInterface.php

interface LocalTaskInterface in Translation Management Tool 8

Interface for tmgmt_local_task entity.

Hierarchy

Expanded class hierarchy of LocalTaskInterface

All classes that implement LocalTaskInterface

Related topics

TMGMT Local Task
Various local task API functions.
10 files declare their use of LocalTaskInterface
LocalTask.php in translators/tmgmt_local/src/Entity/LocalTask.php
LocalTaskController.php in translators/tmgmt_local/src/Controller/LocalTaskController.php
LocalTaskForm.php in translators/tmgmt_local/src/Form/LocalTaskForm.php
LocalTaskItemForm.php in translators/tmgmt_local/src/Form/LocalTaskItemForm.php
LocalTaskListBuilder.php in translators/tmgmt_local/src/Entity/ListBuilder/LocalTaskListBuilder.php

... See full list

File

translators/tmgmt_local/src/LocalTaskInterface.php, line 16

Namespace

Drupal\tmgmt_local
View source 
interface LocalTaskInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {

  /**
   * Translation task is not assigned to translator.
   */
  const STATUS_UNASSIGNED = 0;

  /**
   * Translation task is pending.
   */
  const STATUS_PENDING = 1;

  /**
   * Translation task is completed (all job items are translated).
   */
  const STATUS_COMPLETED = 2;

  /**
   * Translation task is rejected (at least some job items are rejected).
   */
  const STATUS_REJECTED = 3;

  /**
   * Translation task is closed.
   */
  const STATUS_CLOSED = 4;

  /**
   * Return the user assigned to this task.
   *
   * @return \Drupal\Core\Session\AccountInterface|null
   *   The user assigned to this task or NULL if there is no user assigned.
   */
  public function getAssignee();

  /**
   * Return the corresponding translation job.
   *
   * @return \Drupal\tmgmt\JobInterface
   *   The job.
   */
  public function getJob();

  /**
   * Assign translation task to passed user.
   *
   * @param \Drupal\Core\Session\AccountInterface $user
   *   User object.
   */
  public function assign(AccountInterface $user);

  /**
   * Unassign translation task.
   */
  public function unassign();

  /**
   * Returns all local task items attached to this task.
   *
   * @param array $conditions
   *   Additional conditions.
   *
   * @return \Drupal\tmgmt_local\Entity\LocalTaskItem[]
   *   An array of local task items.
   */
  public function getItems($conditions = array());

  /**
   * Create a task item for this task and the given job item.
   *
   * @param \Drupal\tmgmt\JobItemInterface $job_item
   *   The job item.
   */
  public function addTaskItem(JobItemInterface $job_item);

  /**
   * Returns the status of the task. Can be one of the task status constants.
   *
   * @return int
   *   The status of the task or NULL if it hasn't been set yet.
   */
  public function getStatus();

  /**
   * Updates the status of the task.
   *
   * @param int $status
   *   The new status of the task. Has to be one of the task status constants.
   * @param string $message
   *   (Optional) The log message to be saved along with the status change.
   * @param array $variables
   *   (Optional) An array of variables to replace in the message on display.
   * @param string $type
   *   (optional) The message type.
   *
   * @return int
   *   The updated status of the task if it could be set.
   *
   * @see Job::addMessage()
   */
  public function setStatus($status, $message = NULL, $variables = array(), $type = 'debug');

  /**
   * Checks whether the passed value matches the current status.
   *
   * @param int $status
   *   The value to check the current status against.
   *
   * @return bool
   *   TRUE if the passed status matches the current status, FALSE otherwise.
   */
  public function isStatus($status);

  /**
   * Checks whether the user described by $account is the author of this task.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   (Optional) A user object. Defaults to the currently logged in user.
   */
  public function isAuthor(AccountInterface $account = NULL);

  /**
   * Returns whether the status of this task is 'unassigned'.
   *
   * @return bool
   *   TRUE if the status is 'unassigned', FALSE otherwise.
   */
  public function isUnassigned();

  /**
   * Returns whether the status of this task is 'pending'.
   *
   * @return bool
   *   TRUE if the status is 'pending', FALSE otherwise.
   */
  public function isPending();

  /**
   * Returns whether the status of this task is 'completed'.
   *
   * @return bool
   *   TRUE if the status is 'completed', FALSE otherwise.
   */
  public function isCompleted();

  /**
   * Returns whether the status of this task is 'rejected'.
   *
   * @return bool
   *   TRUE if the status is 'rejected', FALSE otherwise.
   */
  public function isRejected();

  /**
   * Returns whether the status of this task is 'closed'.
   *
   * @return bool
   *   TRUE if the status is 'closed', FALSE otherwise.
   */
  public function isClosed();

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

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

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

  /**
   * Sums up all word counts of this task job items.
   *
   * @return int
   *   The sum of all accepted counts
   */
  public function getWordCount();

  /**
   * Returns loop count of a task.
   *
   * @return int
   *   Task loop count.
   */
  public function getLoopCount();

  /**
   * Increment loop_count property.
   *
   * Does it depending on current status, new status and new assignee.
   *
   * @param int $new_status
   *   New status of task.
   * @param int $new_tuid
   *   New translator uid.
   */
  public function incrementLoopCount($new_status, $new_tuid);

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

}

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
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
EntityOwnerInterface::getOwner public function Returns the entity owner's user entity. 1
EntityOwnerInterface::getOwnerId public function Returns the entity owner's user ID. 1
EntityOwnerInterface::setOwner public function Sets the entity owner's user entity. 1
EntityOwnerInterface::setOwnerId public function Sets the entity owner's user ID. 1
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
LocalTaskInterface::addTaskItem public function Create a task item for this task and the given job item. 1
LocalTaskInterface::assign public function Assign translation task to passed user. 1
LocalTaskInterface::getAssignee public function Return the user assigned to this task. 1
LocalTaskInterface::getCountCompleted public function Count of all completed data items. 1
LocalTaskInterface::getCountTranslated public function Count of all translated data items. 1
LocalTaskInterface::getCountUntranslated public function Count of all untranslated data items. 1
LocalTaskInterface::getItems public function Returns all local task items attached to this task. 1
LocalTaskInterface::getJob public function Return the corresponding translation job. 1
LocalTaskInterface::getLoopCount public function Returns loop count of a task. 1
LocalTaskInterface::getStatus public function Returns the status of the task. Can be one of the task status constants. 1
LocalTaskInterface::getStatuses public static function Returns a labeled list of all available statuses. 1
LocalTaskInterface::getWordCount public function Sums up all word counts of this task job items. 1
LocalTaskInterface::incrementLoopCount public function Increment loop_count property. 1
LocalTaskInterface::isAuthor public function Checks whether the user described by $account is the author of this task. 1
LocalTaskInterface::isClosed public function Returns whether the status of this task is 'closed'. 1
LocalTaskInterface::isCompleted public function Returns whether the status of this task is 'completed'. 1
LocalTaskInterface::isPending public function Returns whether the status of this task is 'pending'. 1
LocalTaskInterface::isRejected public function Returns whether the status of this task is 'rejected'. 1
LocalTaskInterface::isStatus public function Checks whether the passed value matches the current status. 1
LocalTaskInterface::isUnassigned public function Returns whether the status of this task is 'unassigned'. 1
LocalTaskInterface::setStatus public function Updates the status of the task. 1
LocalTaskInterface::STATUS_CLOSED constant Translation task is closed.
LocalTaskInterface::STATUS_COMPLETED constant Translation task is completed (all job items are translated).
LocalTaskInterface::STATUS_PENDING constant Translation task is pending.
LocalTaskInterface::STATUS_REJECTED constant Translation task is rejected (at least some job items are rejected).
LocalTaskInterface::STATUS_UNASSIGNED constant Translation task is not assigned to translator.
LocalTaskInterface::unassign public function Unassign translation task. 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