public function LingotekInterface::updateDocument in Lingotek Translation 3.6.x

Same name and namespace in other branches

1. 8 src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
2. 8.2 src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
3. 4.0.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
4. 3.0.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
5. 3.1.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
6. 3.2.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
7. 3.3.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
8. 3.4.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
9. 3.5.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
10. 3.7.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()
11. 3.8.x src/LingotekInterface.php \Drupal\lingotek\LingotekInterface::updateDocument()

Updates a document in the Lingotek service.

Parameters

string $doc_id: The document id to update.

string|array $content: The content of the document. It can be a json string or an array that will be json encoded.

string $url: (optional) The document url in the site if any. This allows support for in-context review.

string $title: (optional) The title of the document as it will be seen in the TMS.

\Drupal\lingotek\LingotekProfileInterface $profile: (optional) The profile being used.

string $job_id: (optional) The job ID that will be associated.

string $locale: (optional) The Lingotek locale.

Return value

bool|string TRUE if the document was successfully updated. FALSE if not (v5.1). New document ID if the document was successfully updated. FALSE if not (v5.2).

Throws

\Drupal\lingotek\Exception\LingotekPaymentRequiredException

\Drupal\lingotek\Exception\LingotekDocumentArchivedException

\Drupal\lingotek\Exception\LingotekDocumentLockedException

\Drupal\lingotek\Exception\LingotekApiException

2 methods override LingotekInterface::updateDocument()

Lingotek::updateDocument in src/Lingotek.php

Updates a document in the Lingotek service.

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

Updates a document in the Lingotek service.

File

src/LingotekInterface.php, line 254

Class

LingotekInterface

Namespace

Drupal\lingotek

Code

public function updateDocument($doc_id, $content, $url = NULL, $title = NULL, LingotekProfileInterface $profile = NULL, $job_id = NULL, $locale = NULL);