ClassLikeReflection

Struct ClassLikeReflection 

Source
pub struct ClassLikeReflection {
Show 17 fields pub attribute_reflections: Vec<AttributeReflection>, pub name: ClassLikeName, pub inheritance: InheritanceReflection, pub constants: HashMap<StringIdentifier, ClassLikeConstantReflection>, pub cases: HashMap<StringIdentifier, EnumCaseReflection>, pub properties: MemeberCollection<PropertyReflection>, pub methods: MemeberCollection<FunctionLikeReflection>, pub used_traits: HashSet<Name>, pub used_trait_names: HashMap<StringIdentifier, Name>, pub backing_type: Option<TypeReflection>, pub is_final: bool, pub is_readonly: bool, pub is_abstract: bool, pub is_anonymous: bool, pub span: Span, pub is_populated: bool, pub issues: IssueCollection,
}
Expand description

Represents reflection data for a PHP class, interface, enum, or trait.

Fields§

§attribute_reflections: Vec<AttributeReflection>

Attributes (e.g., annotations) associated with the class-like entity.

§name: ClassLikeName

The name of the class-like entity, such as its fully qualified name.

§inheritance: InheritanceReflection

Inheritance information for the class-like entity, including parent classes and implemented interfaces.

§constants: HashMap<StringIdentifier, ClassLikeConstantReflection>

Constants defined in the class-like entity.

§cases: HashMap<StringIdentifier, EnumCaseReflection>

Enum cases defined in the class-like entity, if it is an enum.

§properties: MemeberCollection<PropertyReflection>

Properties defined in the class-like entity.

§methods: MemeberCollection<FunctionLikeReflection>

Methods defined in the class-like entity.

§used_traits: HashSet<Name>

Traits used by the class-like entity.

§used_trait_names: HashMap<StringIdentifier, Name>

Traits used by the class-like entity.

§backing_type: Option<TypeReflection>

The backing type of the entity, used if it is an enum.

§is_final: bool

Whether the class-like entity is declared as final.

§is_readonly: bool

Whether the class-like entity is declared as readonly.

§is_abstract: bool

Whether the class-like entity is declared as abstract.

§is_anonymous: bool

Whether the entity is an anonymous class.

§span: Span

The span in the source code where the class-like entity is declared.

§is_populated: bool

Indicates whether the reflection is fully populated with all metadata.

§issues: IssueCollection

Issues encountered while processing the class-like entity.

Implementations§

Source§

impl ClassLikeReflection

Source

pub fn new(name: ClassLikeName, span: Span) -> Self

Source

pub const fn is_trait(&self) -> bool

Checks if this class-like entity is a trait.

Source

pub const fn is_interface(&self) -> bool

Checks if this class-like entity is an interface.

Source

pub const fn is_class(&self) -> bool

Checks if this class-like entity is a class.

Source

pub const fn is_enum(&self) -> bool

Checks if this class-like entity is an enum.

Source

pub const fn is_anonymous_class(&self) -> bool

Checks if this class-like entity is a trait.

Trait Implementations§

Source§

impl Clone for ClassLikeReflection

Source§

fn clone(&self) -> ClassLikeReflection

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ClassLikeReflection

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ClassLikeReflection

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl HasSource for ClassLikeReflection

Source§

fn source(&self) -> SourceIdentifier

Returns the source identifier of the file containing this class-like entity.

The source identifier provides metadata about the origin of the entity, such as whether it is user-defined, vendor-provided, or built-in.

Source§

impl HasSpan for ClassLikeReflection

Source§

fn span(&self) -> Span

Returns the span of the class-like entity in the source code.

The span covers the entire declaration of the entity, including its attributes, inheritance, and body.

Source§

fn start_position(&self) -> Position

Source§

fn end_position(&self) -> Position

Source§

impl PartialEq for ClassLikeReflection

Source§

fn eq(&self, other: &ClassLikeReflection) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Reflection for ClassLikeReflection

Source§

fn get_category(&self) -> SourceCategory

Returns the source category of the class-like entity.

The category indicates whether the entity is part of the project (UserDefined), vendor-provided (Vendor), or built-in (BuiltIn).

Source§

fn is_populated(&self) -> bool

Indicates whether the class-like entity’s reflection data is fully populated.

If is_populated is false, additional processing may be required to resolve all metadata for this entity.

Source§

fn take_issues(&mut self) -> IssueCollection

Take any issues found during the population of the reflection. Read more
Source§

fn is_user_defined(&self) -> bool

Indicates whether the entity is user-defined or part of the current project. Read more
Source§

fn is_external(&self) -> bool

Indicates whether the entity originates from an external source (e.g., vendor libraries). Read more
Source§

fn is_built_in(&self) -> bool

Indicates whether the entity is a built-in PHP construct. Read more
Source§

impl Serialize for ClassLikeReflection

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ClassLikeReflection

Source§

impl StructuralPartialEq for ClassLikeReflection

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> HasPosition for T
where T: HasSpan,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,