PHP Класс CloudConvert\Process

Автор: Josias Montag ([email protected])
Наследование: extends ApiObject
Показать файл Открыть проект

Открытые методы

Метод Описание
__construct ( Api $api, string $url ) : Process Construct a new Process instance
delete ( ) : Process Delete Process from API
download ( string $localfile = null, string $remotefile = null ) : Process Download process files from API
downloadAll ( string $directory = null ) : Process Download all output process files from API
downloadStream ( resource $stream, string $remotefile = null ) : Process Download process files from API and write to a given stream
start ( array $parameters ) : Process Starts the Process
upload ( $stream, string $filename = null ) : Process Uploads the input file. See https://cloudconvert.com/apidoc#upload
wait ( ) : Process Waits for the Process to finish (or end with an error)

Описание методов

__construct() публичный Метод

Construct a new Process instance
public __construct ( Api $api, string $url ) : Process
$api Api
$url string The Process URL
Результат Process

delete() публичный Метод

Delete Process from API
public delete ( ) : Process
Результат Process

download() публичный Метод

Download process files from API
public download ( string $localfile = null, string $remotefile = null ) : Process
$localfile string Local file name (or directory) the file should be downloaded to
$remotefile string Remote file name which should be downloaded (if there are multiple output files available)
Результат Process

downloadAll() публичный Метод

Download all output process files from API
public downloadAll ( string $directory = null ) : Process
$directory string Local directory the files should be downloaded to
Результат Process

downloadStream() публичный Метод

Download process files from API and write to a given stream
public downloadStream ( resource $stream, string $remotefile = null ) : Process
$stream resource Stream to write the downloaded data to
$remotefile string Remote file name which should be downloaded (if there are multiple output files available)
Результат Process

start() публичный Метод

Starts the Process
public start ( array $parameters ) : Process
$parameters array Parameters for creating the Process. See https://cloudconvert.com/apidoc#start
Результат Process

upload() публичный Метод

Uploads the input file. See https://cloudconvert.com/apidoc#upload
public upload ( $stream, string $filename = null ) : Process
$filename string Filename of the input file
Результат Process

wait() публичный Метод

Waits for the Process to finish (or end with an error)
public wait ( ) : Process
Результат Process