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

//! Method return type provider trait.

use mago_atom::Atom;
use mago_atom::ascii_lowercase_atom;
use mago_atom::concat_atom;
use mago_atom::starts_with_ignore_case;
use mago_codex::ttype::union::TUnion;

use crate::plugin::context::InvocationInfo;
use crate::plugin::context::ProviderContext;
use crate::plugin::provider::Provider;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct MethodTarget {
    pub class: &'static str,
    pub method: &'static str,
}

impl MethodTarget {
    #[inline]
    #[must_use]
    pub const fn exact(class: &'static str, method: &'static str) -> Self {
        Self { class, method }
    }

    #[inline]
    #[must_use]
    pub const fn all_methods(class: &'static str) -> Self {
        Self { class, method: "*" }
    }

    #[inline]
    #[must_use]
    pub const fn any_class(method: &'static str) -> Self {
        Self { class: "*", method }
    }

    #[must_use]
    pub fn matches(&self, class_name: &str, method_name: &str) -> bool {
        self.matches_class(class_name) && self.matches_method(method_name)
    }

    fn matches_class(&self, class_name: &str) -> bool {
        if self.class == "*" {
            return true;
        }

        if self.class.ends_with('*') {
            starts_with_ignore_case(class_name, &self.class[..self.class.len() - 1])
        } else {
            class_name.eq_ignore_ascii_case(self.class)
        }
    }

    fn matches_method(&self, method_name: &str) -> bool {
        if self.method == "*" {
            return true;
        }

        if self.method.ends_with('*') {
            starts_with_ignore_case(method_name, &self.method[..self.method.len() - 1])
        } else {
            method_name.eq_ignore_ascii_case(self.method)
        }
    }

    #[must_use]
    pub fn is_exact(&self) -> bool {
        !self.class.contains('*') && !self.method.contains('*')
    }

    #[must_use]
    pub fn index_key(&self) -> Option<Atom> {
        if self.is_exact() {
            Some(concat_atom!(
                ascii_lowercase_atom(self.class).as_str(),
                "::",
                ascii_lowercase_atom(self.method).as_str()
            ))
        } else {
            None
        }
    }
}

pub trait MethodReturnTypeProvider: Provider {
    fn targets() -> &'static [MethodTarget]
    where
        Self: Sized;

    fn get_return_type(
        &self,
        context: &ProviderContext<'_, '_, '_>,
        class_name: &str,
        method_name: &str,
        invocation: &InvocationInfo<'_, '_, '_>,
    ) -> Option<TUnion>;
}