mago-codex 1.15.2

PHP type system representation, comparison logic, and codebase metadata for static analysis.
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

use serde::Deserialize;
use serde::Serialize;

use mago_atom::Atom;

/// Represents a unique identifier for a method within a class-like structure.
/// Combines the fully qualified class name (FQCN) and the method name.
#[derive(Clone, Debug, PartialEq, Eq, Copy, Serialize, Deserialize, Hash, PartialOrd, Ord)]
pub struct MethodIdentifier {
    /// The fully qualified name of the class, interface, trait, or enum containing the method.
    class_name: Atom,
    /// The name of the method itself.
    method_name: Atom,
}

impl MethodIdentifier {
    /// Creates a new `MethodIdentifier`.
    ///
    /// # Arguments
    ///
    /// * `class_name`: The `Atom` for the fully qualified class name.
    /// * `method_name`: The `Atom` for the method name.
    #[inline]
    #[must_use]
    pub const fn new(class_name: Atom, method_name: Atom) -> Self {
        Self { class_name, method_name }
    }

    /// Returns the `Atom` for the class name.
    #[inline]
    #[must_use]
    pub const fn get_class_name(&self) -> Atom {
        self.class_name
    }

    /// Returns the `Atom` for the method name.
    #[inline]
    #[must_use]
    pub const fn get_method_name(&self) -> Atom {
        self.method_name
    }

    /// Converts the identifier to a human-readable string "`ClassName::methodName`".
    #[inline]
    #[must_use]
    pub fn as_string(&self) -> String {
        format!("{}::{}", self.class_name, self.method_name)
    }

    /// Converts the identifier to a tuple of `Atom`s representing the class name and method name.
    #[inline]
    #[must_use]
    pub fn get_key(&self) -> (Atom, Atom) {
        (self.class_name, self.method_name)
    }
}