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

File

class File extends Facade

Properties

static protected Container|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|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|null $name = null)

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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|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 void
replace(string $path, string $content, int|null $mode = null)

Write the contents of a file, replacing it atomically if it already exists.

static array
allDirectories(array|string $directory)

No description

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

No description

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

No description

static string
basename(string $path)

No description

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

No description

static bool
cleanDirectory(string $directory)

No description

static void
clearStatCache(string $path)

No description

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

No description

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

No description

static bool
delete(array|string $paths)

No description

static bool
deleteDirectories(string $directory)

No description

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

No description

static array
directories(array|string $directory, array|string|int $depth = '0')

No description

static string
dirname(string $path)

No description

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

No description

static bool
exists(string $path)

No description

static string
extension(string $path)

No description

static SplFileInfo[]
files(array|string $directory, bool $hidden = 'false', array|string|int $depth = '0')

No description

static void
flushMacros()

No description

static void
flushState()

No description

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

No description

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

No description

static array|false
glob(string $pattern, int $flags = '0')

No description

static string|null
guessExtension(string $path)

No description

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

No description

static bool
hasMacro(string $name)

No description

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

No description

static bool
isDirectory(string $directory)

No description

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

No description

static bool
isFile(string $file)

No description

static bool
isReadable(string $path)

No description

static bool
isWritable(string $path)

No description

static mixed
json(string $path, int $flags = '0', bool $lock = 'false')

No description

static int|false
lastModified(string $path)

No description

static LazyCollection
lines(string $path)

No description

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

No description

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

No description

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

No description

static string|false
mimeType(string $path)

No description

static bool
missing(string $path)

No description

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

No description

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

No description

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

No description

static string
name(string $path)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static string
sharedGet(string $path)

No description

static int|false
size(string $path)

No description

static string|false
type(string $path)

No description

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

No description

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

No description

Details

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

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 81
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 99
static MockInterface partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 115
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 131
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 206
static bool isFake()

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

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 80
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 256
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 267
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 335
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 346
static void setFacadeApplication(Container|null $app)

Set the application instance.

Boot or tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

in Facade at line 356
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 72
static void replace(string $path, string $content, int|null $mode = null)

Write the contents of a file, replacing it atomically if it already exists.

Parameters

string $path
string $content
int|null $mode

Return Value

void

at line 67
static array allDirectories(array|string $directory)

No description

Parameters

array|string $directory

Return Value

array

at line 67
static SplFileInfo[] allFiles(array|string $directory, bool $hidden = 'false')

No description

Parameters

array|string $directory
bool $hidden

Return Value

SplFileInfo[]

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

No description

Parameters

string $path
string $data
bool $lock

Return Value

int|false

at line 67
static string basename(string $path)

No description

Parameters

string $path

Return Value

string

at line 67
static string|bool chmod(string $path, int|null $mode = 'null')

No description

Parameters

string $path
int|null $mode

Return Value

string|bool

at line 67
static bool cleanDirectory(string $directory)

No description

Parameters

string $directory

Return Value

bool

at line 67
static void clearStatCache(string $path)

No description

Parameters

string $path

Return Value

void

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

No description

Parameters

string $path
string $target

Return Value

bool

at line 67
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 67
static bool delete(array|string $paths)

No description

Parameters

array|string $paths

Return Value

bool

at line 67
static bool deleteDirectories(string $directory)

No description

Parameters

string $directory

Return Value

bool

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

No description

Parameters

string $directory
bool $preserve

Return Value

bool

at line 67
static array directories(array|string $directory, array|string|int $depth = '0')

No description

Parameters

array|string $directory
array|string|int $depth

Return Value

array

at line 67
static string dirname(string $path)

No description

Parameters

string $path

Return Value

string

at line 67
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 67
static bool exists(string $path)

No description

Parameters

string $path

Return Value

bool

at line 67
static string extension(string $path)

No description

Parameters

string $path

Return Value

string

at line 67
static SplFileInfo[] files(array|string $directory, bool $hidden = 'false', array|string|int $depth = '0')

No description

Parameters

array|string $directory
bool $hidden
array|string|int $depth

Return Value

SplFileInfo[]

at line 67
static void flushMacros()

No description

Return Value

void

at line 67
static void flushState()

No description

Return Value

void

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

No description

Parameters

string $path
bool $lock

Return Value

string

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

No description

Parameters

string $path
array $data

Return Value

mixed

at line 67
static array|false glob(string $pattern, int $flags = '0')

No description

Parameters

string $pattern
int $flags

Return Value

array|false

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

No description

Parameters

string $path

Return Value

string|null

at line 67
static string|false hash(string $path, string $algorithm = '\'xxh128\'')

No description

Parameters

string $path
string $algorithm

Return Value

string|false

at line 67
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

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

No description

Parameters

string $firstFile
string $secondFile

Return Value

bool

at line 67
static bool isDirectory(string $directory)

No description

Parameters

string $directory

Return Value

bool

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

No description

Parameters

string $directory
bool $ignoreDotFiles

Return Value

bool

at line 67
static bool isFile(string $file)

No description

Parameters

string $file

Return Value

bool

at line 67
static bool isReadable(string $path)

No description

Parameters

string $path

Return Value

bool

at line 67
static bool isWritable(string $path)

No description

Parameters

string $path

Return Value

bool

at line 67
static mixed json(string $path, int $flags = '0', bool $lock = 'false')

No description

Parameters

string $path
int $flags
bool $lock

Return Value

mixed

at line 67
static int|false lastModified(string $path)

No description

Parameters

string $path

Return Value

int|false

at line 67
static LazyCollection lines(string $path)

No description

Parameters

string $path

Return Value

LazyCollection

No description

Parameters

string $target
string $link

Return Value

bool|null

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 67
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 67
static string|false mimeType(string $path)

No description

Parameters

string $path

Return Value

string|false

at line 67
static bool missing(string $path)

No description

Parameters

string $path

Return Value

bool

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

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

No description

Parameters

string $path
string $target

Return Value

bool

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

No description

Parameters

string $from
string $to
bool $overwrite

Return Value

bool

at line 67
static string name(string $path)

No description

Parameters

string $path

Return Value

string

at line 67
static int|false prepend(string $path, string $data)

No description

Parameters

string $path
string $data

Return Value

int|false

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

No description

Parameters

string $path
resource|string $contents
bool $lock

Return Value

int|false

No description

Parameters

string $target
string $link

Return Value

void

at line 67
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 67
static mixed requireOnce(string $path, array $data = '[]')

No description

Parameters

string $path
array $data

Return Value

mixed

at line 67
static string sharedGet(string $path)

No description

Parameters

string $path

Return Value

string

at line 67
static int|false size(string $path)

No description

Parameters

string $path

Return Value

int|false

at line 67
static string|false type(string $path)

No description

Parameters

string $path

Return Value

string|false

at line 67
static mixed unless(mixed $value = 'null', null|callable $callback = 'null', null|callable $default = 'null')

No description

Parameters

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

Return Value

mixed

at line 67
static mixed when(mixed $value = 'null', null|callable $callback = 'null', null|callable $default = 'null')

No description

Parameters

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

Return Value

mixed