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

Schema

class Schema extends Facade

Properties

static protected $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 facade should be cached.

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static 
spy()

Convert the facade into a Mockery spy.

from  Facade
static 
partialMock()

Initiate a partial mock on the facade.

from  Facade
static 
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static 
expects()

Initiate a mock expectation on the facade.

from  Facade
static 
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static 
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 
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 
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(mixed $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

from  Facade
static Builder
connection(string|null $name = null)

Get a schema builder instance for a connection.

static void
defaultStringLength(int $length)

No description

static void
defaultTimePrecision(int|null $precision)

No description

static void
defaultMorphKeyType(string $type)

No description

static void
flushState()

No description

static void
morphUsingUuids()

No description

static void
morphUsingUlids()

No description

static bool
createDatabase(string $name)

No description

static bool
dropDatabaseIfExists(string $name)

No description

static array
getSchemas()

No description

static bool
hasTable(string $table)

No description

static bool
hasView(string $view)

No description

static array
getTables(null|string|string[] $schema = 'null')

No description

static array
getTableListing(array|string|null $schema = 'null', bool $schemaQualified = 'true')

No description

static array
getViews(array|string|null $schema = 'null')

No description

static array
getTypes(array|string|null $schema = 'null')

No description

static bool
hasColumn(string $table, string $column)

No description

static bool
hasColumns(string $table, string[] $columns)

No description

static void
whenTableHasColumn(string $table, string $column, Closure $callback)

No description

static void
whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)

No description

static void
whenTableHasIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

static void
whenTableDoesntHaveIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

static string
getColumnType(string $table, string $column, bool $fullDefinition = 'false')

No description

static array
getColumnListing(string $table)

No description

static array
getColumns(string $table)

No description

static array
getIndexes(string $table)

No description

static array
getIndexListing(string $table)

No description

static bool
hasIndex(string $table, array|string $index, string|null $type = 'null')

No description

static bool
hasForeignKey(string $table, array|string $foreignKey)

No description

static array
getForeignKeys(string $table)

No description

static void
table(string $table, Closure $callback)

No description

static void
create(string $table, Closure $callback)

No description

static void
drop(string $table)

No description

static void
dropIfExists(string $table)

No description

static void
dropColumns(string $table, string[]|string $columns)

No description

static void
dropAllTables()

No description

static void
dropAllViews()

No description

static void
dropAllTypes()

No description

static void
rename(string $from, string $to)

No description

static bool
enableForeignKeyConstraints()

No description

static bool
disableForeignKeyConstraints()

No description

static mixed
withoutForeignKeyConstraints(Closure $callback)

No description

static void
ensureVectorExtensionExists(string|null $schema = 'null')

No description

static void
ensureExtensionExists(string $name, string|null $schema = 'null')

No description

static null|string[]
getCurrentSchemaListing()

No description

static string|null
getCurrentSchemaName()

No description

static array
parseSchemaAndTable(string $reference, string|bool|null $withDefaultSchema = 'null')

No description

static Connection
getConnection()

No description

static void
blueprintResolver(Closure $resolver)

No description

static void
macro(string $name, callable|object $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 55
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 71
static spy()

Convert the facade into a Mockery spy.

in Facade at line 89
static partialMock()

Initiate a partial mock on the facade.

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

in Facade at line 105
static shouldReceive()

Initiate a mock expectation on the facade.

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

in Facade at line 121
static expects()

Initiate a mock expectation on the facade.

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

in Facade at line 135
static protected createFreshMockInstance()

Create a fresh mock instance for the given class.

in Facade at line 147
static protected createMock()

Create a fresh mock instance for the given class.

in Facade at line 157
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 184
static 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

in Facade at line 196
static bool isFake()

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

Return Value

bool

in Facade at line 207
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 81
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 246
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 257
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 265
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 324
static getFacadeApplication()

Get the application instance behind the facade.

in Facade at line 337
static void setFacadeApplication(mixed $app)

Set the application instance.

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

Parameters

mixed $app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Exceptions

RuntimeException

at line 73
static Builder connection(string|null $name = null)

Get a schema builder instance for a connection.

Parameters

string|null $name

Return Value

Builder

at line 63
static void defaultStringLength(int $length)

No description

Parameters

int $length

Return Value

void

at line 63
static void defaultTimePrecision(int|null $precision)

No description

Parameters

int|null $precision

Return Value

void

at line 63
static void defaultMorphKeyType(string $type)

No description

Parameters

string $type

Return Value

void

at line 63
static void flushState()

No description

Return Value

void

at line 63
static void morphUsingUuids()

No description

Return Value

void

at line 63
static void morphUsingUlids()

No description

Return Value

void

at line 63
static bool createDatabase(string $name)

No description

Parameters

string $name

Return Value

bool

at line 63
static bool dropDatabaseIfExists(string $name)

No description

Parameters

string $name

Return Value

bool

at line 63
static array getSchemas()

No description

Return Value

array

at line 63
static bool hasTable(string $table)

No description

Parameters

string $table

Return Value

bool

at line 63
static bool hasView(string $view)

No description

Parameters

string $view

Return Value

bool

at line 63
static array getTables(null|string|string[] $schema = 'null')

No description

Parameters

null|string|string[] $schema

Return Value

array

at line 63
static array getTableListing(array|string|null $schema = 'null', bool $schemaQualified = 'true')

No description

Parameters

array|string|null $schema
bool $schemaQualified

Return Value

array

at line 63
static array getViews(array|string|null $schema = 'null')

No description

Parameters

array|string|null $schema

Return Value

array

at line 63
static array getTypes(array|string|null $schema = 'null')

No description

Parameters

array|string|null $schema

Return Value

array

at line 63
static bool hasColumn(string $table, string $column)

No description

Parameters

string $table
string $column

Return Value

bool

at line 63
static bool hasColumns(string $table, string[] $columns)

No description

Parameters

string $table
string[] $columns

Return Value

bool

at line 63
static void whenTableHasColumn(string $table, string $column, Closure $callback)

No description

Parameters

string $table
string $column
Closure $callback

Return Value

void

at line 63
static void whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)

