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

use mago_span::HasSpan;
use mago_syntax::ast::For;

use crate::analyzable::Analyzable;
use crate::artifacts::AnalysisArtifacts;
use crate::context::Context;
use crate::context::block::BlockContext;
use crate::error::AnalysisError;
use crate::statement::r#loop;

impl<'ast, 'arena> Analyzable<'ast, 'arena> for For<'arena> {
    fn analyze<'ctx>(
        &'ast self,
        context: &mut Context<'ctx, 'arena>,
        block_context: &mut BlockContext<'ctx>,
        artifacts: &mut AnalysisArtifacts,
    ) -> Result<(), AnalysisError> {
        let infinite_loop = self.initializations.is_empty() && self.conditions.is_empty() && self.increments.is_empty();

        r#loop::analyze_for_or_while_loop(
            context,
            block_context,
            artifacts,
            self.initializations.as_slice(),
            self.conditions.as_slice(),
            self.increments.as_slice(),
            self.body.statements(),
            self.span(),
            infinite_loop,
        )
    }
}

#[cfg(test)]
mod tests {
    use indoc::indoc;

    use crate::test_analysis;

    test_analysis! {
        name = for_loop_is_entered_al_least_once,
        code = indoc! {r"
            <?php

            /**
             * @template T
             *
             * @param int<1, max> $size
             * @param (Closure(int): T) $factory
             *
             * @return non-empty-list<T>
             */
            function reproduce(int $size, Closure $factory): array {
                $result = [];
                for ($i = 1; $i <= $size; $i++) {
                    $result[] = $factory($i);
                }

                return $result;
            }
        "},
    }
}