1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 10:57:08 +01:00
psalm/src/Psalm/Internal/Scanner/FunctionDocblockComment.php

163 lines
3.0 KiB
PHP

<?php
namespace Psalm\Internal\Scanner;
/**
* @internal
*/
class FunctionDocblockComment
{
/**
* @var string|null
*/
public $return_type = null;
/**
* @var string|null
*/
public $return_type_description = null;
/**
* @var int|null
*/
public $return_type_start = null;
/**
* @var int|null
*/
public $return_type_end = null;
/**
* @var int|null
*/
public $return_type_line_number;
/**
* @var array<int, array{name:string, type:string, line_number: int, start: int, end: int}>
*/
public $params = [];
/**
* @var array<int, array{name:string, type:string, line_number: int}>
*/
public $params_out = [];
/**
* @var array<int, array{name:string}>
*/
public $taint_sink_params = [];
/**
* @var array<int, array{name:string}>
*/
public $assert_untainted_params = [];
/**
* @var array<int, array{name:string, type:string, line_number: int}>
*/
public $globals = [];
/**
* Whether or not the function is deprecated
*
* @var bool
*/
public $deprecated = false;
/**
* If set, the function is internal to the given namespace.
*
* @var null|string
*/
public $psalm_internal = null;
/**
* Whether or not the function is internal
*
* @var bool
*/
public $internal = false;
/**
* Whether or not the function uses get_args
*
* @var bool
*/
public $variadic = false;
/**
* Whether or not the function is pure
*
* @var bool
*/
public $pure = false;
/**
* Whether or not to ignore the nullability of this function's return type
*
* @var bool
*/
public $ignore_nullable_return = false;
/**
* Whether or not to ignore the nullability of this function's return type
*
* @var bool
*/
public $ignore_falsable_return = false;
/**
* @var array<int, string>
*/
public $suppressed_issues = [];
/**
* @var array<int, array{0: string, 1: int, 2: int}>
*/
public $throws = [];
/**
* @var array<int, array{string, ?string, ?string, bool}>
*/
public $templates = [];
/**
* @var array<int, array{template_type: string, param_name: string, line_number?: int}>
*/
public $template_typeofs = [];
/**
* @var array<int, array{type: string, param_name: string}>
*/
public $assertions = [];
/**
* @var array<int, array{type: string, param_name: string}>
*/
public $if_true_assertions = [];
/**
* @var array<int, array{type: string, param_name: string}>
*/
public $if_false_assertions = [];
/**
* @var bool
*/
public $inheritdoc = false;
/**
* @var bool
*/
public $mutation_free = false;
/**
* @var bool
*/
public $external_mutation_free = false;
/**
* @var bool
*/
public $remove_taint = false;
}