Documentation

FunctionStorage extends FunctionLikeStorage
in package
uses UnserializeMemoryUsageSuppressionTrait

FinalYes

Table of Contents

Properties

$added_taints  : array<string|int, string>
$allow_named_arg_calls  : bool
$assertions  : array<int, Possibilities>
$attributes  : array<int, AttributeStorage>
$byref_uses  : array<string, bool>
$cased_name  : string|null
$conditionally_removed_taints  : array<string|int, Union>
$custom_metadata  : array<string, _MetadataEntry>
$defined_constants  : array<string, Union>
$deprecated  : bool|null
$description  : string|null
$docblock_issues  : array<int, CodeIssue>
$global_types  : array<string, Union>
$global_variables  : array<string, bool>
$has_undertyped_native_parameters  : bool
$has_visitor_issues  : bool
$has_yield  : bool
$if_false_assertions  : array<int, Possibilities>
$if_true_assertions  : array<int, Possibilities>
$internal  : array<int, non-empty-string>
$is_static  : bool
$location  : CodeLocation|null
$mutation_free  : bool
$param_lookup  : array<string, bool>
$params  : array<int, FunctionLikeParameter>
$proxy_calls  : array<int, array{fqn: string, params: int[], return: bool}>|null
$public_api  : bool
$pure  : bool
$removed_taints  : array<string|int, string>
$required_param_count  : int|null
$return_source_params  : array<int, string>
$return_type  : Union|null
$return_type_description  : string|null
$return_type_location  : CodeLocation|null
$returns_by_ref  : bool
$signature_return_type  : Union|null
$signature_return_type_location  : CodeLocation|null
$specialize_call  : bool
Whether or not the function output is dependent solely on input - a function can be impure but still have this property (e.g. var_export). Useful for taint analysis.
$stmt_location  : CodeLocation|null
$suppressed_issues  : array<int, string>
$taint_source_types  : array<string|int, string>
$template_types  : array<string|int, mixed>|null
An array holding the class template "as" types.
$throw_locations  : array<string, CodeLocation>
$throws  : array<string, bool>
$unused_docblock_parameters  : array<string, CodeLocation>
$variadic  : bool

Methods

__toString()  : string
__unserialize()  : void
getAttributeStorages()  : array<int, AttributeStorage>
Returns a list of AttributeStorages with the same order they appear in the AttributeGroups they come from.
getCompletionSignature()  : string
getHoverMarkdown()  : string
Used in the Language Server

Properties

$has_undertyped_native_parameters

public bool $has_undertyped_native_parameters = false

$param_lookup

public array<string, bool> $param_lookup = []
Tags
psalm-readonly-allow-private-mutation

$proxy_calls

public array<int, array{fqn: string, params: int[], return: bool}>|null $proxy_calls = []

$specialize_call

Whether or not the function output is dependent solely on input - a function can be impure but still have this property (e.g. var_export). Useful for taint analysis.

public bool $specialize_call = false

$template_types

An array holding the class template "as" types.

public array<string|int, mixed>|null $template_types = null

It's the de-facto list of all templates on a given class.

The name of the template is the first key. The nested array is keyed by a unique function identifier. This allows operations with the same-named template defined across multiple classes and/or functions to not run into trouble.

Methods

getCompletionSignature()

public getCompletionSignature() : string
Return values
string

getHoverMarkdown()

Used in the Language Server

public getHoverMarkdown() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results