mago-analyzer 1.24.0

A PHP static analyzer that can detect type errors in PHP code, and provide suggestions for fixing them.
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

//! Declaration hooks for class and function analysis events.

use mago_codex::metadata::class_like::ClassLikeMetadata;
use mago_codex::metadata::function_like::FunctionLikeMetadata;
use mago_syntax::ast::Class;
use mago_syntax::ast::Enum;
use mago_syntax::ast::Function;
use mago_syntax::ast::Interface;
use mago_syntax::ast::Trait;

use crate::plugin::context::HookContext;
use crate::plugin::hook::HookResult;
use crate::plugin::provider::Provider;

/// Hook trait for intercepting class declaration analysis.
///
/// This hook receives the real AST class node, full class metadata,
/// and mutable context, allowing hooks to inspect classes, report issues,
/// and modify analysis state.
pub trait ClassDeclarationHook: Provider {
    /// Called when entering a class declaration.
    fn on_enter_class(
        &self,
        _class: &Class<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }

    /// Called when leaving a class declaration.
    fn on_leave_class(
        &self,
        _class: &Class<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }
}

/// Hook trait for intercepting interface declaration analysis.
pub trait InterfaceDeclarationHook: Provider {
    /// Called when entering an interface declaration.
    fn on_enter_interface(
        &self,
        _interface: &Interface<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }

    /// Called when leaving an interface declaration.
    fn on_leave_interface(
        &self,
        _interface: &Interface<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }
}

/// Hook trait for intercepting trait declaration analysis.
pub trait TraitDeclarationHook: Provider {
    /// Called when entering a trait declaration.
    fn on_enter_trait(
        &self,
        _trait_: &Trait<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }

    /// Called when leaving a trait declaration.
    fn on_leave_trait(
        &self,
        _trait_: &Trait<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }
}

/// Hook trait for intercepting enum declaration analysis.
pub trait EnumDeclarationHook: Provider {
    /// Called when entering an enum declaration.
    fn on_enter_enum(
        &self,
        _enum_: &Enum<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }

    /// Called when leaving an enum declaration.
    fn on_leave_enum(
        &self,
        _enum_: &Enum<'_>,
        _metadata: &ClassLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }
}

/// Hook trait for intercepting function declaration analysis.
///
/// This hook receives the real AST function node, full function metadata,
/// and mutable context, allowing hooks to inspect functions, report issues,
/// and modify analysis state.
pub trait FunctionDeclarationHook: Provider {
    /// Called when entering a function declaration.
    fn on_enter_function(
        &self,
        _function: &Function<'_>,
        _metadata: &FunctionLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }

    /// Called when leaving a function declaration.
    fn on_leave_function(
        &self,
        _function: &Function<'_>,
        _metadata: &FunctionLikeMetadata,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }
}