mago-reflection 0.26.1

Offers data structures and APIs to represent and inspect PHP code elements—like classes, functions, and interfaces—enabling introspection and analysis.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

use serde::Deserialize;
use serde::Serialize;

use mago_source::HasSource;
use mago_source::SourceIdentifier;
use mago_span::HasSpan;
use mago_span::Span;

use crate::r#type::kind::TypeKind;

pub mod kind;

/// Represents a reflection of a type in the codebase.
///
/// This structure provides metadata about a type, including its kind (e.g., string, integer),
/// whether it was inferred, and its location in the source code.
#[derive(Debug, Clone, Eq, PartialEq, Hash, Serialize, Deserialize, PartialOrd, Ord)]
pub struct TypeReflection {
    /// The kind of the type (e.g., string, integer).
    pub kind: TypeKind,

    /// Whether the type was inferred or explicitly declared.
    pub inferred: bool,

    /// The span of the type in the source code.
    pub span: Span,
}

impl HasSpan for TypeReflection {
    /// Returns the span of the type in the source code.
    ///
    /// The span identifies the precise location of the type definition or usage
    /// within the source file.
    fn span(&self) -> Span {
        self.span
    }
}

impl HasSource for TypeReflection {
    /// Returns the source identifier of the file containing this type.
    ///
    /// The source identifier provides metadata about the origin of the file,
    /// such as whether it is user-defined, vendor-provided, or built-in.
    fn source(&self) -> SourceIdentifier {
        self.span.source()
    }
}