Documentation

Config

in package

• Lwt

Tags

psalm-suppress

PropertyNotSetInConstructor

psalm-consistent-constructor

Table of Contents

Constants

CONFIG_NAMESPACE  = 'https://getpsalm.org/schema/config'

DEFAULT_BASELINE_NAME  = 'psalm-baseline.xml'

REPORT_ERROR  = 'error'

REPORT_INFO  = 'info'

REPORT_SUPPRESS  = 'suppress'

DEFAULT_FILE_NAMES  = ['psalm.xml', 'psalm.xml.dist', 'psalm.dist.xml']

MIXED_ISSUES  = ['MixedArgument', 'MixedArrayAccess', 'MixedArrayAssignment', 'MixedArrayOffset', 'MixedArrayTypeCoercion', 'MixedAssignment', 'MixedFunctionCall', 'MixedMethodCall', 'MixedOperand', 'MixedPropertyFetch', 'MixedPropertyAssignment', 'MixedReturnStatement', 'MixedStringOffsetAssignment', 'MixedArgumentTypeCoercion', 'MixedPropertyTypeCoercion', 'MixedReturnTypeCoercion']

Properties

$add_param_default_to_docblock_type  : bool

$all_constants_global  : bool

$all_functions_global  : bool

$allow_includes  : bool

$allow_internal_named_arg_calls  : bool

$allow_named_arg_calls  : bool

$allow_string_standin_for_class  : bool

$autoloader  : string|null

Path to the autoader

$base_dir  : string

The base directory of this config file without trailing slash

$check_for_throws_docblock  : bool

$check_for_throws_in_global_scope  : bool

$compressor  : "lz4"|"deflate"|"off"

$config_issues  : array<int, ConfigIssue>

$config_warnings  : array<int, string>

$debug_emitted_issues  : bool

$disable_suppress_all  : bool

$disable_var_parsing  : bool

$docblock_property_types_seal_properties  : bool

Whether using property annotations in docblocks should implicitly seal properties

$ensure_array_int_offsets_exist  : bool

$ensure_array_string_offsets_exist  : bool

$ensure_override_attribute  : bool

$error_baseline  : string|null

$ERROR_LEVELS  : array<string|int, string>

$eventDispatcher  : EventDispatcher

$find_unused_baseline_entry  : bool

$find_unused_code  : bool

$find_unused_issue_handler_suppression  : bool

$find_unused_psalm_suppress  : bool

$find_unused_variables  : bool

$forbidden_constants  : array<string, bool>

$forbidden_functions  : array<lowercase-string, bool>

$global_cache_directory  : string|null

The directory to store all Psalm project caches

$globals  : array<string, string>

$hash  : string

$hide_all_errors_except_passed_files  : bool

$hide_external_errors  : bool

$hoist_constants  : bool

$ignore_internal_falsable_issues  : bool

$ignore_internal_nullable_issues  : bool

$ignored_exceptions  : array<string, bool>

$ignored_exceptions_and_descendants  : array<string, bool>

$ignored_exceptions_and_descendants_in_global_scope  : array<string, bool>

$ignored_exceptions_in_global_scope  : array<string, bool>

$include_php_versions_in_error_baseline  : bool

$infer_property_types_from_constructor  : bool

$internal_stubs  : array<string|int, string>

$level  : 1|2|3|4|5|6|7|8

$limit_method_complexity  : bool

$literal_array_key_check  : bool

$max_avg_path_length  : int

$max_graph_size  : int

$max_shaped_array_size  : int

$max_string_length  : int

$memoize_method_calls  : bool

$php_extensions  : array<string, bool|null>

A list of php extensions supported by Psalm.

$php_extensions_not_supported  : array<string, true>

A list of php extensions required by the project that aren't fully supported by Psalm.

$php_extensions_supported_by_psalm_callmaps  : array<int, non-empty-string>

A list of php extensions described in CallMap Psalm files as opposite to stub files loaded by condition (see stubs/extensions dir).

$plugin_paths  : array<string|int, string>

$remember_property_assignments_after_call  : bool

$resolve_from_config_file  : bool

$restrict_return_types  : bool

$run_taint_analysis  : bool

$scan_threads  : int<1, max>|null

$seal_all_methods  : bool

$seal_all_properties  : bool

$show_mixed_issues  : bool|null

$skip_checks_on_unresolvable_includes  : bool

$source_filename  : string|null

$strict_binary_operands  : bool

$threads  : int<1, max>|null

$throw_exception  : bool

Whether or not to throw an exception on first error

$trigger_error_exits  : "default"|"never"|"always"

$use_docblock_property_types  : bool

Whether or not to use types as defined in property docblocks.

$use_docblock_types  : bool

Whether or not to use types as defined in docblocks

$use_igbinary  : bool

$use_phpdoc_method_without_magic_or_parent  : bool

