FolderInterface extends ResourceInterface

Interface for folders

Table of Contents

Constants

ROLE_DEFAULT  = 'default'
Roles for folders
ROLE_MOUNT  = 'mount'
ROLE_PROCESSING  = 'processing'
ROLE_READONLY_MOUNT  = 'readonly-mount'
ROLE_RECYCLER  = 'recycler'
ROLE_TEMPORARY  = 'temporary'
ROLE_USER_MOUNT  = 'user-mount'
ROLE_USERUPLOAD  = 'userupload'

Methods

delete()  : bool
Deletes this folder from its storage. This also means that this object becomes useless.
getCreationTime()  : int
Returns the creation time of the folder as Unix timestamp
getFile()  : File|ProcessedFile|null
Fetches a file from a folder, must be a direct descendant of a folder.
getHashedIdentifier()  : string
Get hashed identifier
getIdentifier()  : string
Returns the identifier of this file
getModificationTime()  : int
Returns the modification time of the folder as Unix timestamp
getName()  : string
Returns the name of this file
getParentFolder()  : FolderInterface
getStorage()  : ResourceStorage
Get the storage this file is located in
getSubfolder()  : Folder
Returns the object for a subfolder of the current folder, if it exists.
getSubfolders()  : array<string|int, Folder>
hasFile()  : bool
Checks if a file exists in this folder
hasFolder()  : bool
Checks if a folder exists in this folder.
rename()  : Folder
Renames this folder.

Constants

ROLE_DEFAULT

Roles for folders

public mixed ROLE_DEFAULT = 'default'

ROLE_MOUNT

public mixed ROLE_MOUNT = 'mount'

ROLE_PROCESSING

public mixed ROLE_PROCESSING = 'processing'

ROLE_READONLY_MOUNT

public mixed ROLE_READONLY_MOUNT = 'readonly-mount'

ROLE_RECYCLER

public mixed ROLE_RECYCLER = 'recycler'

ROLE_TEMPORARY

public mixed ROLE_TEMPORARY = 'temporary'

ROLE_USER_MOUNT

public mixed ROLE_USER_MOUNT = 'user-mount'

ROLE_USERUPLOAD

public mixed ROLE_USERUPLOAD = 'userupload'

Methods

delete()

Deletes this folder from its storage. This also means that this object becomes useless.

public delete() : bool
Return values
bool —

TRUE if deletion succeeded

getCreationTime()

Returns the creation time of the folder as Unix timestamp

public getCreationTime() : int
Return values
int

getHashedIdentifier()

Get hashed identifier

public getHashedIdentifier() : string
Return values
string

getIdentifier()

Returns the identifier of this file

public getIdentifier() : string
Return values
string

getModificationTime()

Returns the modification time of the folder as Unix timestamp

public getModificationTime() : int
Return values
int

getName()

Returns the name of this file

public getName() : string
Return values
string

getSubfolder()

Returns the object for a subfolder of the current folder, if it exists.

public getSubfolder(string $name) : Folder
Parameters
$name : string

Name of the subfolder

Return values
Folder

getSubfolders()

public getSubfolders() : array<string|int, Folder>
Return values
array<string|int, Folder>

hasFile()

Checks if a file exists in this folder

public hasFile(string $name) : bool
Parameters
$name : string
Return values
bool

hasFolder()

Checks if a folder exists in this folder.

public hasFolder(string $name) : bool
Parameters
$name : string
Return values
bool

rename()

Renames this folder.

public rename(string $newName) : Folder
Parameters
$newName : string
Return values
Folder 

        

        
    




    

    

                            

            

                        
    

        On this page

        
    


            

                    

        

    

        

            
Search results