cloudconvert php
3.4.2
これは、CloudConvert API v2の公式 PHP SDK です。
PHP SDK をインストールするには、プロジェクトで Composer を使用する必要があります。
Guzzle と一緒に SDK をインストールします。
composer require cloudconvert/cloudconvert-php guzzlehttp/guzzleこのパッケージは、PSR-7、PSR-17、PSR-18、および HTTPlug を使用して特定の HTTP クライアントに関連付けられません。したがって、 psr/http-client-implementationおよびpsr/http-factory-implementationを提供するパッケージ (Guzzle など) もインストールする必要があります。
use CloudConvert CloudConvert ;
use CloudConvert Models Job ;
use CloudConvert Models Task ;
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false
]);
$ job = ( new Job ())
-> setTag ( ' myjob-1 ' )
-> addTask (
( new Task ( ' import/url ' , ' import-my-file ' ))
-> set ( ' url ' , ' https://my-url ' )
)
-> addTask (
( new Task ( ' convert ' , ' convert-my-file ' ))
-> set ( ' input ' , ' import-my-file ' )
-> set ( ' output_format ' , ' pdf ' )
-> set ( ' some_other_option ' , ' value ' )
)
-> addTask (
( new Task ( ' export/url ' , ' export-my-file ' ))
-> set ( ' input ' , ' convert-my-file ' )
);
$ cloudconvert -> jobs ()-> create ( $ job )CloudConvert Job Builder を使用すると、さまざまなタスク タイプで利用可能なオプションを確認できます。
CloudConvert へのアップロードは、 import/uploadタスクを通じて行われます (ドキュメントを参照)。この SDK は、便利なアップロード方法を提供します。
use CloudConvert Models Job ;
use CloudConvert Models Task ;
$ job = ( new Job ())
-> addTask ( new Task ( ' import/upload ' , ' upload-my-file ' ))
-> addTask (
( new Task ( ' convert ' , ' convert-my-file ' ))
-> set ( ' input ' , ' upload-my-file ' )
-> set ( ' output_format ' , ' pdf ' )
)
-> addTask (
( new Task ( ' export/url ' , ' export-my-file ' ))
-> set ( ' input ' , ' convert-my-file ' )
);
$ job = $ cloudconvert -> jobs ()-> create ( $ job );
$ uploadTask = $ job -> getTasks ()-> whereName ( ' upload-my-file ' )[ 0 ];
$ cloudconvert -> tasks ()-> upload ( $ uploadTask , fopen ( ' ./file.pdf ' , ' r ' ), ' file.pdf ' ); upload()メソッドは、文字列、PHP リソース、または PSR-7 StreamInterface 2 番目のパラメータとして受け入れます。
クライアントが CloudConvert にファイルをアップロードできるように直接許可することもできます。
< form action =" <?=$uploadTask->getResult()->form->url?> "
method =" POST "
enctype =" multipart/form-data " >
< ? foreach ((array)$uploadTask- > getResult()- > form- > parameters as $parameter = > $value) { ? >
< input type =" hidden " name =" <?=$parameter?> " value =" <?=$value?> " >
< ? } ? >
< input type =" file " name =" file " >
< input type =" submit " >
</ form > CloudConvert はexport/urlタスクを使用するためのパブリック URL を生成できます。ジョブの終了時に、PHP SDK を使用して出力ファイルをダウンロードできます。
$ cloudconvert -> jobs ()-> wait ( $ job ); // Wait for job completion
foreach ( $ job -> getExportUrls () as $ file ) {
$ source = $ cloudconvert -> getHttpTransport ()-> download ( $ file -> url )-> detach ();
$ dest = fopen ( ' output/ ' . $ file -> filename , ' w ' );
stream_copy_to_stream ( $ source , $ dest );
} download()メソッドは PSR-7 StreamInterfaceを返します。これは、 detach()を使用して PHP リソースとして使用できます。
Webhook は CloudConvert ダッシュボードで作成でき、必要な署名シークレットもそこで見つけることができます。
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false
]);
$ signingSecret = ' ... ' ; // You can find it in your webhook settings
$ payload = @ file_get_contents ( ' php://input ' );
$ signature = $ _SERVER [ ' HTTP_CLOUDCONVERT_SIGNATURE ' ];
try {
$ webhookEvent = $ cloudconvert -> webhookHandler ()-> constructEvent ( $ payload , $ signature , $ signingSecret );
} catch ( CloudConvert Exceptions UnexpectedDataException $ e ) {
// Invalid payload
http_response_code ( 400 );
exit ();
} catch ( CloudConvert Exceptions SignatureVerificationException $ e ) {
// Invalid signature
http_response_code ( 400 );
exit ();
}
$ job = $ webhookEvent -> getJob ();
$ job -> getTag (); // can be used to store an ID
$ exportTask = $ job -> getTasks ()
-> whereStatus ( Task :: STATUS_FINISHED ) // get the task with ' finished ' status . . .
-> whereName ( ' export-it ' )[ 0 ]; // ... and with the name 'export-it'
// ...あるいは、PSR-7 RequestInterfaceを使用してWebhookEvent構築することもできます。
$ webhookEvent = $ cloudconvert -> webhookHandler ()-> constructEventFromRequest ( $ request , $ signingSecret );署名付き URL では、URL クエリ パラメーターを使用してのみ、オンデマンドでファイルを変換できます。 PHP SDK を使用すると、そのような URL を生成できます。したがって、CloudConvert ダッシュボードで署名付き URL ベースと署名シークレットを取得する必要があります。
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false
]);
$ job = ( new Job ())
-> addTask (
( new Task ( ' import/url ' , ' import-my-file ' ))
-> set ( ' url ' , ' https://my.url/file.docx ' )
)
-> addTask (
( new Task ( ' convert ' , ' convert-my-file ' ))
-> set ( ' input ' , ' import-my-file ' )
-> set ( ' output_format ' , ' pdf ' )
)
-> addTask (
( new Task ( ' export/url ' , ' export-my-file ' ))
-> set ( ' input ' , ' convert-my-file ' )
);
$ signedUrlBase = ' SIGNED_URL_BASE ' ;
$ signingSecret = ' SIGNED_URL_SIGNING_SECRET ' ;
$ url = $ cloudConvert -> signedUrlBuilder ()-> createFromJob ( $ signedUrlBase , $ signingSecret , $ job , ' CACHE_KEY ' );デフォルトでは、アカウント設定の地域が使用されます。あるいは、固定領域を設定することもできます。
// Pass the region to the constructor
$ cloudconvert = new CloudConvert ([
' api_key ' => ' API_KEY ' ,
' sandbox ' => false ,
' region ' => ' us-east '
]); vendor/bin/phpunit --testsuite unit
vendor/bin/phpunit --testsuite integration
デフォルトでは、公式 CloudConvert アカウントを使用して、サンドボックス API に対して統合テストが実行されます。自分のアカウントを使用したい場合は、 CLOUDCONVERT_API_KEY環境変数を使用して API キーを設定できます。この場合、サンドボックス API 用に次の MD5 ハッシュをホワイトリストに登録する必要があります (CloudConvert ダッシュボードを使用)。
53d6fe6b688c31c565907c81de625046 input.pdf
99d4c165f77af02015aa647770286cf9 input.png
