mago-analyzer 1.21.1

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

//! Program hooks for intercepting program-level analysis.

use mago_database::file::File;
use mago_syntax::ast::Program;

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

/// Hook trait for intercepting program-level analysis.
///
/// This hook is called before and after analyzing a complete program (file).
/// It receives the source file, full AST, and mutable context, allowing hooks to:
/// - Access file information (id, path, content)
/// - Inspect the entire program structure
/// - Report issues at the program level
/// - Pre-register variables before analysis
/// - Skip analysis entirely
pub trait ProgramHook: Provider {
    /// Called before a program is analyzed.
    ///
    /// Return `HookAction::Continue` to proceed with normal analysis, or
    /// `HookAction::Skip` to skip analysis of this program entirely.
    fn before_program(
        &self,
        _file: &File,
        _program: &Program<'_>,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<HookAction> {
        Ok(HookAction::Continue)
    }

    /// Called after a program has been analyzed.
    fn after_program(
        &self,
        _file: &File,
        _program: &Program<'_>,
        _context: &mut HookContext<'_, '_>,
    ) -> HookResult<()> {
        Ok(())
    }
}