1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Eloquent
  7. \
  8. ModelInspector

ModelInspector

class ModelInspector (View source)

Properties

protected Application $app

The Laravel application instance.
protected array<int,string> $relationMethods

The methods that can be called in a model to indicate a relation.

Methods

__construct(Application $app)

Create a new model inspector instance.

inspect(Model>|string $model, string|null $connection = null)

Extract model details for the given model.

Collection<int,array<string,mixed>>
getAttributes(Model $model)

Get the column attributes for the given model.

Collection
getVirtualAttributes(Model $model, array $columns)

Get the virtual (non-column) attributes for the given model.

Collection
getRelations(Model $model)

Get the relations from the given model.

string|null
getPolicy(Model $model)

Get the first policy associated with this model.

Collection
getEvents(Model $model)

Get the events that the model dispatches.

Collection
getObservers(Model $model)

Get the observers watching this model.

Collection>
getCollectedBy(Model $model)

Get the collection class being used by the model.

getBuilder($model)

No description

Model>
qualifyModel(string $model)

Qualify the given model class base name.

string|null
getCastType(string $column, Model $model)

Get the cast type for the given column.

Collection
getCastsWithDates(Model $model)

Get the model casts, including any date casts.

bool
attributeIsHidden(string $attribute, Model $model)

Determine if the given attribute is hidden.

mixed|null
getColumnDefault(array<string,mixed> $column, Model $model)

Get the default value for the given column.

bool
columnIsUnique(string $column, array $indexes)

Determine if the given attribute is unique.

Details

at line 51
__construct(Application $app)

Create a new model inspector instance.

Parameters

Application $app

at line 65
inspect(Model>|string $model, string|null $connection = null)

Extract model details for the given model.

Parameters

Model>|string $model
string|null $connection

Exceptions

BindingResolutionException

at line 96
protected Collection<int,array<string,mixed>> getAttributes(Model $model)

Get the column attributes for the given model.

Parameters

Model $model

Return Value

Collection<int,array<string,mixed>>

at line 127
protected Collection getVirtualAttributes(Model $model, array $columns)

Get the virtual (non-column) attributes for the given model.

Parameters

Model $model
array $columns

Return Value

Collection

at line 168
protected Collection getRelations(Model $model)

Get the relations from the given model.

Parameters

Model $model

Return Value

Collection

at line 218
protected string|null getPolicy(Model $model)

Get the first policy associated with this model.

Parameters

Model $model

Return Value

string|null

at line 231
protected Collection getEvents(Model $model)

Get the events that the model dispatches.

Parameters

Model $model

Return Value

Collection

at line 248
protected Collection getObservers(Model $model)

Get the observers watching this model.

Parameters

Model $model

Return Value

Collection

Exceptions

BindingResolutionException

at line 282
protected Collection> getCollectedBy(Model $model)

Get the collection class being used by the model.

Parameters

Model $model

Return Value

Collection>

at line 295
protected getBuilder($model)

No description

Parameters

$model

at line 308
protected Model> qualifyModel(string $model)

Qualify the given model class base name.

Parameters

string $model

Return Value

Model>

See also

GeneratorCommand

at line 336
protected string|null getCastType(string $column, Model $model)

Get the cast type for the given column.

Parameters

string $column
Model $model

Return Value

string|null

at line 355
protected Collection getCastsWithDates(Model $model)

Get the model casts, including any date casts.

Parameters

Model $model

Return Value

Collection

at line 371
protected bool attributeIsHidden(string $attribute, Model $model)

Determine if the given attribute is hidden.

Parameters

string $attribute
Model $model

Return Value

bool

at line 391
protected mixed|null getColumnDefault(array<string,mixed> $column, Model $model)

Get the default value for the given column.

Parameters

array<string,mixed> $column
Model $model

Return Value

mixed|null

at line 405
protected bool columnIsUnique(string $column, array $indexes)

Determine if the given attribute is unique.

Parameters

string $column
array $indexes

Return Value

bool