Documentation

S3Request
in package

FinalYes

S3 Request class

Tags
link
http://undesigned.org.za/2007/10/22/amazon-s3-php-class
version
0.5.0-dev

Table of Contents

Properties

$data  : array<string|int, mixed>
PUT post fields
$fp  : bool
Use HTTP PUT?
$response  : object
S3 request respone
$size  : int
PUT file size
$amzHeaders  : array<string|int, mixed>
Amazon specific request headers
$bucket  : string
S3 bucket name
$endpoint  : string
AWS URI
$headers  : array<string|int, mixed>
HTTP request headers
$parameters  : array<string|int, mixed>
Additional request parameters
$resource  : string
Final object URI
$uri  : string
Object URI
$verb  : string
Verb

Methods

__construct()  : mixed
Constructor
getResponse()  : object|false
Get the S3 response
setAmzHeader()  : void
Set x-amz-meta-* header
setHeader()  : void
Set request header
setParameter()  : void
Set request parameter
__dnsBucketName()  : bool
Check DNS conformity
__responseHeaderCallback()  : int
CURL header callback
__responseWriteCallback()  : int
CURL write callback

Properties

$data

PUT post fields

public array<string|int, mixed> $data = \false
Tags
access

public

$fp

Use HTTP PUT?

public bool $fp = \false
Tags
access

public

$response

S3 request respone

public object $response
Tags
access

public

$size

PUT file size

public int $size = 0
Tags
access

public

$amzHeaders

Amazon specific request headers

private array<string|int, mixed> $amzHeaders = array()
Tags
access

private

$bucket

S3 bucket name

private string $bucket
Tags
access

private

$endpoint

AWS URI

private string $endpoint
Tags
access

private

$headers

HTTP request headers

private array<string|int, mixed> $headers = array('Host' => '', 'Date' => '', 'Content-MD5' => '', 'Content-Type' => '')
Tags
access

private

$parameters

Additional request parameters

private array<string|int, mixed> $parameters = array()
Tags
access

private

$resource

Final object URI

private string $resource = ''
Tags
access

private

$uri

Object URI

private string $uri
Tags
access

private

$verb

Verb

private string $verb
Tags
access

private

Methods

__construct()

Constructor

public __construct(string $verb[, string $bucket = '' ][, string $uri = '' ][, string $endpoint = 's3.amazonaws.com' ]) : mixed
Parameters
$verb : string

Verb

$bucket : string = ''

Bucket name

$uri : string = ''

Object URI

$endpoint : string = 's3.amazonaws.com'

AWS endpoint URI

getResponse()

Get the S3 response

public getResponse() : object|false
Return values
object|false

setAmzHeader()

Set x-amz-meta-* header

public setAmzHeader(string $key, string $value) : void
Parameters
$key : string

Key

$value : string

Value

setHeader()

Set request header

public setHeader(string $key, string $value) : void
Parameters
$key : string

Key

$value : string

Value

setParameter()

Set request parameter

public setParameter(string $key, string $value) : void
Parameters
$key : string

Key

$value : string

Value

__dnsBucketName()

Check DNS conformity

private __dnsBucketName(string $bucket) : bool
Parameters
$bucket : string

Bucket name

Return values
bool

__responseHeaderCallback()

CURL header callback

private __responseHeaderCallback(resource $curl, string $data) : int
Parameters
$curl : resource

CURL resource

$data : string

Data

Return values
int

__responseWriteCallback()

CURL write callback

private __responseWriteCallback(resource $curl, string $data) : int
Parameters
$curl : resource

CURL resource

$data : string

Data

Return values
int

        
On this page

Search results