1. class
  2. Hypervel
  3. \
  4. Inertia
  5. \
  6. Inertia

Inertia

class Inertia 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 AlwaysProp
always(mixed $value)

No description

static RedirectResponse
back(int $status = '302', array<string $, string> $headers = '[]', mixed $fallback = 'false')

No description

static void
clearHistory()

No description

static MergeProp
deepMerge(mixed $value)

No description

static DeferProp
defer(callable $callback, string $group = '\'default\'', bool $rescue = 'false')

No description

static void
disableSsr(Closure|bool $condition = 'true')

No description

static void
encryptHistory(bool $encrypt = 'true')

No description

static ResponseFactory
flash(array<string $, UnitEnum $key, mixed $value = 'null')

No description

static void
flushMacros()

No description

static void
flushShared()

No description

static void
flushState()

No description

static void
array()

<string, mixed> pullFlashed(\Hypervel\Http\Request|null $request = 'null')

static mixed
getShared(string|null $key = 'null', mixed $default = 'null')

No description

static string
getVersion()

No description

static void
handleExceptionsUsing(callable $callback)

No description

static bool
hasMacro(string $name)

No description

static Response
location(RedirectResponse|string $url)

No description

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

No description

static MergeProp
merge(mixed $value)

No description

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

No description

static OnceProp
once(callable $value)

No description

static OptionalProp
optional(callable $callback)

No description

static void
preserveFragment()

No description

static Response
render(UnitEnum $component, Arrayable<array<array-key $, ProvidesInertiaProperties $props = '[]')

No description

static void
resolveUrlUsing(Closure|null $urlResolver = 'null')

No description

void
static()

\Hypervel\Inertia\ScrollProp scroll(mixed $value, string $wrapper = '\'data\'', \Hypervel\Inertia\ProvidesScrollMetadata|callable|null $metadata = 'null')

static void
setRootView(string $name)

No description

static void
share(Arrayable<array<array-key $, ProvidesInertiaProperties|string $key, mixed $value = 'null')

No description

static OnceProp
shareOnce(string $key, callable $callback)

No description

static void
transformComponentUsing(Closure|null $componentTransformer = 'null')

No description

static void
version(Closure|string|null $version)

No description

static void
withoutSsr(array<int $, string>|string $paths)

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 51
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 46
static AlwaysProp always(mixed $value)

No description

Parameters

mixed $value

Return Value

AlwaysProp

at line 46
static RedirectResponse back(int $status = '302', array<string $, string> $headers = '[]', mixed $fallback = 'false')

No description

Parameters

int $status
array<string $
string> $headers
mixed $fallback

Return Value

RedirectResponse

at line 46
static void clearHistory()

No description

Return Value

void

at line 46
static MergeProp deepMerge(mixed $value)

No description

Parameters

mixed $value

Return Value

MergeProp

at line 46
static DeferProp defer(callable $callback, string $group = '\'default\'', bool $rescue = 'false')

No description

Parameters

callable $callback
string $group
bool $rescue

Return Value

DeferProp

at line 46
static void disableSsr(Closure|bool $condition = 'true')

No description

Parameters

Closure|bool $condition

Return Value

void

at line 46
static void encryptHistory(bool $encrypt = 'true')

No description

Parameters

bool $encrypt

Return Value

void

at line 46
static ResponseFactory flash(array<string $, UnitEnum $key, mixed $value = 'null')

No description

Parameters

array<string $
UnitEnum $key
mixed $value

Return Value

ResponseFactory

at line 46
static void flushMacros()

No description

Return Value

void

at line 46
static void flushShared()

No description

Return Value

void

at line 46
static void flushState()

No description

Return Value

void

at line 46
static void array()

<string, mixed> pullFlashed(\Hypervel\Http\Request|null $request = 'null')

Return Value

void

at line 46
static mixed getShared(string|null $key = 'null', mixed $default = 'null')

No description

Parameters

string|null $key
mixed $default

Return Value

mixed

at line 46
static string getVersion()

No description

Return Value

string

at line 46
static void handleExceptionsUsing(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 46
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 46
static Response location(RedirectResponse|string $url)

No description

Parameters

RedirectResponse|string $url

Return Value

Response

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 46
static MergeProp merge(mixed $value)

No description

Parameters

mixed $value

Return Value

MergeProp

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 46
static OnceProp once(callable $value)

No description

Parameters

callable $value

Return Value

OnceProp

at line 46
static OptionalProp optional(callable $callback)

No description

Parameters

callable $callback

Return Value

OptionalProp

at line 46
static void preserveFragment()

No description

Return Value

void

at line 46
static Response render(UnitEnum $component, Arrayable<array<array-key $, ProvidesInertiaProperties $props = '[]')

No description

Parameters

UnitEnum $component
Arrayable<array<array-key $
ProvidesInertiaProperties $props

Return Value

Response

at line 46
static void resolveUrlUsing(Closure|null $urlResolver = 'null')

No description

Parameters

Closure|null $urlResolver

Return Value

void

at line 46
void static()

\Hypervel\Inertia\ScrollProp scroll(mixed $value, string $wrapper = '\'data\'', \Hypervel\Inertia\ProvidesScrollMetadata|callable|null $metadata = 'null')

Return Value

void

at line 46
static void setRootView(string $name)

No description

Parameters

string $name

Return Value

void

at line 46
static void share(Arrayable<array<array-key $, ProvidesInertiaProperties|string $key, mixed $value = 'null')

No description

Parameters

Arrayable<array<array-key $
ProvidesInertiaProperties|string $key
mixed $value

Return Value

void

at line 46
static OnceProp shareOnce(string $key, callable $callback)

No description

Parameters

string $key
callable $callback

Return Value

OnceProp

at line 46
static void transformComponentUsing(Closure|null $componentTransformer = 'null')

No description

Parameters

Closure|null $componentTransformer

Return Value

void

at line 46
static void version(Closure|string|null $version)

No description

Parameters

Closure|string|null $version

Return Value

void

at line 46
static void withoutSsr(array<int $, string>|string $paths)

No description

Parameters

array<int $
string>|string $paths

Return Value

void