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
2020-06-24 11:51:31 -04:00

246 lines
4.5 KiB
PHP

<?php
namespace Psalm\Storage;
use function array_map;
use function implode;
use Psalm\CodeLocation;
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
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 = [];
/**
* @var array<string, bool>
*/
public $param_lookup = [];
/**
* @var Type\Union|null
*/
public $return_type;
/**
* @var CodeLocation|null
*/
public $return_type_location;
/**
* @var Type\Union|null
*/
public $signature_return_type;
/**
* @var CodeLocation|null
*/
public $signature_return_type_location;
/**
* @var ?string
*/
public $cased_name;
/**
* @var array<int, string>
*/
public $suppressed_issues = [];
/**
* @var ?bool
*/
public $deprecated;
/**
* @var ?bool
*/
public $internal;
/**
* @var null|string
*/
public $psalm_internal;
/**
* @var bool
*/
public $variadic = false;
/**
* @var bool
*/
public $returns_by_ref = false;
/**
* @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 = [];
/**
* @var array<string, non-empty-array<string, array{Type\Union}>>|null
*/
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 = [];
/**
* @var array<string, CodeLocation>
*/
public $throw_locations = [];
/**
* @var bool
*/
public $has_yield = false;
/**
* @var bool
*/
public $mutation_free = false;
/**
* @var string|null
*/
public $return_type_description;
/**
* @var array<string, CodeLocation>|null
*/
public $unused_docblock_params;
/**
* @var bool
*/
public $pure = false;
/**
* 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
*/
public $specialize_call = false;
/**
* @var array<string>
*/
public $taint_source_types = [];
/**
* @var array<string>
*/
public $added_taints = [];
/**
* @var array<string>
*/
public $removed_taints = [];
/**
* @var array<int, string>
*/
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);
$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
)
) . ($newlines ? "\n" : '') . ') : ' . ($this->return_type ?: 'mixed');
if (!$this instanceof MethodStorage) {
return $symbol_text;
}
switch ($this->visibility) {
case ClassLikeAnalyzer::VISIBILITY_PRIVATE:
$visibility_text = 'private';
break;
case ClassLikeAnalyzer::VISIBILITY_PROTECTED:
$visibility_text = 'protected';
break;
default:
$visibility_text = 'public';
}
return $visibility_text . ' ' . $symbol_text;
}
}