$use_phpdoc_property_without_magic_or_parent  : bool

$use_phpstorm_meta_path  : bool

$project_files  : ProjectFileFilter|null

$cache_directory_initialized  : bool

$composer_class_loader  : ClassLoader|null

$configured_php_version  : string|null

The PHP version to assume as declared in the config file

$extra_files  : ProjectFileFilter|null

$file_extensions  : array<int, string>

$filetype_analyzer_paths  : array<string, string>

$filetype_analyzers  : array<string, FileAnalyzer>>

$filetype_scanner_paths  : array<string, string>

$filetype_scanners  : array<string, FileScanner>>

$include_collector  : IncludeCollector|null

$instance  : static|null

$issue_handlers  : array<string, IssueHandler>

$mock_classes  : array<int, string>

$plugin_classes  : array<string|int, SimpleXMLElement}>

$plugins  : array<class-string, PluginInterface>

$predefined_constants  : array<string, mixed>

$predefined_functions  : array<callable-string, bool>

$preloaded_stub_files  : array<string, string>

$report_info  : bool

$stub_files  : array<string, string>

$taint_analysis_ignored_files  : TaintAnalysisFileFilter|null

$universal_object_crates  : array<int, lowercase-string>

These are special object classes that allow any and all properties to be get/set on them

Methods

addPluginClass()  : void

addPluginPath()  : void

addPreloadedStubFile()  : void

addStubFile()  : void

addUniversalObjectCrate()  : void

collectPredefinedConstants()  : void

collectPredefinedFunctions()  : void

combineIssueHandlerSuppressions()  : void

computeHash()  : string

Computes the hash to use for a cache folder from CLI flags and from the config file's xml contents

getCacheDirectory()  : string|null

getComposerFilePathForClassLike()  : string|false

getConfigForPath()  : Config

Gets a Config object from an XML file.

getExtraDirectories()  : array<string|int, string>

getFileExtensions()  : array<int, string>

getFiletypeAnalyzers()  : array<string, FileAnalyzer>>

getFiletypeScanners()  : array<string, FileScanner>>

getGlobalCacheDirectory()  : string|null

getInstance()  : Config

getIssueHandlers()  : array<string, IssueHandler>

getIssueHandlerSuppressions()  : array<string|int, array{type: string, index: int, count: int}>

getMockClasses()  : array<int, string>

getParentIssueType()  : string|null

getPhpVersion()  : string|null

getPHPVersionFromComposerJson()  : string|null

getPhpVersionFromConfig()  : string|null

getPluginClasses()  : array<string|int, SimpleXMLElement}>

getPotentialComposerFilePathForClassLike()  : string|null

getPredefinedConstants()  : array<string, mixed>

getPredefinedFunctions()  : array<callable-string, bool>

getProjectDirectories()  : array<string|int, string>

getProjectFiles()  : array<string|int, string>

getReportingLevelForArgument()  : string|null

getReportingLevelForClass()  : string|null

getReportingLevelForClassConstant()  : string|null

getReportingLevelForFile()  : string

getReportingLevelForFunction()  : string|null

getReportingLevelForIssue()  : string

getReportingLevelForMethod()  : string|null

getReportingLevelForProperty()  : string|null

getReportingLevelForVariable()  : string|null

getStubFiles()  : array<string, string>

getUniversalObjectCrates()  : array<int, lowercase-string>

hasStubFile()  : bool

initializePlugins()  : void

Initialises all the plugins (done once the config is fully loaded)

isInExtraDirs()  : bool

isInProjectDirs()  : bool

loadFromXML()  : Config

Creates a new config object from an XML string

loadFromXMLFile()  : Config

Creates a new config object from the file

locateConfigFile()  : string|null

Searches up a folder hierarchy for the most immediate config.

mustBeIgnored()  : bool

processPluginFileExtensions()  : void

removeCacheDirectory()  : void

reportIssueInFile()  : bool

reportTypeStatsForFile()  : bool

safeSetAdvancedErrorLevel()  : void

safeSetCustomErrorLevel()  : void

setAdvancedErrorLevel()  : void

setComposerClassLoader()  : void

setCustomErrorLevel()  : void

setIncludeCollector()  : void

setServerMode()  : void

shortenFileName()  : string

trackTaintsInPath()  : bool

useStrictTypesForFile()  : bool

visitComposerAutoloadFiles()  : void

visitPreloadedStubFiles()  : void

visitStubFiles()  : void

fromXmlAndPaths()  : self

getPluginClassForPath()  : T>

lineNumberToByteOffset()  : int

loadDomDocument()  : DOMDocument

loadFileExtensions()  : void

loadPlugin()  : PluginInterface

processConfigDeprecations()  : void

processDeprecatedAttribute()  : void

processDeprecatedElement()  : void

requirePath()  : void

setBooleanAttribute()  : void

validateXmlConfig()  : void