mago-project 0.15.0

A crate for representing and analyzing PHP projects. It parses PHP source files into ASTs, resolves names, collects semantic issues, and merges module reflections into a unified project reflection, serving as a core component of the Mago toolchain.
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

use mago_ast::Program;
use mago_interner::ThreadedInterner;
use mago_names::Names;
use mago_php_version::PHPVersion;
use mago_reflection::CodebaseReflection;
use mago_reporting::IssueCollection;
use mago_source::Source;
use mago_walker::MutWalker;
use mago_walker::Walker;

use crate::internal::context::Context;
use crate::internal::walker::building::ModuleBuildingWalker;
use crate::internal::walker::checking::ModuleCheckingWalker;
use crate::internal::walker::reflection::ModuleReflectionWalker;
use crate::module::ModuleBuildOptions;

mod checker;
mod consts;
mod context;
mod reflector;
mod walker;

pub mod populator;

#[inline(always)]
pub fn build(
    interner: &ThreadedInterner,
    version: PHPVersion,
    source: &Source,
    program: &Program,
    names: &Names,
    options: ModuleBuildOptions,
) -> (Option<CodebaseReflection>, IssueCollection) {
    let mut context = Context::new(interner, &version, program, names, source);

    let reflection = match options {
        ModuleBuildOptions { reflect: true, validate: true } => {
            let mut context = Context::new(interner, &version, program, names, source);
            let mut walker = ModuleBuildingWalker::new();
            walker.walk_program(program, &mut context);

            Some(walker.reflection)
        }
        ModuleBuildOptions { reflect: true, validate: false } => {
            let mut context = Context::new(interner, &version, program, names, source);
            let mut walker = ModuleReflectionWalker::new();
            walker.walk_program(program, &mut context);

            Some(walker.reflection)
        }
        ModuleBuildOptions { reflect: false, validate: true } => {
            ModuleCheckingWalker.walk_program(program, &mut context);

            None
        }
        _ => None,
    };

    let issues = context.take_issue_collection();

    (reflection, issues)
}