class TMGMTJobItemUICart in Translation Management Tool 7

Represents a job item cart.

Hierarchy

• class \TMGMTJobItemUICart

Related topics

Translation cart

The translation cart can collect multiple source items of different types which are meant for translation into a list. The list then provides functionality to request translation of the items into multiple target languages.

File

ui/includes/tmgmt_ui.cart.inc, line 13

Contains TMGMTJobItemUICart.

class TMGMTJobItemUICart {

  /**
   * Singleton instance of cart.
   */
  protected static $instance;

  /**
   * Array key to store the contents of $this->cart into the $_SESSION variable.
   *
   * @var string
   */
  protected $session_key = 'tmgmt_cart';

  /**
   * An array to hold and manipulate the contents of the job item cart.
   *
   * @var array
   */
  protected $cart;

  /**
   * Set up a new TMGMTJobItemUICart instance.
   *
   * Will load the cart from the session or initialize a new one if nothing has
   * been stored yet.
   */
  protected function __construct() {
    if (!isset($_SESSION[$this->session_key])) {
      $_SESSION[$this->session_key] = array();
    }
    $this->cart =& $_SESSION[$this->session_key];
  }

  /**
   * Returns the singleton cart.
   *
   * @return TMGMTJobItemUICart
   *   An instance of the cart.
   */
  public static function getInstance() {
    if (!isset(self::$instance)) {
      self::$instance = new self();
    }
    return self::$instance;
  }

  /**
   * Adds existing job items into the cart.
   *
   * @param TMGMTJobItem[] $items
   *   Job items to be added.
   */
  public function addExistingJobItems(array $items) {
    foreach ($items as $item) {
      if (!$this
        ->isSourceItemAdded($item->plugin, $item->item_type, $item->item_id)) {
        $this->cart[] = $item->tjiid;
      }
    }
  }

  /**
   * Creates a job item and adds it into the cart.
   *
   * @param string $plugin
   *   The source plugin.
   * @param string $item_type
   *   The source item type.
   * @param $item_id
   *   The source item id.
   *
   * @return TMGMTJobItem|null
   *   Added job item. If the item exists NULL is returned.
   */
  public function addJobItem($plugin, $item_type, $item_id) {
    if ($this
      ->isSourceItemAdded($plugin, $item_type, $item_id)) {
      return NULL;
    }
    $job_item = tmgmt_job_item_create($plugin, $item_type, $item_id);
    $job_item
      ->save();
    $this->cart[] = $job_item->tjiid;
    return $job_item;
  }

  /**
   * Checks if the source item has been added into the cart.
   *
   * @param string $plugin
   *   The source plugin.
   * @param string $item_type
   *   The source type.
   * @param int $source_id
   *   The source id.
   *
   * @return bool
   *   If the source item is in the cart.
   */
  public function isSourceItemAdded($plugin, $item_type, $source_id) {
    foreach ($this
      ->getJobItemsFromCart() as $job_item) {
      if ($job_item->item_id == $source_id && $job_item->item_type == $item_type && $job_item->plugin == $plugin) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Remove job items from the cart.
   *
   * @param array $job_item_ids
   *   Job items to be removed.
   */
  public function removeJobItems(array $job_item_ids) {
    $this->cart = array_diff($this->cart, $job_item_ids);
  }

  /**
   * Gets job items in the cart.
   *
   * @return TMGMTJobItem[] $items
   *   Job items in the cart.
   */
  public function getJobItemsFromCart() {
    return entity_load('tmgmt_job_item', $this->cart);
  }

  /**
   * Gets count of items in the cart.
   *
   * @return int
   *   Number of items in the cart.
   */
  public function count() {
    return count($this->cart);
  }

  /**
   * Remove all contents from the cart.
   */
  public function emptyCart() {
    $this->cart = array();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TMGMTJobItemUICart::$cart	protected	property	An array to hold and manipulate the contents of the job item cart.
TMGMTJobItemUICart::$instance	protected static	property	Singleton instance of cart.
TMGMTJobItemUICart::$session_key	protected	property	Array key to store the contents of $this->cart into the $_SESSION variable.
TMGMTJobItemUICart::addExistingJobItems	public	function	Adds existing job items into the cart.
TMGMTJobItemUICart::addJobItem	public	function	Creates a job item and adds it into the cart.
TMGMTJobItemUICart::count	public	function	Gets count of items in the cart.
TMGMTJobItemUICart::emptyCart	public	function	Remove all contents from the cart.
TMGMTJobItemUICart::getInstance	public static	function	Returns the singleton cart.
TMGMTJobItemUICart::getJobItemsFromCart	public	function	Gets job items in the cart.
TMGMTJobItemUICart::isSourceItemAdded	public	function	Checks if the source item has been added into the cart.
TMGMTJobItemUICart::removeJobItems	public	function	Remove job items from the cart.
TMGMTJobItemUICart::__construct	protected	function	Set up a new TMGMTJobItemUICart instance.