classModelMetadata

packages/sql-catalog/src/Extension/Laravel/ModelMetadata.php:18

final class ModelMetadata

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Reads source-declared model metadata without loading model or framework code.

Constants§

public const MODEL = 'Illuminate\Database\Eloquent\Model'

source §

The framework contract identified by model.

public const BUILDER = 'Illuminate\Database\Eloquent\Builder'

source §

The framework contract identified by builder.

public const SOFT_DELETES = 'Illuminate\Database\Eloquent\SoftDeletes'

source §

The framework contract identified by soft_deletes.

Methods§

public function __construct(private ProgramIndex $index)

source §

Configures the source metadata and SQL grammar used by this model.

Parameters

$index ProgramIndex

public function state(string $className, ?string $dialect): QueryState

source §

The model's explicit defaults and known framework effects.

Parameters

`$className`	`string`
`$dialect`	`?string`

Returns

QueryState

Test cases 4

Called from 1

method-call SqlCatalog\Extension\Laravel\BuilderCalls::staticCall() packages/sql-catalog/src/Extension/Laravel/BuilderCalls.php:89

Calls 10

method-call ModelMetadata::property() line 47
method-call ModelMetadata::conventionalTable() line 48
new QueryState line 50
function-call is_string line 51
static-call Domain::literal() line 51
static-call Domain::unknown() line 51
method-call ProgramIndex::isInstanceOf() line 59
class-const ModelMetadata::SOFT_DELETES() line 59
method-call ModelMetadata::constant() line 60
method-call ModelMetadata::guard() line 64

public function guard(string $className, QueryState $state): QueryState

source §

Model hooks and custom builders cannot be silently treated as standard behavior.

Parameters

`$className`	`string`
`$state`	`QueryState`

Returns

QueryState

Test cases 1

ModelMetadataTest::testGuardLeavesHooksTraitsAndMutableMetadataOpen calls

Called from 1

method-call SqlCatalog\Extension\Laravel\ModelMetadata::state() packages/sql-catalog/src/Extension/Laravel/ModelMetadata.php:64

Calls 5

method-call ProgramIndex::lineage() line 72
method-call ModelMetadata::guardDefaults() line 76
function-call str_starts_with line 77
function-call in_array line 81
class-const ModelMetadata::SOFT_DELETES() line 81

public function guardDefaults(ClassShape $shape, QueryState $state): QueryState

source §

Rejects unresolved defaults and implicit additional queries.

Parameters

`$shape`	`ClassShape`
`$state`	`QueryState`

Returns

QueryState

Test cases 1

ModelMetadataTest::testGuardDefaultsRejectsUnknownMetadataAndImplicitEagerLoads calls

Called from 1

method-call SqlCatalog\Extension\Laravel\ModelMetadata::guard() packages/sql-catalog/src/Extension/Laravel/ModelMetadata.php:76

Calls 5

method-call ConstExprEvaluator::evaluateDirectly() line 111
new ConstExprEvaluator line 111
function-call in_array line 112
function-call is_scalar line 114
method-call ModelMetadata::scalar() line 121

public function recognizes(?string $className): bool

source §

Framework model ancestors identifiable even when vendor files are excluded.

Parameters

$className ?string

Returns

bool

Test cases 1

ModelMetadataTest::testRecognizesFrameworkAuthenticationModelsWithoutLoadingVendorCode calls

Called from 3

Calls 2

class-const ModelMetadata::MODEL() line 133
method-call ProgramIndex::isInstanceOf() line 134

public function property(string $className, string $property): string|int|float|bool|null

source §

A scalar property default, searching the model before its ancestors.

Parameters

`$className`	`string`
`$property`	`string`

Returns

string|int|float|bool|null

Test cases 1

ModelMetadataTest::testPropertyPrefersTheNearestDeclaration calls

Called from 5

Calls 2

method-call ProgramIndex::lineage() line 147
method-call ModelMetadata::scalar() line 149

public function constant(string $className, string $constant): string|int|float|bool|null

source §

A scalar model constant, such as DELETED_AT.

Parameters

`$className`	`string`
`$constant`	`string`

Returns

string|int|float|bool|null

Test cases 1

ModelMetadataTest::testConstantReadsOnlyLiteralDefaults calls

Called from 1

method-call SqlCatalog\Extension\Laravel\ModelMetadata::state() packages/sql-catalog/src/Extension/Laravel/ModelMetadata.php:60

Calls 2

method-call ProgramIndex::findClassConstant() line 161
method-call ModelMetadata::scalar() line 163

public function scalar(Expr $expression): string|int|float|bool|null

source §

A literal default; arbitrary expressions are left unresolved.

Parameters

$expression Expr

Returns

string|int|float|bool|null

Test cases 1

ModelMetadataTest::testScalarDoesNotEvaluateApplicationCalls calls

Called from 3

Calls 3

method-call ConstExprEvaluator::evaluateDirectly() line 172
new ConstExprEvaluator line 172
function-call is_scalar line 174

public function conventionalTable(string $className): ?string

source §

Common unambiguous English conventions; other inflections require an explicit table.

Parameters

$className string

Returns

?string

Test cases 1

ModelMetadataTest::testConventionalTableUsesKnownEnglishNamesAndRequiresExplicitOtherInflections calls

Called from 1

method-call SqlCatalog\Extension\Laravel\ModelMetadata::state() packages/sql-catalog/src/Extension/Laravel/ModelMetadata.php:48

Calls 5

function-call explode line 185
function-call end line 186
function-call strtolower line 187
function-call preg_replace line 187
function-call in_array line 192

Private surface 1§

Implementation details, listed for orientation only.

private ProgramIndex $index

Test cases 16§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 11

Other tests reaching this symbol 5

Relations§

Instantiated in 4

Method calls 4

Constant reads 5