class TMGMTLocalTask in Translation Management Tool 7

Entity class for the local task entity.

Hierarchy

class \Entity implements EntityInterface
- class \TMGMTLocalTask

Expanded class hierarchy of TMGMTLocalTask

File

translators/tmgmt_local/entity/tmgmt_local.entity.task.inc, line 13

View source

class TMGMTLocalTask extends Entity {

  /**
   * Translation local task identifier.
   *
   * @var int
   */
  public $tltid;

  /**
   * The user id of the creator of the task.
   *
   * @var int
   */
  public $uid;

  /**
   * The time when the task was created as a timestamp.
   *
   * @var int
   */
  public $created = REQUEST_TIME;

  /**
   * The time when the task was changed as a timestamp.
   *
   * @var int
   */
  public $changed;

  /**
   * A title of this task.
   *
   * @var string
   */
  public $title;

  /**
   * The user id of the assigned translator.
   *
   * @var int
   */
  public $tuid;

  /**
   * Translation job.
   *
   * @var int
   */
  public $tjid;

  /**
   * Current status of the task.
   *
   * @var int
   */
  public $status = TMGMT_LOCAL_TASK_STATUS_UNASSIGNED;

  /**
   * Counter for how many times task was returned to translator.
   *
   * @var int
   */
  public $loop_count;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $values = array(), $entity_type = 'tmgmt_local_task') {
    parent::__construct($values, $entity_type);
  }

  /*
   * {@inheritdoc}
   */
  public function defaultUri() {
    return array(
      'path' => 'translate/' . $this->tltid,
    );
  }

  /**
   * {@inheritdoc}
   */
  protected function defaultLabel() {
    if (empty($this->tuid)) {
      if (empty($this->title)) {
        return t('Task for @job', array(
          '@job' => $this
            ->getJob()
            ->label(),
        ));
      }
      else {
        return $this->title;
      }
    }
    else {
      if (empty($this->title)) {
        return t('Task for @job assigned to @translator', array(
          '@job' => $this
            ->getJob()
            ->label(),
          '@translator' => entity_label('user', user_load($this->tuid)),
        ));
      }
      else {
        return t('@title assigned to @translator', array(
          '@title' => $this->title,
          '@translator' => entity_label('user', user_load($this->tuid)),
        ));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildContent($view_mode = 'full', $langcode = NULL) {
    $content = entity_ui_get_form('tmgmt_local_task', $this);
    return entity_get_controller($this->entityType)
      ->buildContent($this, $view_mode, $langcode, $content);
  }

  /**
   * Return the corresponding translation job.
   *
   * @return TMGMTJob
   */
  public function getJob() {
    return tmgmt_job_load($this->tjid);
  }

  /**
   * Assign translation task to passed user.
   *
   * @param object $user
   *   User object.
   */
  public function assign($user) {
    $this
      ->incrementLoopCount(TMGMT_LOCAL_TASK_STATUS_PENDING, $user->uid);
    $this->tuid = $user->uid;
    $this->status = TMGMT_LOCAL_TASK_STATUS_PENDING;
  }

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

    // We also need to increment loop count when unassigning.
    $this
      ->incrementLoopCount(TMGMT_LOCAL_TASK_STATUS_UNASSIGNED, 0);
    $this->tuid = 0;
    $this->status = TMGMT_LOCAL_TASK_STATUS_UNASSIGNED;
  }

  /**
   * Returns all job items attached to this task.
   *
   * @return array
   *   An array of translation job items.
   */
  public function getItems($conditions = array()) {
    $query = new EntityFieldQuery();
    $query
      ->entityCondition('entity_type', 'tmgmt_local_task_item');
    $query
      ->propertyCondition('tltid', $this->tltid);
    foreach ($conditions as $key => $condition) {
      if (is_array($condition)) {
        $operator = isset($condition['operator']) ? $condition['operator'] : '=';
        $query
          ->propertyCondition($key, $condition['value'], $operator);
      }
      else {
        $query
          ->propertyCondition($key, $condition);
      }
    }
    $results = $query
      ->execute();
    if (!empty($results['tmgmt_local_task_item'])) {
      return entity_load('tmgmt_local_task_item', array_keys($results['tmgmt_local_task_item']));
    }
    return array();
  }

  /**
   * Create a task item for this task and the given job item.
   *
   * @param TMGMTJobItem $job_item
   *   The job item.
   */
  public function addTaskItem(TMGMTJobItem $job_item) {

    // Save the task to get an id.
    if (empty($this->tltid)) {
      $this
        ->save();
    }
    $local_task = entity_create('tmgmt_local_task_item', array(
      'tltid' => $this
        ->identifier(),
      'tjiid' => $job_item
        ->identifier(),
    ));
    $local_task
      ->save();
    return $local_task;
  }

  /**
   * 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() {
    return $this->status;
  }

  /**
   * Updates the status of the task.
   *
   * @param $status
   *   The new status of the task. Has to be one of the task status constants.
   * @param $message
   *   (Optional) The log message to be saved along with the status change.
   * @param $variables
   *   (Optional) An array of variables to replace in the message on display.
   *
   * @return int
   *   The updated status of the task if it could be set.
   *
   * @see TMGMTJob::addMessage()
   */
  public function setStatus($status) {

    // Return TRUE if the status could be set. Return FALSE otherwise.
    if (array_key_exists($status, tmgmt_local_task_statuses())) {
      $this
        ->incrementLoopCount($status, $this->tuid);
      $this->status = $status;
      $this
        ->save();
    }
    return $this->status;
  }

  /**
   * Checks whether the passed value matches the current status.
   *
   * @param $status
   *   The value to check the current status against.
   *
   * @return boolean
   *   TRUE if the passed status matches the current status, FALSE otherwise.
   */
  public function isStatus($status) {
    return $this
      ->getStatus() == $status;
  }

  /**
   * Checks whether the user described by $account is the author of this task.
   *
   * @param $account
   *   (Optional) A user object. Defaults to the currently logged in user.
   */
  public function isAuthor($account = NULL) {
    $account = isset($account) ? $account : $GLOBALS['user'];
    return $this->uid == $account->uid;
  }

  /**
   * Returns whether the status of this task is 'unassigned'.
   *
   * @return boolean
   *   TRUE if the status is 'unassigned', FALSE otherwise.
   */
  public function isUnassigned() {
    return $this
      ->isStatus(TMGMT_LOCAL_TASK_STATUS_UNASSIGNED);
  }

  /**
   * Returns whether the status of this task is 'pending'.
   *
   * @return boolean
   *   TRUE if the status is 'pending', FALSE otherwise.
   */
  public function isPending() {
    return $this
      ->isStatus(TMGMT_LOCAL_TASK_STATUS_PENDING);
  }

  /**
   * Returns whether the status of this task is 'completed'.
   *
   * @return boolean
   *   TRUE if the status is 'completed', FALSE otherwise.
   */
  public function isCompleted() {
    return $this
      ->isStatus(TMGMT_LOCAL_TASK_STATUS_COMPLETED);
  }

  /**
   * Returns whether the status of this task is 'rejected'.
   *
   * @return boolean
   *   TRUE if the status is 'rejected', FALSE otherwise.
   */
  public function isRejected() {
    return $this
      ->isStatus(TMGMT_LOCAL_TASK_STATUS_REJECTED);
  }

  /**
   * Returns whether the status of this task is 'closed'.
   *
   * @return boolean
   *   TRUE if the status is 'closed', FALSE otherwise.
   */
  public function isClosed() {
    return $this
      ->isStatus(TMGMT_LOCAL_TASK_STATUS_CLOSED);
  }

  /**
   * Count of all translated data items.
   *
   * @return
   *   Translated count
   */
  public function getCountTranslated() {
    return tmgmt_local_task_statistic($this, 'count_translated');
  }

  /**
   * Count of all untranslated data items.
   *
   * @return
   *   Translated count
   */
  public function getCountUntranslated() {
    return tmgmt_local_task_statistic($this, 'count_untranslated');
  }

  /**
   * Count of all completed data items.
   *
   * @return
   *   Translated count
   */
  public function getCountCompleted() {
    return tmgmt_local_task_statistic($this, 'count_completed');
  }

  /**
   * Sums up all word counts of this task job items.
   *
   * @return
   *   The sum of all accepted counts
   */
  public function getWordCount() {
    return tmgmt_local_task_statistic($this, 'word_count');
  }

  /**
   * Returns loop count of a task.
   *
   * @return int
   *   Task loop count.
   */
  public function getLoopCount() {
    return $this->loop_count;
  }

  /**
   * Increment loop_count property depending on current status, new status and
   * new translator.
   *
   * @param int $newStatus
   *   New status of task.
   * @param int $new_tuid
   *   New translator uid.
   */
  public function incrementLoopCount($newStatus, $new_tuid) {
    if ($this->status == TMGMT_LOCAL_TASK_STATUS_PENDING && $newStatus == TMGMT_LOCAL_TASK_STATUS_PENDING && $this->tuid != $new_tuid) {
      ++$this->loop_count;
    }
    else {
      if ($this->status != TMGMT_LOCAL_TASK_STATUS_UNASSIGNED && $newStatus == TMGMT_LOCAL_TASK_STATUS_UNASSIGNED) {
        ++$this->loop_count;
      }
      else {
        if ($this->status != TMGMT_LOCAL_TASK_STATUS_UNASSIGNED && $this->status != TMGMT_LOCAL_TASK_STATUS_PENDING && $newStatus == TMGMT_LOCAL_TASK_STATUS_PENDING) {
          ++$this->loop_count;
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::delete	public	function	Permanently deletes the entity. Overrides EntityInterface::delete
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::save	public	function	Permanently saves the entity. Overrides EntityInterface::save
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
Entity::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
TMGMTLocalTask::$changed	public	property	The time when the task was changed as a timestamp.
TMGMTLocalTask::$created	public	property	The time when the task was created as a timestamp.
TMGMTLocalTask::$loop_count	public	property	Counter for how many times task was returned to translator.
TMGMTLocalTask::$status	public	property	Current status of the task.
TMGMTLocalTask::$title	public	property	A title of this task.
TMGMTLocalTask::$tjid	public	property	Translation job.
TMGMTLocalTask::$tltid	public	property	Translation local task identifier.
TMGMTLocalTask::$tuid	public	property	The user id of the assigned translator.
TMGMTLocalTask::$uid	public	property	The user id of the creator of the task.
TMGMTLocalTask::addTaskItem	public	function	Create a task item for this task and the given job item.
TMGMTLocalTask::assign	public	function	Assign translation task to passed user.
TMGMTLocalTask::buildContent	public	function	Builds a structured array representing the entity's content. Overrides Entity::buildContent
TMGMTLocalTask::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used. Overrides Entity::defaultLabel
TMGMTLocalTask::defaultUri	public	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info(). Overrides Entity::defaultUri
TMGMTLocalTask::getCountCompleted	public	function	Count of all completed data items.
TMGMTLocalTask::getCountTranslated	public	function	Count of all translated data items.
TMGMTLocalTask::getCountUntranslated	public	function	Count of all untranslated data items.
TMGMTLocalTask::getItems	public	function	Returns all job items attached to this task.
TMGMTLocalTask::getJob	public	function	Return the corresponding translation job.
TMGMTLocalTask::getLoopCount	public	function	Returns loop count of a task.
TMGMTLocalTask::getStatus	public	function	Returns the status of the task. Can be one of the task status constants.
TMGMTLocalTask::getWordCount	public	function	Sums up all word counts of this task job items.
TMGMTLocalTask::incrementLoopCount	public	function	Increment loop_count property depending on current status, new status and new translator.
TMGMTLocalTask::isAuthor	public	function	Checks whether the user described by $account is the author of this task.
TMGMTLocalTask::isClosed	public	function	Returns whether the status of this task is 'closed'.
TMGMTLocalTask::isCompleted	public	function	Returns whether the status of this task is 'completed'.
TMGMTLocalTask::isPending	public	function	Returns whether the status of this task is 'pending'.
TMGMTLocalTask::isRejected	public	function	Returns whether the status of this task is 'rejected'.
TMGMTLocalTask::isStatus	public	function	Checks whether the passed value matches the current status.
TMGMTLocalTask::isUnassigned	public	function	Returns whether the status of this task is 'unassigned'.
TMGMTLocalTask::setStatus	public	function	Updates the status of the task.
TMGMTLocalTask::unassign	public	function	Unassign translation task.
TMGMTLocalTask::__construct	public	function	Overrides Entity::__construct

You are here

class TMGMTLocalTask in Translation Management Tool 7

Hierarchy

Related topics

File

Members

API Navigation