IObjectStore
in
Interface IObjectStore
Tags
Table of Contents
Methods
- copyObject() : void
- deleteObject() : void
- getStorageId() : string
- objectExists() : bool
- Check if an object exists in the object store
- preSignedUrl() : string|null
- Get a pre-signed url for an object.
- readObject() : resource
- writeObject() : mixed
Methods
copyObject()
public
copyObject(string $from, string $to) : void
Parameters
- $from : string
-
the unified resource name used to identify the source object
- $to : string
-
the unified resource name used to identify the target object
Tags
deleteObject()
public
deleteObject(string $urn) : void
Parameters
- $urn : string
-
the unified resource name used to identify the object
Tags
getStorageId()
public
getStorageId() : string
Tags
Return values
string —the container or bucket name where objects are stored
objectExists()
Check if an object exists in the object store
public
objectExists(string $urn) : bool
Parameters
- $urn : string
Tags
Return values
boolpreSignedUrl()
Get a pre-signed url for an object.
public
preSignedUrl(string $urn, DateTimeInterface $expiration[, string|null $filename = null ]) : string|null
The URL is signed so a browser download via an anchor click receives Content-Disposition: attachment. $filename is that download name.
Parameters
- $urn : string
- $expiration : DateTimeInterface
- $filename : string|null = null
Tags
Return values
string|nullreadObject()
public
readObject(string $urn) : resource
Parameters
- $urn : string
-
the unified resource name used to identify the object
Tags
Return values
resource —stream with the read data
writeObject()
public
writeObject(string $urn, resource $stream[, string|null $mimetype = null ]) : mixed
Parameters
- $urn : string
-
the unified resource name used to identify the object
- $stream : resource
-
stream with the data to write
- $mimetype : string|null = null
-
the mimetype to set for the remove object @since 22.0.0