phpantom_lsp 0.7.0

Fast PHP language server with deep type intelligence. Generics, Laravel, PHPStan annotations. Ready in an instant.
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

//! PHPDoc block parsing.
//!
//! This module extracts type information from PHPDoc comments (`/** ... */`).
//! It is split into focused submodules:
//!
//! # Submodules
//!
//! - `tags`: Core PHPDoc tag extraction (`@return`, `@var`, `@param`,
//!   `@mixin`, `@deprecated`, `@phpstan-assert`, docblock text retrieval,
//!   and type override logic).
//! - `templates`: Template, generics, and type alias tag extraction
//!   (`@template`, `@extends`, `@implements`, `@use`, `@phpstan-type`,
//!   `@phpstan-import-type`, and `class-string<T>` conditional synthesis).
//! - `virtual_members`: Virtual member tag extraction (`@property`,
//!   `@property-read`, `@property-write`, `@method`).
//! - `conditional`: PHPStan conditional return type parsing.
//! - `types`: Type cleaning utilities, split into focused sub-files:
//!   - `type_strings`: Foundational type string manipulation (constants,
//!     splitting, cleaning, stripping, scalar checks, self/static replacement)
//!   - `shapes`: Array shape and object shape parsing

mod conditional;
pub(crate) mod parser;
mod tags;
pub(crate) mod templates;
pub(crate) mod types;
mod virtual_members;

// Type sub-modules — declared here (sibling files to `types.rs`) so
// the Rust module system can find them.  `types.rs` re-exports their
// public items so existing `use …::types::*` call sites keep working.
pub(crate) mod shapes;
pub(crate) mod type_strings;

// ─── Re-exports ─────────────────────────────────────────────────────────────
//
// Everything below was previously a public or crate-visible item in the
// single-file `docblock.rs`.  Re-exporting here keeps all existing call
// sites (`use crate::docblock;` and `use phpantom_lsp::docblock::*;`)
// working without modification.

// Parsed docblock representation
pub use parser::{DocblockInfo, parse_docblock_for_tags};

// Core tags
pub(crate) use tags::is_compatible_refinement_typed;
pub use tags::{
    extract_all_param_tags, extract_all_param_tags_from_info, extract_deprecation_message,
    extract_deprecation_message_from_info, extract_deprecation_with_see,
    extract_deprecation_with_see_from_info, extract_link_urls, extract_link_urls_from_info,
    extract_mixin_tags, extract_mixin_tags_from_info, extract_param_closure_this,
    extract_param_closure_this_from_info, extract_param_description,
    extract_param_description_from_info, extract_param_raw_type, extract_param_raw_type_from_info,
    extract_param_types_positional_from_info, extract_removed_version, extract_return_description,
    extract_return_description_from_info, extract_return_type, extract_return_type_from_info,
    extract_see_references, extract_see_references_from_info, extract_throws_tags,
    extract_throws_tags_from_info, extract_type_assertions, extract_type_assertions_from_info,
    extract_var_type, extract_var_type_from_info, extract_var_type_with_name,
    extract_var_type_with_name_from_info, find_enclosing_return_type, find_inline_var_docblock,
    find_iterable_raw_type_in_source, find_var_raw_type_in_source, get_docblock_info_for_node,
    get_docblock_text_for_node, has_deprecated_tag, has_deprecated_tag_from_info,
    resolve_effective_type_typed, sanitise_and_parse_docblock_type, should_override_type_typed,
};

// Template / generics / type alias tags
pub use templates::{
    extract_generics_tag, extract_generics_tag_from_info, extract_template_param_bindings,
    extract_template_param_bindings_from_info, extract_template_params,
    extract_template_params_from_info, extract_template_params_full,
    extract_template_params_full_from_info, extract_template_params_with_bounds,
    extract_template_params_with_bounds_from_info, extract_type_aliases,
    extract_type_aliases_from_info, synthesize_template_conditional,
    synthesize_template_conditional_from_info,
};

// Virtual member tags
pub use virtual_members::{extract_method_tags, extract_property_tags};

// Conditional return types
pub use conditional::{extract_conditional_return_type, extract_conditional_return_type_from_info};

// Type utilities
pub use types::{
    extract_array_shape_value_type_typed, extract_object_shape_property_type_typed,
    is_object_shape_typed, parse_array_shape_typed, parse_object_shape_typed,
};