API Documentation

ForwardsIlluminateFilesystem

Forwards calls to the Laravel File facade to the HydePHP Filesystem Facade, while turning all paths arguments into absolute project paths.

Tags
interal

This trait is not covered by the backward compatibility promise.

see
Filesystem

Table of Contents

Methods

__callStatic()  : string|array<string|int, mixed>|int|bool|null|LazyCollection
allFiles()  : array<string|int, SplFileInfo>
append()  : int
basename()  : string
chmod()  : mixed
cleanDirectory()  : bool
copy()  : bool
copyDirectory()  : bool
delete()  : bool
deleteDirectories()  : bool
deleteDirectory()  : bool
directories()  : array<string|int, mixed>
dirname()  : string
ensureDirectoryExists()  : void
exists()  : bool
extension()  : string
files()  : array<string|int, SplFileInfo>
get()  : string
getRequire()  : mixed
glob()  : array<string|int, string>
guessExtension()  : string|null
hash()  : string
hasSameHash()  : bool
isDirectory()  : bool
isEmptyDirectory()  : bool
isFile()  : bool
isReadable()  : bool
isWritable()  : bool
lastModified()  : int
lines()  : LazyCollection
link()  : void
makeDirectory()  : bool
mimeType()  : string|false
missing()  : bool
move()  : bool
moveDirectory()  : bool
name()  : string
prepend()  : int
put()  : int|bool
relativeLink()  : void
replace()  : void
replaceInFile()  : void
requireOnce()  : mixed
sharedGet()  : string
size()  : int
type()  : string
getParameterNames()  : array<string|int, mixed>
qualifyArguments()  : Collection
qualifyPathArgument()  : string|array<string|int, mixed>

Methods

__callStatic()

public static __callStatic(string $name, array<string|int, mixed> $arguments) : string|array<string|int, mixed>|int|bool|null|LazyCollection
Parameters
$name : string
$arguments : array<string|int, mixed>
Return values
string|array<string|int, mixed>|int|bool|null|LazyCollection

allFiles()

public static allFiles([string $directory = ][, bool $hidden = false ]) : array<string|int, SplFileInfo>
Parameters
$directory : string =
$hidden : bool = false
Return values
array<string|int, SplFileInfo>

append()

public static append([string $path = ][, string $data = ]) : int
Parameters
$path : string =
$data : string =
Return values
int

chmod()

public static chmod([string $path = ][, int|null $mode = null ]) : mixed
Parameters
$path : string =
$mode : int|null = null

cleanDirectory()

public static cleanDirectory([string $directory = ]) : bool
Parameters
$directory : string =
Return values
bool

copy()

public static copy([string $path = ][, string $target = ]) : bool
Parameters
$path : string =
$target : string =
Return values
bool

copyDirectory()

public static copyDirectory([string $directory = ][, string $destination = ][, int|null $options = null ]) : bool
Parameters
$directory : string =
$destination : string =
$options : int|null = null
Return values
bool

delete()

public static delete([string|array<string|int, mixed> $paths = ]) : bool
Parameters
$paths : string|array<string|int, mixed> =
Return values
bool

deleteDirectories()

public static deleteDirectories([string $directory = ]) : bool
Parameters
$directory : string =
Return values
bool

deleteDirectory()

public static deleteDirectory([string $directory = ][, bool $preserve = false ]) : bool
Parameters
$directory : string =
$preserve : bool = false
Return values
bool

directories()

public static directories([string $directory = ]) : array<string|int, mixed>
Parameters
$directory : string =
Return values
array<string|int, mixed>

ensureDirectoryExists()

public static ensureDirectoryExists([string $path = ][, int $mode = 0755 ][, bool $recursive = true ]) : void
Parameters
$path : string =
$mode : int = 0755
$recursive : bool = true

files()

public static files([string $directory = ][, bool $hidden = false ]) : array<string|int, SplFileInfo>
Parameters
$directory : string =
$hidden : bool = false
Return values
array<string|int, SplFileInfo>

