mago-analyzer 1.47.5

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

//! `strlen()` return type provider.

use mago_codex::ttype::get_literal_int;
use mago_codex::ttype::get_non_negative_int;
use mago_codex::ttype::union::TUnion;

use crate::plugin::context::InvocationInfo;
use crate::plugin::context::ProviderContext;
use crate::plugin::provider::Provider;
use crate::plugin::provider::ProviderMeta;
use crate::plugin::provider::function::FunctionReturnTypeProvider;
use crate::plugin::provider::function::FunctionTarget;

static META: ProviderMeta = ProviderMeta::new(
    "php::string::strlen",
    "strlen",
    "Returns a non-negative integer, or a literal length for literal strings",
);

#[derive(Default)]
pub struct StrlenProvider;

impl Provider for StrlenProvider {
    fn meta() -> &'static ProviderMeta {
        &META
    }
}

impl FunctionReturnTypeProvider for StrlenProvider {
    fn targets() -> FunctionTarget {
        FunctionTarget::Exact(b"strlen")
    }

    fn get_return_type(
        &self,
        context: &ProviderContext<'_, '_, '_>,
        invocation: &InvocationInfo<'_, '_, '_>,
    ) -> Option<TUnion> {
        let string_argument = invocation.get_argument(0, &[b"string"])?;
        let string_argument_type = context.get_expression_type(string_argument)?;
        match string_argument_type.get_single_literal_string_value() {
            Some(string_literal) => Some(get_literal_int(string_literal.len() as i64)),
            None => Some(get_non_negative_int()),
        }
    }
}