interface LingotekApiInterface in Lingotek Translation 8.2

Hierarchy

• interface \Drupal\lingotek\Remote\LingotekApiInterface

3 files declare their use of LingotekApiInterface

Lingotek.php in src/Lingotek.php

LingotekFake.php in tests/modules/lingotek_test/src/LingotekFake.php

LingotekUnitTest.php in tests/src/Unit/LingotekUnitTest.php

File

src/Remote/LingotekApiInterface.php, line 7

Namespace

Drupal\lingotek\Remote

interface LingotekApiInterface {
  public static function create(ContainerInterface $container);
  public function getAccountInfo();

  /**
   * Get the available locales on Lingotek.
   *
   * @return array|bool
   *   Array of locales (as in de-DE, es-ES). FALSE if there is an error.
   */
  public function getLocales();
  public function addDocument($args);

  /**
   * @param $id
   * @param $args
   * @return \GuzzleHttp\Psr7\Response
   */
  public function patchDocument($id, $args);

  /**
   * Delete a document on Lingotek.
   *
   * @param string $id
   *   The document id.
   *
   * @return mixed
   *
   * @deprecated in 8.x-2.14, will be removed in 8.x-2.16. Use ::cancelDocument instead.
   */
  public function deleteDocument($id);

  /**
   * Cancels a document on Lingotek.
   *
   * @param string $document_id
   *   The document id.
   *
   * @return mixed
   */
  public function cancelDocument($document_id);

  /**
   * Cancels the document target with this document id and locale from the Lingotek service.
   *
   * @param string $document_id
   *   The document id.
   * @param string $locale
   *   The locale target we want to cancel the translation.
   *
   * @return mixed
   */
  public function cancelDocumentTarget($document_id, $locale);
  public function getDocument($id);
  public function documentExists($id);
  public function getDocumentTranslationStatuses($id);
  public function getDocumentTranslationStatus($id, $locale);
  public function getDocumentInfo($id);
  public function getDocumentStatus($id);
  public function addTranslation($id, $locale, $workflow_id = NULL);
  public function getTranslation($id, $locale, $useSource);
  public function deleteTranslation($id, $locale);
  public function getCommunities();
  public function getProjects($community_id);
  public function getVaults($community_id);
  public function getWorkflows($community_id);

  /**
   * Get the available filters on Lingotek.
   *
   * @return
   *   Array of filters as in (id, label). FALSE if there is an error.
   */
  public function getFilters();

}

Members

Name	Modifiers	Type	Description	Overrides
LingotekApiInterface::addDocument	public	function		1
LingotekApiInterface::addTranslation	public	function		1
LingotekApiInterface::cancelDocument	public	function	Cancels a document on Lingotek.	1
LingotekApiInterface::cancelDocumentTarget	public	function	Cancels the document target with this document id and locale from the Lingotek service.	1
LingotekApiInterface::create	public static	function		1
LingotekApiInterface::deleteDocument Deprecated	public	function	Delete a document on Lingotek.	1
LingotekApiInterface::deleteTranslation	public	function		1
LingotekApiInterface::documentExists	public	function		1
LingotekApiInterface::getAccountInfo	public	function		1
LingotekApiInterface::getCommunities	public	function		1
LingotekApiInterface::getDocument	public	function		1
LingotekApiInterface::getDocumentInfo	public	function		1
LingotekApiInterface::getDocumentStatus	public	function		1
LingotekApiInterface::getDocumentTranslationStatus	public	function		1
LingotekApiInterface::getDocumentTranslationStatuses	public	function		1
LingotekApiInterface::getFilters	public	function	Get the available filters on Lingotek.	1
LingotekApiInterface::getLocales	public	function	Get the available locales on Lingotek.	1
LingotekApiInterface::getProjects	public	function		1
LingotekApiInterface::getTranslation	public	function		1
LingotekApiInterface::getVaults	public	function		1
LingotekApiInterface::getWorkflows	public	function		1
LingotekApiInterface::patchDocument	public	function		1