mago-analyzer 1.10.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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use mago_codex::ttype::get_mixed;
use mago_codex::ttype::get_string;
use mago_span::HasSpan;
use mago_span::Span;
use mago_syntax::ast::Expression;
use mago_syntax::ast::IncludeConstruct;
use mago_syntax::ast::IncludeOnceConstruct;
use mago_syntax::ast::RequireConstruct;
use mago_syntax::ast::RequireOnceConstruct;

use crate::analyzable::Analyzable;
use crate::artifacts::AnalysisArtifacts;
use crate::common::construct::ConstructInput;
use crate::common::construct::analyze_construct_inputs;
use crate::context::Context;
use crate::context::block::BlockContext;
use crate::error::AnalysisError;

impl<'ast, 'arena> Analyzable<'ast, 'arena> for IncludeConstruct<'arena> {
    fn analyze<'ctx>(
        &'ast self,
        context: &mut Context<'ctx, 'arena>,
        block_context: &mut BlockContext<'ctx>,
        artifacts: &mut AnalysisArtifacts,
    ) -> Result<(), AnalysisError> {
        analyze_include(
            context,
            block_context,
            artifacts,
            self.span(),
            self.include.span,
            self.value,
            true,  // is_include
            false, // is_once
        )
    }
}

impl<'ast, 'arena> Analyzable<'ast, 'arena> for IncludeOnceConstruct<'arena> {
    fn analyze<'ctx>(
        &'ast self,
        context: &mut Context<'ctx, 'arena>,
        block_context: &mut BlockContext<'ctx>,
        artifacts: &mut AnalysisArtifacts,
    ) -> Result<(), AnalysisError> {
        analyze_include(
            context,
            block_context,
            artifacts,
            self.span(),
            self.include_once.span,
            self.value,
            true, // is_include
            true, // is_once
        )
    }
}

impl<'ast, 'arena> Analyzable<'ast, 'arena> for RequireConstruct<'arena> {
    fn analyze<'ctx>(
        &'ast self,
        context: &mut Context<'ctx, 'arena>,
        block_context: &mut BlockContext<'ctx>,
        artifacts: &mut AnalysisArtifacts,
    ) -> Result<(), AnalysisError> {
        analyze_include(
            context,
            block_context,
            artifacts,
            self.span(),
            self.require.span,
            self.value,
            false, // is_include
            false, // is_once
        )
    }
}

impl<'ast, 'arena> Analyzable<'ast, 'arena> for RequireOnceConstruct<'arena> {
    fn analyze<'ctx>(
        &'ast self,
        context: &mut Context<'ctx, 'arena>,
        block_context: &mut BlockContext<'ctx>,
        artifacts: &mut AnalysisArtifacts,
    ) -> Result<(), AnalysisError> {
        analyze_include(
            context,
            block_context,
            artifacts,
            self.span(),
            self.require_once.span,
            self.value,
            false, // is_include
            true,  // is_once
        )
    }
}

fn analyze_include<'ctx, 'arena>(
    context: &mut Context<'ctx, 'arena>,
    block_context: &mut BlockContext<'ctx>,
    artifacts: &mut AnalysisArtifacts,
    construct_span: Span,
    keyword_span: Span,
    included_file: &Expression<'arena>,
    is_include: bool,
    is_once: bool,
) -> Result<(), AnalysisError> {
    let was_inside_call = block_context.flags.inside_call();
    block_context.flags.set_inside_call(true);
    included_file.analyze(context, block_context, artifacts)?;
    block_context.flags.set_inside_call(was_inside_call);

    let construct_kind = if is_include {
        if is_once { "include_once" } else { "include" }
    } else if is_once {
        "require_once"
    } else {
        "require"
    };

    analyze_construct_inputs(
        context,
        block_context,
        artifacts,
        construct_kind,
        keyword_span,
        ConstructInput::Expression(included_file),
        &get_string(),
        false,
        false,
        true,
    )?;

    artifacts.set_expression_type(&construct_span, get_mixed());

    Ok(())
}