Documentation

Context

in package

• Lwt

Table of Contents

Properties

$assigned_var_ids  : array<string, int>

A list of vars that have been assigned to

$branch_point  : int|null

If we've branched from the main scope, a byte offset for where that branch happened

$break_types  : array<int, "loop"|"switch">

What does break mean in this context?

$byref_constraints  : array<string, ReferenceConstraint>

A list of variables that have been passed by reference (where we know their type)

$calling_function_id  : string|null

$calling_method_id  : lowercase-string|null

$case_scope  : CaseScope|null

$check_classes  : bool

$check_consts  : bool

$check_functions  : bool

$check_methods  : bool

$check_variables  : bool

$clauses  : array<int, Clause>

A list of clauses in Conjunctive Normal Form

$collect_exceptions  : bool

Whether or not to track exceptions

$collect_initializations  : bool

Whether or not to do a deep analysis and collect initializations from private or final methods

$collect_mutations  : bool

Whether or not to do a deep analysis and collect mutations to this context

$collect_nonprivate_initializations  : bool

Whether or not to do a deep analysis and collect initializations from public non-final methods

$cond_referenced_var_ids  : array<string, bool>

A list of variables that have been referenced in conditionals

$constants  : array<string, Union>

$error_suppressing  : bool

$external_mutation_free  : bool

$finally_scope  : FinallyScope|null

$has_returned  : bool

$if_body_context  : Context|null

$ignore_variable_method  : bool

$ignore_variable_property  : bool

$include_location  : CodeLocation|null

$initialized_methods  : array<string, bool>

Stored to prevent re-analysing methods when checking for initialised properties

$inside_assignment  : bool

Whether or not we're inside an assignment

$inside_call  : bool

Whether or not we're inside a function/method call

$inside_class_exists  : bool

Whether or not we're inside a class_exists call, where we don't care about possibly undefined classes

$inside_conditional  : bool

Whether or not we're inside the conditional of an if/where etc.

$inside_general_use  : bool

Whether or not we're inside any other situation that treats a variable as used

$inside_isset  : bool

Whether or not we're inside an isset call

$inside_loop  : bool

$inside_negation  : bool

$inside_return  : bool

Whether or not we're inside a return expression

$inside_throw  : bool

Whether or not we're inside a throw

$inside_try  : bool

Whether or not we're inside a try block.

$inside_unset  : bool

Whether or not we're inside an unset call, where we don't care about possibly undefined variables

$is_global  : bool

$loop_scope  : LoopScope|null

$mutation_free  : bool

$parent  : string|null

$parent_remove_vars  : array<string, true>

$phantom_classes  : array<lowercase-string, true>

A list of classes checked with class_exists

$phantom_files  : array<string, bool>

A list of files checked with file_exists

$possibly_assigned_var_ids  : array<string, bool>

A list of vars that have been may have been assigned to

$possibly_thrown_exceptions  : array<string, array<string|int, CodeLocation>>

A list of classes or interfaces that may have been thrown

$protected_var_ids  : array<string, bool>

$pure  : bool

$reconciled_expression_clauses  : array<int, string|int>

A list of hashed clauses that have already been factored in

$referenced_counts  : array<string, int<0, max>>

Keeps track of how many times a var_in_scope has been referenced. May not be set for all $vars_in_scope.

$referenced_globals  : array<string, true>

A set of globals that are referenced somewhere.

$references_in_scope  : array<string, string>

Maps references to referenced variables for the current scope.

$references_possibly_from_confusing_scope  : array<string, CodeLocation>

A set of references that might still be in scope from a scope likely to cause confusion. This applies to references set inside a loop or if statement, since it's easy to forget about PHP's weird scope rules, and assigning to a reference will change the referenced variable rather than shadowing it.

$references_to_external_scope  : array<string, true>

Set of references to variables in another scope. These references will be marked as used if they are assigned to.

$self  : string|null

$strict_types  : bool

$vars_in_scope  : array<string, Union>

$vars_possibly_in_scope  : array<string, bool>

Methods

__destruct()  : mixed

decrementReferenceCount()  : void

Decrement the reference count of the variable that $ref_id is referring to. This needs to be done before $ref_id is changed to no longer reference its currently referenced variable, for example by unsetting, reassigning to another reference, or being shadowed by a global.

defineGlobals()  : void

filterClauses()  : array<int, Clause>

getNewOrUpdatedVarIds()  : array<int, string>

getRedefinedVars()  : array<string, Union>

getScopeSummary()  : string

hasVariable()  : bool

insideUse()  : bool

isPhantomClass()  : bool

isSuppressingExceptions()  : bool

mergeExceptions()  : void

mergeFunctionExceptions()  : void

remove()  : void

removeDescendents()  : void

This method is used after assignments to variables to remove any existing items in $vars_in_scope that are now made redundant by an update to some data

removeMutableObjectVars()  : void

removePossibleReference()  : void

Remove a variable from the context which might be a reference to another variable, or referenced by another variable. Leaves the variable as possibly-in-scope, unlike remove().

removeReconciledClauses()  : Clause>}

removeVarFromConflictingClauses()  : void

update()  : void

Updates the parent context, looking at the changes within a block and then applying those changes, where necessary, to the parent context

updateChecks()  : void

updateReferencesPossiblyFromConfusingScope()  : void

Updates the list of possible references from a confusing scope, such as a reference created in an if that might later be reused.