1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. File

File

class File extends Facade (View source)

Properties

static protected Application|null $app

The application instance being facaded.

 from  Facade
static protected array $resolvedInstance

The resolved object instances.

 from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static Expectation
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static Expectation
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string $name)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Application|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|null $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static bool
exists(string $path)

No description

static bool
missing(string $path)

No description

static string
get(string $path, bool $lock = false)

No description

static array
json(string $path, int $flags, bool $lock = false)

No description

static string
sharedGet(string $path)

No description

static mixed
getRequire(string $path, array $data = [])

No description

static mixed
requireOnce(string $path, array $data = [])

No description

static LazyCollection
lines(string $path)

No description

static string|false
hash(string $path, string $algorithm = 'md5')

No description

static int|bool
put(string $path, string $contents, bool $lock = false)

No description

static void
replace(string $path, string $content, int|null $mode = null)

No description

static void
replaceInFile(array|string $search, array|string $replace, string $path)

No description

static int
prepend(string $path, string $data)

No description

static int
append(string $path, string $data, bool $lock = false)

No description

static mixed
chmod(string $path, int|null $mode = null)

No description

static bool
delete(string|array $paths)

No description

static bool
move(string $path, string $target)

No description

static bool
copy(string $path, string $target)

No description

static bool|null
link(string $target, string $link)

No description

static void
relativeLink(string $target, string $link)

No description

static string
name(string $path)

No description

static string
basename(string $path)

No description

static string
dirname(string $path)

No description

static string
extension(string $path)

No description

static string|null
guessExtension(string $path)

No description

static string
type(string $path)

No description

static string|false
mimeType(string $path)

No description

static int
size(string $path)

No description

static int
lastModified(string $path)

No description

static bool
isDirectory(string $directory)

No description

static bool
isEmptyDirectory(string $directory, bool $ignoreDotFiles = false)

No description

static bool
isReadable(string $path)

No description

static bool
isWritable(string $path)

No description

static bool
hasSameHash(string $firstFile, string $secondFile)

No description

static bool
isFile(string $file)

No description

static array
glob(string $pattern, int $flags)

No description

static SplFileInfo[]
files(string $directory, bool $hidden = false)

No description

static SplFileInfo[]
allFiles(string $directory, bool $hidden = false)

No description

static array
directories(string $directory)

No description

static void
ensureDirectoryExists(string $path, int $mode = 0755, bool $recursive = true)

No description

static bool
makeDirectory(string $path, int $mode = 0755, bool $recursive = false, bool $force = false)

No description

static bool
moveDirectory(string $from, string $to, bool $overwrite = false)

No description

static bool
copyDirectory(string $directory, string $destination, int|null $options = null)

No description

static bool
deleteDirectory(string $directory, bool $preserve = false)

No description

static bool
deleteDirectories(string $directory)

No description

static bool
cleanDirectory(string $directory)

No description

