1. class
  2. Hypervel
  3. \
  4. PHPStan
  5. \
  6. Reflection
  7. \
  8. NamedScopeMethodReflection

NamedScopeMethodReflection

class NamedScopeMethodReflection implements MethodReflection

Describe a model scope as invoked through an Eloquent receiver.

Relation scopes run on the relation's query but return the relation when the result is that query, matching ForwardsCalls::forwardDecoratedCallTo().

Methods

__construct(ClassReflection $declaringClass, ClassReflection $modelClass, MethodReflection $scopeMethod, string $methodName, Type $receiverType, Type $queryType, bool $static)

Create a named scope method reflection.

string
getName()

Return the exposed scope name.

ClassReflection
getDeclaringClass()

Return the declaring class.

bool
isStatic()

Determine whether the exposed scope is static.

bool
isPrivate()

Determine whether the exposed scope is private.

bool
isPublic()

Determine whether the exposed scope is public.

string|null
getDocComment()

Return no docblock for the synthesized signature.

ClassMemberReflection
getPrototype()

Return the method prototype.

array
getVariants()

Return scope variants without the engine-supplied builder parameter.

TrinaryLogic
isDeprecated()

Determine whether the method is deprecated.

string|null
getDeprecatedDescription()

Return the deprecation description.

TrinaryLogic
isFinal()

Determine whether the method is final.

TrinaryLogic
isInternal()

Determine whether the method is internal.

Type|null
getThrowType()

Return the declared throw type.

TrinaryLogic
hasSideEffects()

Determine whether the method has side effects.

Details

at line 32
__construct(ClassReflection $declaringClass, ClassReflection $modelClass, MethodReflection $scopeMethod, string $methodName, Type $receiverType, Type $queryType, bool $static)

Create a named scope method reflection.

Parameters

ClassReflection $declaringClass
ClassReflection $modelClass
MethodReflection $scopeMethod
string $methodName
Type $receiverType
Type $queryType
bool $static

at line 46
string getName()

Return the exposed scope name.

Return Value

string

at line 54
ClassReflection getDeclaringClass()

Return the declaring class.

Return Value

ClassReflection

at line 62
bool isStatic()

Determine whether the exposed scope is static.

Return Value

bool

at line 70
bool isPrivate()

Determine whether the exposed scope is private.

Return Value

bool

at line 78
bool isPublic()

Determine whether the exposed scope is public.

Return Value

bool

at line 86
string|null getDocComment()

Return no docblock for the synthesized signature.

Return Value

string|null

at line 94
ClassMemberReflection getPrototype()

Return the method prototype.

Return Value

ClassMemberReflection

at line 104
array getVariants()

Return scope variants without the engine-supplied builder parameter.

Return Value

array

at line 128
TrinaryLogic isDeprecated()

Determine whether the method is deprecated.

Return Value

TrinaryLogic

at line 136
string|null getDeprecatedDescription()

Return the deprecation description.

Return Value

string|null

at line 144
TrinaryLogic isFinal()

Determine whether the method is final.

Return Value

TrinaryLogic

at line 152
TrinaryLogic isInternal()

Determine whether the method is internal.

Return Value

TrinaryLogic

at line 160
Type|null getThrowType()

Return the declared throw type.

Return Value

Type|null

at line 168
TrinaryLogic hasSideEffects()

Determine whether the method has side effects.

Return Value

TrinaryLogic