Struct PropertyMetadata

pub struct PropertyMetadata {

    pub name: VariableIdentifier,
    pub name_span: Option<Span>,
    pub span: Option<Span>,
    pub read_visibility: Visibility,
    pub write_visibility: Visibility,
    pub type_declaration_metadata: Option<TypeMetadata>,
    pub type_metadata: Option<TypeMetadata>,
    pub default_type_metadata: Option<TypeMetadata>,
    pub is_readonly: bool,
    pub has_default: bool,
    pub is_promoted: bool,
    pub is_internal: bool,
    pub is_static: bool,
    pub is_abstract: bool,
    pub is_deprecated: bool,
    pub is_virtual: bool,
    pub is_asymmetric: bool,
    pub allow_private_mutation: bool,
}

Contains metadata associated with a declared class property in PHP.

This includes information about its name, location, visibility (potentially asymmetric), type hints, default values, and various modifiers (static, readonly, abstract, etc.).

Fields

name: VariableIdentifier

The identifier (name) of the property, including the leading ‘$’.

name_span: Option<Span>

The specific source code location (span) of the property’s name identifier itself. None if the location is unknown or not relevant (e.g., for synthetic properties).

span: Option<Span>

The source code location (span) covering the entire property declaration statement. None if the location is unknown or not relevant.

read_visibility: Visibility

The visibility level required for reading the property’s value.

In PHP, this corresponds to the primary visibility keyword specified (e.g., the public in public private(set) string $prop;).

If no asymmetric visibility is specified (e.g., public string $prop), this level applies to both reading and writing. Defaults to Public.

write_visibility: Visibility

The visibility level required for writing/modifying the property’s value.

In PHP, this can differ from read_visibility using asymmetric visibility syntax like private(set) (e.g., public private(set) string $prop;).

If asymmetric visibility is not used, this implicitly matches read_visibility. Defaults to Public.

type_declaration_metadata: Option<TypeMetadata>

The explicit type declaration (type hint) associated with the property, if any.

e.g., for public string $name;, this would contain the metadata for string.

type_metadata: Option<TypeMetadata>

The type metadata for the property’s type, if any.

This is either the same as type_declaration_metadata or the type provided in a docblock comment (e.g., @var string).

default_type_metadata: Option<TypeMetadata>

The type inferred from the property’s default value, if it has one.

e.g., for public $count = 0;, this would contain the metadata for int(0). This can be used to compare against type_signature for consistency checks.

is_readonly: bool

true if the property is declared with the readonly modifier.

has_default: bool

true if the property is declared with a default value (e.g., = null, = 10).

is_promoted: bool

true if this property originates from constructor property promotion.

is_internal: bool

true if the property is marked as internal, typically via a docblock tag like @internal.

Indicates it’s not intended for use outside the defining class or library.

is_static: bool

true if the property is declared with the static modifier.

is_abstract: bool

true if this property represents an abstract property requirement.

is_deprecated: bool

true if the property is marked as deprecated, typically via @deprecated docblock tag.

is_virtual: bool

true if the property uses PHP’s Property Hooks feature.

Such properties have custom get and/or set logic instead of direct storage, making them behave like “virtual” properties.

Note: Properties with hooks cannot have asymmetric visibility (is_asymmetric must be false).

is_asymmetric: bool

true if read_visibility and write_visibility are different,

indicating that PHP’s asymmetric visibility syntax (e.g., public private(set)) was used. Must be false if is_virtual is true.

allow_private_mutation: bool

true if the property allows private mutation.

Implementations

impl PropertyMetadata

pub fn new(name: VariableIdentifier) -> Self

Creates new PropertyMetadata with basic defaults (public, non-static, non-readonly, etc.). Name is mandatory. Spans, types, and flags can be set using modifier methods.

pub fn set_default_type_metadata( &mut self, default_type_metadata: Option<TypeMetadata>, )

pub fn set_type_declaration_metadata( &mut self, type_declaration_metadata: Option<TypeMetadata>, )

pub fn set_type_metadata(&mut self, type_metadata: Option<TypeMetadata>)

pub fn get_name(&self) -> &VariableIdentifier

Returns a reference to the property’s name identifier.

pub fn has_default(&self) -> bool

Checks if the property is declared with a default value.

pub fn is_static(&self) -> bool

Checks if the property is declared static.

pub fn is_final(&self) -> bool

Checks if the property is effectively final (private read or write access).

pub fn set_name_span(&mut self, name_span: Option<Span>)

Sets the span for the property name identifier.

pub fn set_span(&mut self, span: Option<Span>)

Sets the overall span for the property declaration.

pub fn set_visibility(&mut self, read: Visibility, write: Visibility)

Sets both read and write visibility levels. Updates is_asymmetric. Ensures virtual properties remain symmetric.

pub fn set_is_readonly(&mut self, is_readonly: bool)

Sets whether the property is readonly.

pub fn set_allow_private_mutation(&mut self, allow_private_mutation: bool)

Sets whether the property allows private mutation.

pub fn set_has_default(&mut self, has_default: bool)

Sets whether the property has a default value.

pub fn set_is_promoted(&mut self, is_promoted: bool)

Sets whether the property originates from constructor promotion.

pub fn set_is_internal(&mut self, is_internal: bool)

Sets whether the property is marked @internal.

pub fn set_is_static(&mut self, is_static: bool)

Sets whether the property is static.

pub fn set_is_abstract(&mut self, is_abstract: bool)

Sets whether the property represents an abstract requirement.

pub fn set_is_deprecated(&mut self, is_deprecated: bool)

Sets whether the property is marked @deprecated.

pub fn set_is_virtual(&mut self, is_virtual: bool)

Sets whether the property uses property hooks. Updates is_asymmetric.

Trait Implementations

impl Clone for PropertyMetadata

fn clone(&self) -> PropertyMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PropertyMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for PropertyMetadata

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PropertyMetadata

fn eq(&self, other: &PropertyMetadata) -> 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 PropertyMetadata

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 PropertyMetadata

impl StructuralPartialEq for PropertyMetadata