You are here

class DownloadFileParameters in TMGMT Translator Smartling 8.4

Same name and namespace in other branches
  1. 8.2 api-sdk-php/src/File/Params/DownloadFileParameters.php \Smartling\File\Params\DownloadFileParameters
  2. 8.2 vendor/smartling/api-sdk-php/src/File/Params/DownloadFileParameters.php \Smartling\File\Params\DownloadFileParameters
  3. 8.3 vendor/smartling/api-sdk-php/src/File/Params/DownloadFileParameters.php \Smartling\File\Params\DownloadFileParameters

Class DownloadFileParameters

@package Smartling\File\Params

Hierarchy

Expanded class hierarchy of DownloadFileParameters

4 files declare their use of DownloadFileParameters
FileApi.php in vendor/smartling/api-sdk-php/src/File/FileApi.php
FileApiFunctionalTest.php in vendor/smartling/api-sdk-php/tests/functional/FileApiFunctionalTest.php
FileApiTest.php in vendor/smartling/api-sdk-php/tests/unit/FileApiTest.php
tmgmt_smartling.module in ./tmgmt_smartling.module
Contains

File

vendor/smartling/api-sdk-php/src/File/Params/DownloadFileParameters.php, line 13

Namespace

Smartling\File\Params
View source
class DownloadFileParameters extends BaseParameters {
  const RETRIEVAL_TYPE_PUBLISHED = 'published';
  const RETRIEVAL_TYPE_PENDING = 'pending';
  const RETRIEVAL_TYPE_PSEUDO = 'pseudo';

  /**
   * @param string $retrievalType
   *
   * @return DownloadFileParameters
   * @throws SmartlingApiException
   */
  public function setRetrievalType($retrievalType) {
    $validRetrivalType = in_array($retrievalType, [
      self::RETRIEVAL_TYPE_PENDING,
      self::RETRIEVAL_TYPE_PUBLISHED,
      self::RETRIEVAL_TYPE_PSEUDO,
    ], true);
    if (!$validRetrivalType) {
      throw new SmartlingApiException('Unknown retrieval type: ' . var_export($retrievalType, true));
    }
    $this
      ->set('retrievalType', $retrievalType);
    return $this;
  }
  public function setIncludeOriginalStrings($include_original_strings) {
    $this->params['includeOriginalStrings'] = $include_original_strings;
    return $this;
  }

}

Members