1. interface
  2. SR
  3. File
  4. Object
  5. Provider
  6. StorageObjectProviderInterface

StorageObjectProviderInterface

interface StorageObjectProviderInterface

Interface that describes classes representing a file object provider.

Constants

TYPE_FILE

TYPE_DIRECTORY

TYPE_UNKNOWN

Methods

MimeTypeResolverInterface[]
getMimeTypeGuessers()

Returns the mime type guessers supported by object type.

mixed
getIdentifier()

Returns the object identifier.

string
getUrl()

Returns the object URL.

string
getPathName()

Returns the object's full path name.

string
getRealPathName()

Returns the object's real full path name.

bool
exists()

Returns whether object exists on storage medium.

string
getType()

Returns the file type.

bool
isFile()

Returns whether object type is a file.

bool
isDirectory()

Returns whether object type is a directory.

bool
isLink()

Returns whether object type is a link.

bool
isExecutable()

Returns whether object type is a executable.

bool
isLocal()

Returns whether object is locally stored.

int
getSizeAsBytes()

Returns the object's size in bytes.

int
getOwningUser()

Returns the object owning user.

int
getOwningGroup()

Returns the object owning group.

int
getPermissionsAsOctal()

Returns the object permissions.

bool
isReadable()

Returns whether object is readable.

bool
isWritable()

Returns whether object is writable.

int
getCreatedAsUnixTime()

Returns the unix time the object was created.

int
getAccessedAsUnixTime()

Returns the unix time the object was accessed.

int
getModifiedAsUnixTime()

Returns the unix time the object was modified.

string
getContent()

Read contents from the object.

string
setContent( string $contents)

Write contents to the object.

Details

at line line 30
MimeTypeResolverInterface[] getMimeTypeGuessers()

Returns the mime type guessers supported by object type.

Return Value

MimeTypeResolverInterface[]

at line line 37
mixed getIdentifier()

Returns the object identifier.

Return Value

mixed

at line line 44
string getUrl()

Returns the object URL.

Return Value

string

at line line 51
string getPathName()

Returns the object's full path name.

Return Value

string

at line line 58
string getRealPathName()

Returns the object's real full path name.

Return Value

string

at line line 65
bool exists()

Returns whether object exists on storage medium.

Return Value

bool

at line line 72
string getType()

Returns the file type.

Return Value

string

at line line 79
bool isFile()

Returns whether object type is a file.

Return Value

bool

at line line 86
bool isDirectory()

Returns whether object type is a directory.

Return Value

bool

Returns whether object type is a link.

Return Value

bool

at line line 100
bool isExecutable()

Returns whether object type is a executable.

Return Value

bool

at line line 107
bool isLocal()

Returns whether object is locally stored.

Return Value

bool

at line line 114
int getSizeAsBytes()

Returns the object's size in bytes.

Return Value

int

at line line 121
int getOwningUser()

Returns the object owning user.

Return Value

int

at line line 128
int getOwningGroup()

Returns the object owning group.

Return Value

int

at line line 135
int getPermissionsAsOctal()

Returns the object permissions.

Return Value

int

at line line 142
bool isReadable()

Returns whether object is readable.

Return Value

bool

at line line 149
bool isWritable()

Returns whether object is writable.

Return Value

bool

at line line 156
int getCreatedAsUnixTime()

Returns the unix time the object was created.

Return Value

int

at line line 163
int getAccessedAsUnixTime()

Returns the unix time the object was accessed.

Return Value

int

at line line 170
int getModifiedAsUnixTime()

Returns the unix time the object was modified.

Return Value

int

at line line 177
string getContent()

Read contents from the object.

Return Value

string

at line line 186
string setContent( string $contents)

Write contents to the object.

Parameters

string $contents

Return Value

string