Как использовать umiTemplaterPHP при разработке php-шаблона?

Question

[Максим Попов]

Как использовать закомментированные строчки с umiTemplaterPHP?

<?php /** @var umiTemplaterPHP $this */ ?>
<?php /** @var array $variables */ ?>

В документации говорится, что это подсказки IDE для вывода autocomplete, но не указывается, что за IDE и как это настраивать?

Дополнительно интересует, как получить информацию о структуре массивов, которые возвращают php-макросы в php-шаблонизаторе?

Answer 1

[i]

К umiTemplaterPHP это отношения не имеет, это стандарт документирования PHPDoc, многие IDE поддерживают его по умолчанию или с плагином. Ищите информацию о поддержке этого стандарта в используемой IDE.

Для документирования массива на текущий момент стандарт дает следующий пример:

/**
 * Initializes this class with the given options.
 *
 * @param array $options {
 *     @var bool   $required Whether this element is required
 *     @var string $label    The display name for this element
 * }
 */

Для документирования результата, логично использовать так:

/**
 * @return array {
 *     @var bool   $required Whether this element is required
 *     @var string $label    The display name for this element
 * }
 */

Но такое применение может не поддерживаться текущими инструментами для работы с PHPDoc. На эту тему открыто обсуждение в проекте развития PHPDocumentor.

Возможные решения рассмотрены в документе: Документирование ассоциативных массивов в PHPDoc.

Comments

[Максим Попов]

а эта утилита поможет получить информацию о структуре массивов, которые возвращают php-макросы в php-шаблонизаторе?

[i]

Максим Попов: Обновил ответ.