Struct PropertyHookMetadata 

#[non_exhaustive]
pub struct PropertyHookMetadata {
    pub name: Atom,
    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: Atom

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 new(name: Atom, span: Span) -> Self

Creates a new PropertyHookMetadata with the given name and span.

pub fn is_get(&self) -> bool

Returns whether this is a get hook.

pub fn is_set(&self) -> bool

Returns whether this is a set hook.

pub fn with_flags(self, flags: MetadataFlags) -> Self

Sets the flags for this hook.

pub fn with_parameter( self, parameter: Option<FunctionLikeParameterMetadata>, ) -> Self

Sets the parameter for this hook (for set hooks).

pub fn with_returns_by_ref(self, returns_by_ref: bool) -> Self

Sets whether the hook returns by reference.

pub fn with_is_abstract(self, is_abstract: bool) -> Self

Sets whether this is an abstract hook.

pub fn with_attributes(self, attributes: Vec<AttributeMetadata>) -> Self

Sets the attributes for this hook.

pub fn with_return_type_metadata( self, return_type_metadata: Option<TypeMetadata>, ) -> Self

Sets the return type metadata from docblock (for get hooks).

pub fn with_has_docblock(self, has_docblock: bool) -> Self

Sets whether this hook has a docblock.

pub fn with_issues(self, issues: Vec<Issue>) -> Self

Sets the issues from parsing the docblock.

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<'de> Deserialize<'de> for PropertyHookMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PropertyHookMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PropertyHookMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PropertyHookMetadata

impl StructuralPartialEq for PropertyHookMetadata