static Filesystem|mixed
when(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description

static Filesystem|mixed
unless(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description

static void
macro(string $name, object|callable $macro)

No description

static void
mixin(object $mixin, bool $replace = true)

No description

static bool
hasMacro(string $name)

No description

static void
flushMacros()

No description

Details

in Facade at line 45
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 63
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 79
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 95
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 111
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 127
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 141
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 153
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 166
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 179
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 193
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 206
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 68
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 229
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 250
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 260
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 270
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 325
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

in Facade at line 336
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

in Facade at line 350
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 61
static bool exists(string $path)

No description

Parameters

string $path

Return Value

bool

at line 61
static bool missing(string $path)

No description

Parameters

string $path

Return Value

bool

at line 61
static string get(string $path, bool $lock = false)

No description

Parameters

string $path
bool $lock

Return Value

string

at line 61
static array json(string $path, int $flags, bool $lock = false)

No description

Parameters

string $path
int $flags
bool $lock

Return Value

array

at line 61
static string sharedGet(string $path)

No description

Parameters

string $path

Return Value

string

at line 61
static mixed getRequire(string $path, array $data = [])

No description

Parameters

string $path
array $data

Return Value

mixed

at line 61
static mixed requireOnce(string $path, array $data = [])

No description

Parameters

string $path
array $data

Return Value

mixed

at line 61
static LazyCollection lines(string $path)

No description

Parameters

string $path

Return Value

LazyCollection

at line 61
static string|false hash(string $path, string $algorithm = 'md5')

No description

Parameters

string $path
string $algorithm

Return Value

string|false

at line 61
static int|bool put(string $path, string $contents, bool $lock = false)

No description

Parameters

string $path
string $contents
bool $lock

Return Value

int|bool

at line 61
static void replace(string $path, string $content, int|null $mode = null)

No description

Parameters

string $path
string $content
int|null $mode

Return Value

void

at line 61
static void replaceInFile(array|string $search, array|string $replace, string $path)

No description

Parameters

array|string $search
array|string $replace
string $path

Return Value

void

at line 61
static int prepend(string $path, string $data)

No description

Parameters

string $path
string $data

Return Value

int

at line 61
static int append(string $path, string $data, bool $lock = false)

No description

Parameters

string $path
string $data
bool $lock

Return Value

int

at line 61
static mixed chmod(string $path, int|null $mode = null)

No description

Parameters

string $path
int|null $mode

Return Value

mixed

at line 61
static bool delete(string|array $paths)

No description

Parameters

string|array $paths

Return Value

bool

at line 61
static bool move(string $path, string $target)

No description

Parameters

string $path
string $target

Return Value

bool

at line 61
static bool copy(string $path, string $target)

No description

Parameters

string $path
string $target

Return Value

bool

No description

Parameters

string $target
string $link

Return Value

bool|null

No description

Parameters

string $target
string $link

Return Value

void

at line 61
static string name(string $path)

No description

Parameters

string $path

Return Value

string

at line 61
static string basename(string $path)

No description

Parameters

string $path

Return Value

string

at line 61
static string dirname(string $path)

No description

Parameters

string $path

Return Value

string

at line 61
static string extension(string $path)

No description

Parameters

string $path

Return Value

string

at line 61
static string|null guessExtension(string $path)

No description

Parameters

string $path

Return Value

string|null

at line 61
static string type(string $path)

No description

Parameters

string $path

Return Value

string

at line 61
static string|false mimeType(string $path)

No description

Parameters

string $path

Return Value

string|false

at line 61
static int size(string $path)

No description

Parameters

string $path

Return Value

int

at line 61
static int lastModified(string $path)

No description

Parameters

string $path

Return Value

int

at line 61
static bool isDirectory(string $directory)

No description

Parameters

string $directory

Return Value

bool

at line 61
static bool isEmptyDirectory(string $directory, bool $ignoreDotFiles = false)

No description

Parameters

string $directory
bool $ignoreDotFiles

Return Value

bool

at line 61
static bool isReadable(string $path)

No description

Parameters

string $path

Return Value

bool

at line 61
static bool isWritable(string $path)

No description

Parameters

string $path

Return Value

bool

at line 61
static bool hasSameHash(string $firstFile, string $secondFile)

No description

Parameters

string $firstFile
string $secondFile

Return Value

bool

at line 61
static bool isFile(string $file)

No description

Parameters

string $file

Return Value

bool

at line 61
static array glob(string $pattern, int $flags)

No description

Parameters

string $pattern
int $flags

Return Value

array

at line 61
static SplFileInfo[] files(string $directory, bool $hidden = false)

No description

Parameters

string $directory
bool $hidden

Return Value

SplFileInfo[]

at line 61
static SplFileInfo[] allFiles(string $directory, bool $hidden = false)

No description

Parameters

string $directory
bool $hidden

Return Value

SplFileInfo[]

at line 61
static array directories(string $directory)

No description

Parameters

string $directory

Return Value

array

at line 61
static void ensureDirectoryExists(string $path, int $mode = 0755, bool $recursive = true)

No description

Parameters

string $path
int $mode
bool $recursive

Return Value

void

at line 61
static bool makeDirectory(string $path, int $mode = 0755, bool $recursive = false, bool $force = false)

No description

Parameters

string $path
int $mode
bool $recursive
bool $force

Return Value

bool

at line 61
static bool moveDirectory(string $from, string $to, bool $overwrite = false)

No description

Parameters

string $from
string $to
bool $overwrite

Return Value

bool

at line 61
static bool copyDirectory(string $directory, string $destination, int|null $options = null)

No description

Parameters

string $directory
string $destination
int|null $options

Return Value

bool

at line 61
static bool deleteDirectory(string $directory, bool $preserve = false)

No description

Parameters

string $directory
bool $preserve

Return Value

bool

at line 61
static bool deleteDirectories(string $directory)

No description

Parameters

string $directory

Return Value

bool

at line 61
static bool cleanDirectory(string $directory)

No description

Parameters

string $directory

Return Value

bool

at line 61
static Filesystem|mixed when(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description

Parameters

Closure|mixed|null $value
callable|null $callback
callable|null $default

Return Value

Filesystem|mixed

at line 61
static Filesystem|mixed unless(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description

Parameters

Closure|mixed|null $value
callable|null $callback
callable|null $default

Return Value

Filesystem|mixed

at line 61
static void macro(string $name, object|callable $macro)

No description

Parameters

string $name
object|callable $macro

Return Value

void

at line 61
static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 61
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 61
static void flushMacros()

No description

Return Value

void