class TMGMTRemote in Translation Management Tool 7

Entity class for the tmgmt_remote entity.

Hierarchy

• class \Entity implements EntityInterface
  • class \TMGMTRemote

Related topics

Translation Jobs

A single task to translate something into a given language using a translator.

1 string reference to 'TMGMTRemote'

tmgmt_entity_info in ./tmgmt.module

Implements hook_entity_info().

File

entity/tmgmt.entity.remote.inc, line 13

class TMGMTRemote extends Entity {

  /**
   * Primary key.
   *
   * @var int
   */
  public $trid;

  /**
   * TMGMTJob identifier.
   *
   * @var int
   */
  public $tjid;

  /**
   * TMGMTJobItem identifier.
   *
   * @var int
   */
  public $tjiid;

  /**
   * Translation job data item key.
   *
   * @var string
   */
  public $data_item_key;

  /**
   * Custom remote identifier 1.
   *
   * @var string
   */
  public $remote_identifier_1;

  /**
   * Custom remote identifier 2.
   *
   * @var string
   */
  public $remote_identifier_2;

  /**
   * Custom remote identifier 3.
   *
   * @var string
   */
  public $remote_identifier_3;

  /**
   * Remote job url.
   *
   * @var string
   */
  public $remote_url;

  /**
   * Word count provided by the remote service.
   *
   * @var int
   */
  public $word_count;

  /**
   * Amount charged for the remote translation job.
   *
   * @var int
   */
  public $amount;

  /**
   * Amount charged currency.
   *
   * @var string
   */
  public $currency;

  /**
   * Custom remote data.
   *
   * @var array
   */
  public $remote_data;

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

  /**
   * Gets translation job item.
   *
   * @return TMGMTJobItem
   */
  function getJobItem() {
    if (!empty($this->tjiid)) {
      return tmgmt_job_item_load($this->tjiid);
    }
    return NULL;
  }

  /**
   * Adds data to the remote_data storage.
   *
   * @param string $key
   *   Key through which the data will be accessible.
   * @param $value
   *   Value to store.
   */
  function addRemoteData($key, $value) {
    $this->remote_data[$key] = $value;
  }

  /**
   * Gets data from remote_data storage.
   *
   * @param string $key
   *   Access key for the data.
   *
   * @return mixed
   *   Stored data.
   */
  function getRemoteData($key) {
    return $this->remote_data[$key];
  }

  /**
   * Removes data from remote_data storage.
   *
   * @param string $key
   *   Access key for the data that are to be removed.
   */
  function removeRemoteData($key) {
    unset($this->remote_data[$key]);
  }

}

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::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityInterface::buildContent	1
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used.	1
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
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::__construct	public	function		1
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
TMGMTRemote::$amount	public	property	Amount charged for the remote translation job.
TMGMTRemote::$currency	public	property	Amount charged currency.
TMGMTRemote::$data_item_key	public	property	Translation job data item key.
TMGMTRemote::$remote_data	public	property	Custom remote data.
TMGMTRemote::$remote_identifier_1	public	property	Custom remote identifier 1.
TMGMTRemote::$remote_identifier_2	public	property	Custom remote identifier 2.
TMGMTRemote::$remote_identifier_3	public	property	Custom remote identifier 3.
TMGMTRemote::$remote_url	public	property	Remote job url.
TMGMTRemote::$tjid	public	property	TMGMTJob identifier.
TMGMTRemote::$tjiid	public	property	TMGMTJobItem identifier.
TMGMTRemote::$trid	public	property	Primary key.
TMGMTRemote::$word_count	public	property	Word count provided by the remote service.
TMGMTRemote::addRemoteData		function	Adds data to the remote_data storage.
TMGMTRemote::getJob		function	Gets translation job.
TMGMTRemote::getJobItem		function	Gets translation job item.
TMGMTRemote::getRemoteData		function	Gets data from remote_data storage.
TMGMTRemote::removeRemoteData		function	Removes data from remote_data storage.