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
44
45
46

//! Hook action and result types.

use mago_codex::ttype::union::TUnion;

use crate::plugin::error::PluginError;

pub type HookResult<T> = Result<T, PluginError>;

/// Action to take after a hook runs (for statement hooks).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum HookAction {
    #[default]
    Continue,
    Skip,
}

/// Result type for expression hooks that can provide a custom type when skipping.
#[derive(Debug, Clone, PartialEq, Default)]
pub enum ExpressionHookResult {
    /// Continue with normal analysis.
    #[default]
    Continue,
    /// Skip normal analysis (expression type will be `mixed`).
    Skip,
    /// Skip normal analysis and use the provided type.
    SkipWithType(TUnion),
}

impl ExpressionHookResult {
    /// Returns true if this result indicates the hook wants to skip analysis.
    #[inline]
    #[must_use]
    pub fn should_skip(&self) -> bool {
        !matches!(self, ExpressionHookResult::Continue)
    }

    /// Returns the type to use if `SkipWithType`, otherwise `None`.
    #[inline]
    #[must_use]
    pub fn take_type(self) -> Option<TUnion> {
        match self {
            ExpressionHookResult::SkipWithType(ty) => Some(ty),
            _ => None,
        }
    }
}