PHPDoc ссылается на запись dotenv
Как мне указать на блок PHPdoc, что, если переменная отсутствует, он проверит для нее настройку dotenv?
/**
* Class constructor.
*
* Created Class Object.
*
* @param null $url - access url for api
*/
public function __construct($url = null)
{
if (! isset($url)) {
$url = env('CLASS_URL', null);
}
}
2 ответа
Предположительно, что env()
функция - это та, которую вы определили. Поэтому я бы использовал@see env()
, чтобы подчеркнуть, что он используется для поиска значения, если оно не передается через аргумент.
Вы можете разделить его, сделав статический createFromEnv()
с бесформенным описанием, которое создает экземпляр. Таким образом, более очевидно, откуда$url
взят.
Недостатком является то, что создатель должен явно принять решение, вызывать ли createFromEnv
или __construct
.