1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-12 01:09:38 +01:00
psalm/src/Psalm/Checker/CommentChecker.php

100 lines
3.3 KiB
PHP
Raw Normal View History

2016-06-24 00:45:46 +02:00
<?php
namespace Psalm\Checker;
use Psalm\Context;
use Psalm\StatementsSource;
use Psalm\Type;
2016-06-24 00:45:46 +02:00
class CommentChecker
{
2016-06-30 06:27:33 +02:00
const TYPE_REGEX = '(\\\?[A-Za-z0-9_\<\>\[\]|\\\]+[A-Za-z0-9_\<\>\[\]]|\$[a-zA-Z_0-9_\<\>\|\[\]]+)';
2016-06-24 00:45:46 +02:00
/**
* @param string $comment
* @param Context|null $context
2016-06-24 00:45:46 +02:00
* @param StatementsSource $source
* @param string $var_id
* @return Type\Union|null
*/
public static function getTypeFromComment($comment, Context $context = null, StatementsSource $source, $var_id = null)
{
$type_in_comments_var_id = null;
$type_in_comments = null;
$comments = StatementsChecker::parseDocComment($comment);
if ($comments && isset($comments['specials']['var'][0])) {
$var_parts = array_filter(preg_split('/[\s\t]+/', $comments['specials']['var'][0]));
if ($var_parts) {
2016-08-11 01:21:03 +02:00
$type_in_comments = FunctionChecker::fixUpLocalType($var_parts[0], $source->getAbsoluteClass(), $source->getNamespace(), $source->getAliasedClasses());
2016-06-24 00:45:46 +02:00
// support PHPStorm-style docblocks like
// @var Type $variable
if (count($var_parts) > 1 && $var_parts[1][0] === '$') {
$type_in_comments_var_id = substr($var_parts[1], 1);
}
}
}
if (!$type_in_comments) {
return null;
}
$defined_type = Type::parseString($type_in_comments);
if ($context && $type_in_comments_var_id && $type_in_comments_var_id !== $var_id) {
if (isset($context->vars_in_scope[$type_in_comments_var_id])) {
$context->vars_in_scope[$type_in_comments_var_id] = $defined_type;
}
return null;
}
return $defined_type;
}
public static function extractDocblockInfo($comment)
{
$comments = StatementsChecker::parseDocComment($comment);
$info = ['return_type' => null, 'params' => [], 'deprecated' => false, 'suppress' => []];
2016-06-24 00:45:46 +02:00
if (isset($comments['specials']['return'])) {
$return_blocks = preg_split('/[\s]+/', $comments['specials']['return'][0]);
if (preg_match('/^' . self::TYPE_REGEX . '$/', $return_blocks[0]) && !preg_match('/\[[^\]]+\]/', $return_blocks[0])) {
$info['return_type'] = $return_blocks[0];
}
}
if (isset($comments['specials']['param'])) {
foreach ($comments['specials']['param'] as $param) {
$param_blocks = preg_split('/[\s]+/', $param);
if (count($param_blocks) > 1 &&
preg_match('/^' . self::TYPE_REGEX . '$/', $param_blocks[0]) &&
!preg_match('/\[[^\]]+\]/', $param_blocks[0]) &&
preg_match('/^\$[A-Za-z0-9_]+$/', $param_blocks[1])
) {
2016-06-25 00:18:11 +02:00
$info['params'][] = ['name' => substr($param_blocks[1], 1), 'type' => $param_blocks[0]];
2016-06-24 00:45:46 +02:00
}
}
}
if (isset($comments['specials']['deprecated'])) {
$info['deprecated'] = true;
}
if (isset($comments['specials']['suppress'])) {
foreach ($comments['specials']['suppress'] as $suppress_entry) {
$info['suppress'][] = preg_split('/[\s]+/', $suppress_entry)[0];
}
}
2016-06-24 00:45:46 +02:00
return $info;
}
}