No description

Parameters

string $table
string $column
Closure $callback

Return Value

void

at line 63
static void whenTableHasIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

Parameters

string $table
array|string $index
Closure $callback
string|null $type

Return Value

void

at line 63
static void whenTableDoesntHaveIndex(string $table, array|string $index, Closure $callback, string|null $type = 'null')

No description

Parameters

string $table
array|string $index
Closure $callback
string|null $type

Return Value

void

at line 63
static string getColumnType(string $table, string $column, bool $fullDefinition = 'false')

No description

Parameters

string $table
string $column
bool $fullDefinition

Return Value

string

at line 63
static array getColumnListing(string $table)

No description

Parameters

string $table

Return Value

array

at line 63
static array getColumns(string $table)

No description

Parameters

string $table

Return Value

array

at line 63
static array getIndexes(string $table)

No description

Parameters

string $table

Return Value

array

at line 63
static array getIndexListing(string $table)

No description

Parameters

string $table

Return Value

array

at line 63
static bool hasIndex(string $table, array|string $index, string|null $type = 'null')

No description

Parameters

string $table
array|string $index
string|null $type

Return Value

bool

at line 63
static bool hasForeignKey(string $table, array|string $foreignKey)

No description

Parameters

string $table
array|string $foreignKey

Return Value

bool

at line 63
static array getForeignKeys(string $table)

No description

Parameters

string $table

Return Value

array

at line 63
static void table(string $table, Closure $callback)

No description

Parameters

string $table
Closure $callback

Return Value

void

at line 63
static void create(string $table, Closure $callback)

No description

Parameters

string $table
Closure $callback

Return Value

void

at line 63
static void drop(string $table)

No description

Parameters

string $table

Return Value

void

at line 63
static void dropIfExists(string $table)

No description

Parameters

string $table

Return Value

void

at line 63
static void dropColumns(string $table, string[]|string $columns)

No description

Parameters

string $table
string[]|string $columns

Return Value

void

at line 63
static void dropAllTables()

No description

Return Value

void

at line 63
static void dropAllViews()

No description

Return Value

void

at line 63
static void dropAllTypes()

No description

Return Value

void

at line 63
static void rename(string $from, string $to)

No description

Parameters

string $from
string $to

Return Value

void

at line 63
static bool enableForeignKeyConstraints()

No description

Return Value

bool

at line 63
static bool disableForeignKeyConstraints()

No description

Return Value

bool

at line 63
static mixed withoutForeignKeyConstraints(Closure $callback)

No description

Parameters

Closure $callback

Return Value

mixed

at line 63
static void ensureVectorExtensionExists(string|null $schema = 'null')

No description

Parameters

string|null $schema

Return Value

void

at line 63
static void ensureExtensionExists(string $name, string|null $schema = 'null')

No description

Parameters

string $name
string|null $schema

Return Value

void

at line 63
static null|string[] getCurrentSchemaListing()

No description

Return Value

null|string[]

at line 63
static string|null getCurrentSchemaName()

No description

Return Value

string|null

at line 63
static array parseSchemaAndTable(string $reference, string|bool|null $withDefaultSchema = 'null')

No description

Parameters

string $reference
string|bool|null $withDefaultSchema

Return Value

array

at line 63
static Connection getConnection()

No description

Return Value

Connection

at line 63
static void blueprintResolver(Closure $resolver)

No description

Parameters

Closure $resolver

Return Value

void

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

No description

Parameters

string $name
callable|object $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 63
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 63
static void flushMacros()

No description

Return Value

void