interface StorageObjectInterface

Interface that describes a class representing a file object, regardless of location or storage backend.

Methods

string
__toString()

Returns the object path name {see StorageObjectInterface::getPathName()}.

bool
exists()

Returns whether object exists on storage medium.

mixed
getIdentifier()

Returns an object file identifier.

string
getUrl()

Returns the object file url.

getPathInfo()

Returns the object path info metadata instance.

getContext()

Returns the object type metadata instance.

getMimeType()

Returns an object mime type metadata instance.

getUuid()

Returns an object uuid metadata instance.

getSize()

Returns an object size metadata instance.

getOwner()

Returns an object owner metadata instance.

getPermissions()

Returns an object permissions metadata instance.

getTime()

Returns an object time metadata instance.

string
getContents()

Returns the object file contents.

string
setContents( string $contents)

Sets and returns the object file contents.

Details

at line line 33
string __toString()

Returns the object path name {see StorageObjectInterface::getPathName()}.

Return Value

string

at line line 40
bool exists()

Returns whether object exists on storage medium.

Return Value

bool

at line line 47
mixed getIdentifier()

Returns an object file identifier.

Return Value

mixed

at line line 54
string getUrl()

Returns the object file url.

Return Value

string

at line line 61
PathInfoAccessors getPathInfo()

Returns the object path info metadata instance.

Return Value

PathInfoAccessors

at line line 68
ContextAccessors getContext()

Returns the object type metadata instance.

Return Value

ContextAccessors

at line line 75
MimeTypeAccessors getMimeType()

Returns an object mime type metadata instance.

Return Value

MimeTypeAccessors

at line line 82
UuidAccessors getUuid()

Returns an object uuid metadata instance.

Return Value

UuidAccessors

at line line 89
SizeAccessors getSize()

Returns an object size metadata instance.

Return Value

SizeAccessors

at line line 96
OwnerAccessors getOwner()

Returns an object owner metadata instance.

Return Value

OwnerAccessors

at line line 103
PermissionAccessors getPermissions()

Returns an object permissions metadata instance.

Return Value

PermissionAccessors

at line line 110
DateTimeAccessors getTime()

Returns an object time metadata instance.

Return Value

DateTimeAccessors

at line line 117
string getContents()

Returns the object file contents.

Return Value

string

at line line 126
string setContents( string $contents)

Sets and returns the object file contents.

Parameters

string $contents

Return Value

string