Struct PropertyHookMetadata 

#[non_exhaustive]
pub struct PropertyHookMetadata {
    pub name: Word,
    pub span: Span,
    pub flags: MetadataFlags,
    pub parameter: Option<FunctionLikeParameterMetadata>,
    pub returns_by_ref: bool,
    pub is_abstract: bool,
    pub attributes: Vec<AttributeMetadata>,
    pub return_type_metadata: Option<TypeMetadata>,
    pub has_docblock: bool,
    pub issues: Vec<Issue>,
}

Metadata for a property hook (get or set).

PHP 8.4 introduced property hooks, which allow defining custom get/set behavior for properties. This struct stores the metadata for a single hook.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Word

The hook name (“get” or “set”).

span: Span

Span of the hook declaration.

flags: MetadataFlags

Hook modifiers (final, etc.).

parameter: Option<FunctionLikeParameterMetadata>

For set hooks: the parameter (explicit or implicit $value). None for get hooks.

returns_by_ref: bool

Whether the hook returns by reference (&get).

is_abstract: bool

Whether this is an abstract hook (no body, just semicolon).

attributes: Vec<AttributeMetadata>

Attributes on the hook.

return_type_metadata: Option<TypeMetadata>

Return type from @return docblock (for get hooks).

has_docblock: bool

Whether this hook has a docblock comment.

issues: Vec<Issue>

Issues from parsing the docblock.

Implementations

impl PropertyHookMetadata

pub fn is_get(&self) -> bool

Returns whether this is a get hook.

pub fn take_issues(&mut self) -> Vec<Issue>

Takes the issues, leaving an empty vector.

Trait Implementations

impl Clone for PropertyHookMetadata

fn clone(&self) -> PropertyHookMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PropertyHookMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for PropertyHookMetadata

impl PartialEq for PropertyHookMetadata

fn eq(&self, other: &PropertyHookMetadata) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PropertyHookMetadata