1. class
  2. Google
  3. \
  4. Http
  5. \
  6. MediaFileUpload

MediaFileUpload

class MediaFileUpload (View source)

Manage large file uploads, which may be media but can be any type of sizable data.

Constants

UPLOAD_MEDIA_TYPE

UPLOAD_MULTIPART_TYPE

UPLOAD_RESUMABLE_TYPE

Methods

__construct(Client $client, RequestInterface $request, string $mimeType, string $data, bool $resumable = false, int $chunkSize = 0)

No description

setFileSize(int $size)

Set the size of the file that is being uploaded.

int
getProgress()

Return the progress on the upload

nextChunk(string|bool $chunk = false)

Send the next part of the file to upload.

int
getHttpResultCode()

Return the HTTP result code from the last call made.

resume(string $resumeUri)

Resume a previously unfinished upload

string
getUploadType(string|false $meta)

Valid upload types: - resumable (UPLOAD_RESUMABLE_TYPE) - media (UPLOAD_MEDIA_TYPE) - multipart (UPLOAD_MULTIPART_TYPE)

getResumeUri()

No description

setChunkSize($chunkSize)

No description

getRequest()

No description

Details

at line 82
__construct(Client $client, RequestInterface $request, string $mimeType, string $data, bool $resumable = false, int $chunkSize = 0)

Parameters

Client $client
RequestInterface $request
string $mimeType
string $data The bytes you want to upload.
bool $resumable
int $chunkSize File will be uploaded in chunks of this many bytes. only used if resumable=True

at line 105
setFileSize(int $size)

Set the size of the file that is being uploaded.

Parameters

int $size
  • int file size in bytes

at line 114
int getProgress()

Return the progress on the upload

Return Value

int progress in bytes uploaded.

at line 124
nextChunk(string|bool $chunk = false)

Send the next part of the file to upload.

Parameters

string|bool $chunk Optional. The next set of bytes to send. If false will use $data passed at construct time.

at line 153
int getHttpResultCode()

Return the HTTP result code from the last call made.

Return Value

int code

at line 197
resume(string $resumeUri)

Resume a previously unfinished upload

Parameters

string $resumeUri the resume-URI of the unfinished, resumable upload.

at line 273
string getUploadType(string|false $meta)

Valid upload types: - resumable (UPLOAD_RESUMABLE_TYPE) - media (UPLOAD_MEDIA_TYPE) - multipart (UPLOAD_MULTIPART_TYPE)

Parameters

string|false $meta

Return Value

string

at line 286
getResumeUri()

at line 344
setChunkSize($chunkSize)

Parameters

$chunkSize

at line 349
getRequest()