1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 02:47:02 +01:00
psalm/src/Psalm/Storage/FunctionLikeStorage.php

246 lines
4.5 KiB
PHP
Raw Normal View History

<?php
namespace Psalm\Storage;
2019-07-05 22:24:00 +02:00
use function array_map;
use function implode;
use Psalm\CodeLocation;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
2019-07-05 22:24:00 +02:00
use Psalm\Type;
abstract class FunctionLikeStorage
{
use CustomMetadataTrait;
/**
* @var CodeLocation|null
*/
public $location;
/**
* @var CodeLocation|null
*/
public $stmt_location;
/**
* @var array<int, FunctionLikeParameter>
*/
public $params = [];
/**
2020-06-24 17:48:27 +02:00
* @var array<string, bool>
*/
2020-06-24 17:48:27 +02:00
public $param_lookup = [];
2019-01-19 19:32:43 +01:00
/**
* @var Type\Union|null
*/
public $return_type;
/**
* @var CodeLocation|null
*/
public $return_type_location;
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
/**
* @var Type\Union|null
*/
public $signature_return_type;
/**
* @var CodeLocation|null
*/
public $signature_return_type_location;
/**
2019-11-25 21:20:31 +01:00
* @var ?string
*/
public $cased_name;
/**
* @var array<int, string>
*/
public $suppressed_issues = [];
/**
2019-11-25 21:20:31 +01:00
* @var ?bool
*/
public $deprecated;
/**
2019-11-25 21:20:31 +01:00
* @var ?bool
*/
public $internal;
/**
* @var null|string
*/
public $psalm_internal;
/**
* @var bool
*/
2019-11-25 21:20:31 +01:00
public $variadic = false;
/**
* @var bool
*/
public $returns_by_ref = false;
/**
2019-11-25 21:20:31 +01:00
* @var ?int
*/
public $required_param_count;
/**
* @var array<string, Type\Union>
*/
public $defined_constants = [];
/**
* @var array<string, bool>
*/
public $global_variables = [];
/**
* @var array<string, Type\Union>
*/
public $global_types = [];
2017-02-10 02:35:17 +01:00
/**
* @var array<string, non-empty-array<string, array{Type\Union}>>|null
2017-02-10 02:35:17 +01:00
*/
public $template_types;
/**
* @var array<int, bool>|null
*/
public $template_covariants;
/**
* @var array<int, Assertion>
*/
public $assertions = [];
/**
* @var array<int, Assertion>
*/
public $if_true_assertions = [];
/**
* @var array<int, Assertion>
*/
public $if_false_assertions = [];
/**
* @var bool
*/
public $has_visitor_issues = false;
/**
* @var list<\Psalm\Issue\CodeIssue>
*/
public $docblock_issues = [];
/**
* @var array<string, bool>
*/
public $throws = [];
2019-08-13 21:44:18 +02:00
/**
* @var array<string, CodeLocation>
*/
public $throw_locations = [];
/**
* @var bool
*/
public $has_yield = false;
2019-08-30 18:36:35 +02:00
/**
* @var bool
*/
public $mutation_free = false;
/**
* @var string|null
*/
public $return_type_description;
2019-02-27 22:00:44 +01:00
/**
* @var array<string, CodeLocation>|null
*/
public $unused_docblock_params;
/**
* @var bool
*/
public $pure = false;
/**
2020-05-22 04:47:58 +02:00
* 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.
*
* @var bool
*/
2020-05-22 04:47:58 +02:00
public $specialize_call = false;
2020-06-21 06:58:56 +02:00
/**
* @var array<string>
*/
public $taint_source_types = [];
2020-05-22 04:47:58 +02:00
/**
* @var array<string>
*/
public $added_taints = [];
/**
* @var array<string>
*/
public $removed_taints = [];
/**
2020-06-22 23:53:03 +02:00
* @var array<int, string>
2020-05-22 04:47:58 +02:00
*/
public $return_source_params = [];
public function __toString()
{
return $this->getSignature(false);
}
public function getSignature(bool $allow_newlines = false): string
{
$newlines = $allow_newlines && !empty($this->params);
2019-07-03 22:58:27 +02:00
$symbol_text = 'function ' . $this->cased_name . '(' . ($newlines ? "\n" : '') . implode(
',' . ($newlines ? "\n" : ' '),
array_map(
function (FunctionLikeParameter $param) use ($newlines) : string {
return ($newlines ? ' ' : '') . ($param->type ?: 'mixed') . ' $' . $param->name;
},
$this->params
)
2019-07-03 22:58:27 +02:00
) . ($newlines ? "\n" : '') . ') : ' . ($this->return_type ?: 'mixed');
if (!$this instanceof MethodStorage) {
return $symbol_text;
}
switch ($this->visibility) {
2018-11-06 03:57:36 +01:00
case ClassLikeAnalyzer::VISIBILITY_PRIVATE:
$visibility_text = 'private';
break;
2018-11-06 03:57:36 +01:00
case ClassLikeAnalyzer::VISIBILITY_PROTECTED:
$visibility_text = 'protected';
break;
default:
$visibility_text = 'public';
}
return $visibility_text . ' ' . $symbol_text;
}
}