Arikaim CMS

StorageInterface
in

Storage interface

Table of Contents

Methods

copy()  : void
Copy files
createDir()  : bool
Create directory in storage folder
delete()  : bool
Delete file from storage folder
deleteDir()  : bool
Delete directory in storage folder
getFullPath()  : string
Get full file path
has()  : bool
Return true if file exist
read()  : string|false
Read file
rename()  : bool
Rename files
write()  : bool
Write files

Methods

copy()

Copy files

public copy(string $from, string $to[, string|null $fileSystemName = null ]) : void
Parameters
$from : string
$to : string
$fileSystemName : string|null = null

createDir()

Create directory in storage folder

public createDir(string $path[, string|null $fileSystemName = null ]) : bool
Parameters
$path : string
$fileSystemName : string|null = null
Return values
bool

delete()

Delete file from storage folder

public delete(string $path[, string|null $fileSystemName = null ]) : bool
Parameters
$path : string
$fileSystemName : string|null = null
Return values
bool

deleteDir()

Delete directory in storage folder

public deleteDir(string $path[, string|null $fileSystemName = null ]) : bool
Parameters
$path : string
$fileSystemName : string|null = null
Return values
bool

getFullPath()

Get full file path

public getFullPath([string $path = '' ][, string|null $fileSystemName = null ]) : string
Parameters
$path : string = ''
$fileSystemName : string|null = null
Return values
string

has()

Return true if file exist

public has(string $path[, string|null $fileSystemName = null ]) : bool
Parameters
$path : string
$fileSystemName : string|null = null
Return values
bool

read()

Read file

public read(string $path[, string|null $fileSystemName = null ]) : string|false
Parameters
$path : string
$fileSystemName : string|null = null
Return values
string|false

rename()

Rename files

public rename(string $from, string $to[, string|null $fileSystemName = null ]) : bool
Parameters
$from : string
$to : string
$fileSystemName : string|null = null
Return values
bool

write()

Write files

public write(string $path, string $contents[, array<string|int, mixed> $config = [] ][, string|null $fileSystemName = null ]) : bool
Parameters
$path : string
$contents : string
$config : array<string|int, mixed> = []
$fileSystemName : string|null = null
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results