При написании документа PHP для функции, если функция возвращает значение, вы бы написали что-то вроде
@return array $someArray An array of formatted dates
Но допустим, что моя функция не возвращает значение, а изменяет исходное значение, которое передается в виде ссылки, примерно так:
function formatDates(&$input_arr){
/**
* Formats an array of dates
* @param array $input_arr An array of raw dates
*/
array_walk_recursive($input_arr, 'formatDateFunction');
}
Эта функция изменяет входной массив.
Я знаю, это очевидно с &
перед параметром, но возвращаемые значения довольно очевидны с return
перед ними тоже, так что я чувствую, что для этого может быть стандарт?
В настоящее время я просто упоминаю это в описании функции, например:
/**
* Formats an array of dates, modifies original array
Есть ли общепринятый способ указать, что функция изменяет входное значение в документах PHP? Или это просто как обычно подразумевается?
Вот так
* @param array &$array modified parameter array of dates
Других решений пока нет …