phpstorm генерирует сеттер с подсказкой типа
В phpstorm вы можете создать метод установки для членов класса альт + вставить > setters> выбор переменных, для которых создаются методы setter.
Но даже когда phpstorm знает тип / класс переменной, он не вставляет подсказку типа в список параметров.
Как заставить phpstorm генерировать сеттеры с подсказками типов, но только для типов с типом hintable?
Пример класса
class CodeGenerationTest {
/* @var \DateTimeInterface */
private $date;
/* @var int */
private $num;
}
Желаемые сгенерированные сеттеры должны быть:
/**
* @param DateTimeInterface $date
*/
public function setDate(DateTimeInterface $date)
{
$this->date = $date;
}
/**
* @param int $num
*/
public function setNum($num)
{
$this->num = $num;
}
setNum правильно, но setDate генерируется с пропуском подсказки типа для параметра:
/**
* @param DateTimeInterface $date
*/
public function setDate($date)
{
$this->date = $date;
}
Решение
Вам нужно изменить шаблон вашего метода PHP Setter в PhpStorm, чтобы указать подсказку типа.
Откройте «Настройки» PhpStorm и меню «Шаблоны файлов и кодов», на вкладке «Код» есть опция «Метод установки PHP». Измените его так, чтобы он выглядел так:
#set($typeHintText = "$TYPE_HINT ")
## First we check against a blacklist of primitive and other common types used in documentation.
#set($nonTypeHintableTypes = ["", "string", "int", "mixed", "number", "void", "object", "real", "double", "float", "resource", "null", "bool", "boolean"])
#foreach($nonTypeHintableType in $nonTypeHintableTypes)
#if ($nonTypeHintableType == $TYPE_HINT)
#set($typeHintText = "")
#end
#end
## Make sure the type hint actually looks like a legal php class name(permitting namespaces too) for future proofing reasons.
## This is important because PSR-5 is coming soon, and will allow documentation of types with syntax like SplStack<int>
#if (!$TYPE_HINT.matches('^((\\)?[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]+)+$'))
#set($typeHintText = "")
#end
## Next, we check if this is using the array syntax like "MyClass[]", and type hint it as a plain array
#if ($TYPE_HINT.endsWith("[]"))
#set($typeHintText = "array ")
#end
/**
* @param ${TYPE_HINT} $${PARAM_NAME}
*/
public ${STATIC} function set${NAME}($typeHintText$${PARAM_NAME})
{
#if (${STATIC} == "static")
self::$${FIELD_NAME} = $${PARAM_NAME};
#else
$this->${FIELD_NAME} = $${PARAM_NAME};
#end
}
На самом деле, так как Примитивный список php на самом деле короткий, можно определить, является ли это примитивным типом или нет.
Так:
class CodeGenerationTest {
/**
* @var DateTimeInterface
*/
private $date;
/**
* @var int
*/
private $num;
}
На самом деле генерирует это:
/**
* @var \DateTimeInterface $date
*/
public function setDate(\DateTimeInterface $date)
{
$this->date = $date;
}
/**
* @var int $num
*/
public function setNum($num)
{
$this->num = $num;
}
Вы можете найти помощь по шаблонам переменных здесь:
https://www.jetbrains.com/phpstorm/webhelp/file-template-variables.html
Другие решения
Я нашел решение @ Pier настолько полезным, что обновил его шаблон для генерации сеттеров с подсказками обоих типов. А ТАКЖЕ необязательный тип литья. Надеюсь, это поможет кому-то еще.
Дано:
class CodeGenerationTest
{
/**
* @var \DateTime
*/
private $date;
/**
* @var int
*/
private $id;
/**
* @var string|null
*/
private $notes;
}
Будет генерировать:
/**
* @param \DateTime $date
*/
public function setDate(\DateTime $date)
{
$this->date = $date;
}
/**
* @param int $id
*/
public function setId($id)
{
$this->id = (int)$id;
}
/**
* @param null|string $notes
*/
public function setNotes($notes)
{
$this->notes = is_null($notes) ? null : (string)$notes;
}
Вот шаблон кода для копирования / вставки в PHPStorm:
Settings > Editor > File and Code Templates > Code > PHP Setter Method
#set($typeHintText = "$TYPE_HINT ")
## First we check against a blacklist of primitive and other common types used in documentation.
#set($nonTypeHintableTypes = ["", "string", "int", "integer", "mixed", "number", "void", "object", "real", "double", "float", "resource", "null", "bool", "boolean"])
#foreach($nonTypeHintableType in $nonTypeHintableTypes)
#if ($nonTypeHintableType == $TYPE_HINT)
#set($typeHintText = "")
#end
#end
## Make sure the type hint actually looks like a legal php class name(permitting namespaces too) for future proofing reasons.
## This is important because PSR-5 is coming soon, and will allow documentation of types with syntax like SplStack<int>
#if (!$TYPE_HINT.matches('^((\\)?[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]+)+$'))
#set($typeHintText = "")
#end
## Next, we check if this is using the array syntax like "MyClass[]", and type hint it as a plain array
#if ($TYPE_HINT.endsWith("[]"))
#set($typeHintText = "array ")
#end
## Set this or self
#set($thisOrSelf = "$this->")
#if (${STATIC} == "static")
#set($thisOrSelf = "self::$")
#end
## Type cast incoming variable that can also be null, using the ternary operator
#set($ternaryCast = "")
#if ($TYPE_HINT.contains('null|') || $TYPE_HINT.contains('|null'))
#set($ternaryCast = "is_null($${PARAM_NAME}) ? null : ")
#end
## Type cast incoming variable
#set($cast = " ")
#if ($TYPE_HINT.contains('string'))
#set($cast = "(string) ")
#elseif ($TYPE_HINT.contains('object'))
#set($cast = "(object) ")
#elseif ($TYPE_HINT.contains('int'))
#set($cast = "(int) ")
#elseif ($TYPE_HINT.contains('bool'))
#set($cast = "(bool) ")
#elseif ($TYPE_HINT.contains('float') || $TYPE_HINT.contains('double') || $TYPE_HINT.contains('real'))
#set($cast = "(float) ")
#end
/**
* @param ${TYPE_HINT} $${PARAM_NAME}
*/
public ${STATIC} function set${NAME}($typeHintText$${PARAM_NAME})
{
$thisOrSelf${FIELD_NAME} = $ternaryCast$cast$${PARAM_NAME};
}