php-lsp 0.26.0

A PHP Language Server Protocol implementation
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

//! Fixed facade-name → contract-interface table for the "Convert facade call
//! to dependency injection" quickfix
//! (`src/actions/facade_to_di_action.rs`).
//!
//! Framework-fixed data (every Laravel installation ships the same facade
//! names bound to the same contracts), not something scanned from the user's
//! project — a plain const table, unlike the workspace-scanned
//! `env`/`config`/`route` indexes elsewhere in this module.

/// `(facade short name, contract FQCN, suggested property/param name)`.
/// Covers the facades most commonly called statically from inside a
/// controller/service method — not exhaustive.
pub(crate) const FACADE_CONTRACTS: &[(&str, &str, &str)] = &[
    ("Cache", "Illuminate\\Contracts\\Cache\\Repository", "cache"),
    ("Auth", "Illuminate\\Contracts\\Auth\\Factory", "auth"),
    ("Log", "Psr\\Log\\LoggerInterface", "log"),
    ("DB", "Illuminate\\Database\\ConnectionInterface", "db"),
    (
        "Storage",
        "Illuminate\\Contracts\\Filesystem\\Factory",
        "storage",
    ),
    ("Mail", "Illuminate\\Contracts\\Mail\\Mailer", "mailer"),
    ("Queue", "Illuminate\\Contracts\\Queue\\Queue", "queue"),
    (
        "Event",
        "Illuminate\\Contracts\\Events\\Dispatcher",
        "events",
    ),
    (
        "Session",
        "Illuminate\\Contracts\\Session\\Session",
        "session",
    ),
    (
        "Config",
        "Illuminate\\Contracts\\Config\\Repository",
        "config",
    ),
    (
        "Validator",
        "Illuminate\\Contracts\\Validation\\Factory",
        "validator",
    ),
    ("Redis", "Illuminate\\Redis\\RedisManager", "redis"),
    ("Http", "Illuminate\\Http\\Client\\Factory", "http"),
];

/// The contract FQCN and suggested property name for `facade_name`, if it's
/// one of the known facades above (exact-case match — real code always
/// calls these in their canonical PascalCase form).
pub(crate) fn lookup(facade_name: &str) -> Option<(&'static str, &'static str)> {
    FACADE_CONTRACTS
        .iter()
        .find(|(name, _, _)| *name == facade_name)
        .map(|(_, contract, prop)| (*contract, *prop))
}

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

    #[test]
    fn looks_up_known_facade() {
        assert_eq!(
            lookup("Cache"),
            Some(("Illuminate\\Contracts\\Cache\\Repository", "cache"))
        );
    }

    #[test]
    fn none_for_unknown_name() {
        assert_eq!(lookup("SomeUnrelatedClass"), None);
    }

    #[test]
    fn case_sensitive_no_match_for_lowercase() {
        assert_eq!(lookup("cache"), None);
    }
}