PHPDoc ссылается на запись dotenv - PullRequest
0 голосов
/ 08 октября 2019

Как мне ссылаться на блок 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 ]

0 голосов
/ 14 октября 2019

Предположительно, что функция env() определена вами. Поэтому я бы использовал тег @see env(), чтобы подчеркнуть, что он используется для поиска значения, когда оно не передается через аргумент.

0 голосов
/ 08 октября 2019

Вы можете разделить его, сделав статический createFromEnv() с бесформенным описанием, которое создает экземпляр. Таким образом, это более очевидно, откуда взято $url.

Недостатком является то, что создатель должен принять решение в явном виде, позвонить ли createFromEnv или __construct.

...