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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! `Psr\Container\ContainerInterface::get()` return type provider.

use mago_codex::ttype::atomic::TAtomic;
use mago_codex::ttype::atomic::object::TObject;
use mago_codex::ttype::atomic::object::named::TNamedObject;
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::method::MethodReturnTypeProvider;
use crate::plugin::provider::method::MethodTarget;

static META: ProviderMeta = ProviderMeta::new(
    "psr::container::get",
    "ContainerInterface::get",
    "Returns the object type matching the class-string argument",
);

// Use wildcard for class since many classes implement ContainerInterface
static TARGETS: [MethodTarget; 1] = [MethodTarget::any_class(b"get")];

/// Provider for the `Psr\Container\ContainerInterface::get()` method.
///
/// When called with a class-string argument like `SomeService::class`,
/// returns the object type of that class instead of `mixed`.
#[derive(Default)]
pub struct ContainerGetProvider;

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

impl MethodReturnTypeProvider for ContainerGetProvider {
    fn targets() -> &'static [MethodTarget] {
        &TARGETS
    }

    fn get_return_type(
        &self,
        context: &ProviderContext<'_, '_, '_>,
        class_name: &[u8],
        _method_name: &[u8],
        invocation: &InvocationInfo<'_, '_, '_>,
    ) -> Option<TUnion> {
        if !context.is_instance_of(class_name, b"Psr\\Container\\ContainerInterface") {
            return None;
        }

        let id_arg = invocation.get_argument(0, &[b"id"])?;
        let id_type = context.get_expression_type(id_arg)?;

        // Extract class-string value (handles SomeClass::class)
        let service_class = id_type.get_single_class_string_value()?;

        // Return object type of that class
        Some(TUnion::from_atomic(TAtomic::Object(TObject::Named(TNamedObject::new(service_class)))))
    }
}