PHP Lang
  1. PHP Lang
  3. Синтаксис закрытия в PHPDoc
Intereting Posts
Неустранимая ошибка: допустимый размер памяти 268435456 байт исчерпан (пытался выделить 71 байт) Как создать форму с несколькими строками одного объекта в Symfony2 Проверка UNIQUE поля в Codeigniter с 2 индексами Неустранимая ошибка: вызов неопределенной функции INET_ATON () Query Logic SQL Вывод (эхо / печать) все из массива PHP Где я могу сохранить частичные (представления) в Zend Framework, чтобы быть доступным для всех представлений в моем приложении? PHP конвертирует 2-значный год в 4-значный год Метод ввода PHP PDO Пользовательские вспомогательные классы в Laravel 5.4 PHPExcel Как установить имя ячейки? PHP mysql charset utf8 проблемы phpunit 3.7: что случилось с аннотацией @assert? Модель Laravel с POINT / POLYGON и т. Д., Используя DB :: raw выражения Система Ajax push

Синтаксис закрытия в PHPDoc

Я не могу найти документацию по типу Closure в PHPDoc. Итак, мой вопрос заключается в том, как определить параметр параметров, присланных в закрытие и его возвращаемое значение?

Пример:

Как я могу описать, что «обратный вызов» получит «MyCustomClass», Number и String и вернет «MyOtherCustomClass»? 

/** * @param MyCustomClass $cls * @param Closure $callback this isn't really explaining what this is * * @return MyOtherCustomClass */ function changer($cls, $callback){ return $callback($cls, 2, "a string"); } changer($aCustomeClass, function($cls, $int, $string){ return new MyOtherCustomClass($cls, $int, $string); })

Или, если это вообще возможно?

Solutions Collecting From Web of "Синтаксис закрытия в PHPDoc"

«@param callable $ callback» действительно является синтаксисом для использования для этой части. Вы не ограничиваете этот параметр тем, что являетесь самим замыканием … любой вызываемый, который передается ему, будет принят в этой реализации. Callable – это законный «тип PHP», поэтому phpDocumentor принимает его как действительный тип.

В вашем примере кода на самом деле нет оснований полагать, что ваш метод changer () возвращает MyOtherCustomClass (), так как это просто диктуется тем, как вы пишете закрытие позже в использовании changer (). В лучшем случае вы отметили бы в комментарии при использовании функции changer (), что это конкретное использование changer () возвращает MyOtherCustomClass, потому что реализация этого использования, а не сама функция changer (), возвращает этот конкретный тип объекта.

Что касается документирования аргументов, которые переданный вызываемый «требуется» для принятия, я полагаю, вам придется сделать это в части описания тега param. Для описания такого случая нет синтаксиса.

Если бы я должен был что-то реализовать таким образом, я бы наложил интерфейс, который вызывающие все должны явно возвращать, и поэтому я мог бы написать, что changer () возвращает этот интерфейс. Конечно, это означает, что ваш MyOtherCustomClass должен реализовать этот интерфейс, но тем не менее это кажется мне единственным способом приблизиться к «принудительному» возврату типа changer ().