class DownloadFileParameters in TMGMT Translator Smartling 8.3

Class DownloadFileParameters

@package Smartling\File\Params

Hierarchy

• class \Smartling\Parameters\BaseParameters implements ParameterInterface
  • class \Smartling\File\Params\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

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

Name	Modifiers	Type	Description	Overrides
BaseParameters::$params	protected	property
BaseParameters::exportToArray	public	function	@inheritdoc Overrides ParameterInterface::exportToArray	1
BaseParameters::set	public	function	@inheritdoc Overrides ParameterInterface::set
DownloadFileParameters::RETRIEVAL_TYPE_PENDING		constant
DownloadFileParameters::RETRIEVAL_TYPE_PSEUDO		constant
DownloadFileParameters::RETRIEVAL_TYPE_PUBLISHED		constant
DownloadFileParameters::setIncludeOriginalStrings	public	function
DownloadFileParameters::setRetrievalType	public	function