Documentation

PropertyInfoExtractorInterface extends PropertyTypeExtractorInterface, PropertyDescriptionExtractorInterface, PropertyAccessExtractorInterface, PropertyListExtractorInterface
in

Gets info about PHP class properties.

A convenient interface inheriting all specific info interfaces.

Tags
author

Kévin Dunglas dunglas@gmail.com

Table of Contents

Methods

getLongDescription()  : string|null
Gets the long description of the property.
getProperties()  : array<string|int, string>|null
Gets the list of properties available for the given class.
getShortDescription()  : string|null
Gets the short description of the property.
getTypes()  : array<string|int, Type>|null
Gets types of a property.
isReadable()  : bool|null
Is the property readable?
isWritable()  : bool|null
Is the property writable?

Methods

getLongDescription()

Gets the long description of the property.

public getLongDescription(string $class, string $property[, array<string|int, mixed> $context = [] ]) : string|null
Parameters
$class : string
$property : string
$context : array<string|int, mixed> = []
Return values
string|null

getProperties()

Gets the list of properties available for the given class.

public getProperties(string $class[, array<string|int, mixed> $context = [] ]) : array<string|int, string>|null
Parameters
$class : string
$context : array<string|int, mixed> = []
Return values
array<string|int, string>|null

getShortDescription()

Gets the short description of the property.

public getShortDescription(string $class, string $property[, array<string|int, mixed> $context = [] ]) : string|null
Parameters
$class : string
$property : string
$context : array<string|int, mixed> = []
Return values
string|null

getTypes()

Gets types of a property.

public getTypes(string $class, string $property[, array<string|int, mixed> $context = [] ]) : array<string|int, Type>|null
Parameters
$class : string
$property : string
$context : array<string|int, mixed> = []
Return values
array<string|int, Type>|null

isReadable()

Is the property readable?

public isReadable(string $class, string $property[, array<string|int, mixed> $context = [] ]) : bool|null
Parameters
$class : string
$property : string
$context : array<string|int, mixed> = []
Return values
bool|null

isWritable()

Is the property writable?

public isWritable(string $class, string $property[, array<string|int, mixed> $context = [] ]) : bool|null
Parameters
$class : string
$property : string
$context : array<string|int, mixed> = []
Return values
bool|null 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results