public function LingotekApi::getProgressReport in Lingotek Translation 7.3

Same name and namespace in other branches

1. 7.7 lib/Drupal/lingotek/LingotekApi.php \LingotekApi::getProgressReport()
2. 7.2 lib/Drupal/lingotek/LingotekApi.php \LingotekApi::getProgressReport()
3. 7.4 lib/Drupal/lingotek/LingotekApi.php \LingotekApi::getProgressReport()
4. 7.5 lib/Drupal/lingotek/LingotekApi.php \LingotekApi::getProgressReport()
5. 7.6 lib/Drupal/lingotek/LingotekApi.php \LingotekApi::getProgressReport()

Gets the workflow progress of the specified project (or list of document ids).

Parameters

int $project_id:

array<int> $document_ids: An array of document IDs of the Lingotek Document to retrieve.

Return value

mixed The API response object with Lingotek Document data, or FALSE on error.

File

lib/Drupal/lingotek/LingotekApi.php, line 542

Defines Drupal\lingotek\LingotekApi

Class

LingotekApi

@file Defines Drupal\lingotek\LingotekApi

Code

public function getProgressReport($project_id = NULL, $document_ids = NULL) {
  $params = array();
  if (is_array($document_ids)) {
    $params['documentId'] = $document_ids;
  }
  else {
    if (!is_null($project_id)) {
      $params['projectId'] = $project_id;
    }
  }
  $report = $this
    ->request('getProgressReport', $params);
  return $report;
}