get()

public static get([string $path = ][, bool $lock = false ]) : string
Parameters
$path : string =
$lock : bool = false
Return values
string

getRequire()

public static getRequire([string $path = ][, array<string|int, mixed> $data = [] ]) : mixed
Parameters
$path : string =
$data : array<string|int, mixed> = []

glob()

public static glob([string $pattern = ][, int $flags = 0 ]) : array<string|int, string>
Parameters
$pattern : string =
$flags : int = 0
Return values
array<string|int, string>

guessExtension()

public static guessExtension([string $path = ]) : string|null
Parameters
$path : string =
Return values
string|null

hash()

public static hash([string $path = ][, string $algorithm = '\'md5\'' ]) : string
Parameters
$path : string =
$algorithm : string = '\'md5\''
Return values
string

hasSameHash()

public static hasSameHash([string $firstFile = ][, string $secondFile = ]) : bool
Parameters
$firstFile : string =
$secondFile : string =
Return values
bool

isDirectory()

public static isDirectory([string $directory = ]) : bool
Parameters
$directory : string =
Return values
bool

isEmptyDirectory()

public static isEmptyDirectory([string $directory = ][, bool $ignoreDotFiles = false ]) : bool
Parameters
$directory : string =
$ignoreDotFiles : bool = false
Return values
bool

lines()

public static lines([string $path = ]) : LazyCollection
Parameters
$path : string =
Return values
LazyCollection

link()

public static link([string $target = ][, string $link = ]) : void
Parameters
$target : string =
$link : string =

makeDirectory()

public static makeDirectory([string $path = ][, int $mode = 0755 ][, bool $recursive = false ][, bool $force = false ]) : bool
Parameters
$path : string =
$mode : int = 0755
$recursive : bool = false
$force : bool = false
Return values
bool

mimeType()

public static mimeType([string $path = ]) : string|false
Parameters
$path : string =
Return values
string|false

move()

public static move([string $path = ][, string $target = ]) : bool
Parameters
$path : string =
$target : string =
Return values
bool

moveDirectory()

public static moveDirectory([string $from = ][, string $to = ][, bool $overwrite = false ]) : bool
Parameters
$from : string =
$to : string =
$overwrite : bool = false
Return values
bool

prepend()

public static prepend([string $path = ][, string $data = ]) : int
Parameters
$path : string =
$data : string =
Return values
int

put()

public static put([string $path = ][, string $contents = ][, bool $lock = false ]) : int|bool
Parameters
$path : string =
$contents : string =
$lock : bool = false
Return values
int|bool

relativeLink()

public static relativeLink([string $target = ][, string $link = ]) : void
Parameters
$target : string =
$link : string =

replace()

public static replace([string $path = ][, string $content = ]) : void
Parameters
$path : string =
$content : string =

replaceInFile()

public static replaceInFile([array<string|int, mixed>|string $search = ][, array<string|int, mixed>|string $replace = ][, string $path = ]) : void
Parameters
$search : array<string|int, mixed>|string =
$replace : array<string|int, mixed>|string =
$path : string =

requireOnce()

public static requireOnce([string $path = ][, array<string|int, mixed> $data = [] ]) : mixed
Parameters
$path : string =
$data : array<string|int, mixed> = []

getParameterNames()

protected static getParameterNames(string $name) : array<string|int, mixed>
Parameters
$name : string
Return values
array<string|int, mixed>

qualifyArguments()

protected static qualifyArguments(array<string|int, string> $parameterNames, array<string|int, mixed> $arguments) : Collection
Parameters
$parameterNames : array<string|int, string>
$arguments : array<string|int, mixed>
Return values
Collection

qualifyPathArgument()

protected static qualifyPathArgument(array<string|int, mixed>|string $path) : string|array<string|int, mixed>
Parameters
$path : array<string|int, mixed>|string
Return values
string|array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results