Как мне документировать использование GET или POST в методе контроллера? - PullRequest
Новая
       36

Как мне документировать использование GET или POST в методе контроллера?

1 голос
/ 22 февраля 2012

Я ищу лучший способ документировать методы моего контроллера в php.Мне было интересно, как я должен документировать мои POST и GET требования (я использовал REQUEST здесь, чтобы показать, что он мне нужен в обоих направлениях).

т.е. см. Этот метод: 

public function login(){

    $username = $_REQUEST['username'];
    $password = $_REQUEST['password'];
    $stay_loggedin = $_REQUEST['stay-loggedin'];

    $user = new usermodel();
    if ($user->login($username, $password, $stay_loggedin) ) return <something>;
    else return page_not_allowed;
}

Было бы замечательно, если бы кто-нибудь мог сказать мне способ, совместимый с php-doc ... Я имею в виду, что @param было бы неправильно, не так ли?

Должен ли я документироватьтребуемый класс usermodel?И как?

спасибо за помощь

1 Ответ

1 голос
/ 22 февраля 2012

Для документирования методов GET / POST вы можете сделать следующее: 


/**
 * Function to Login a user
 *
 * Requires $_POST['username'] and $_POST['password']
 * Optional $_REQUEST['stay-loggedin'] 
 * 
 * @return void
 */
public function login(){

    $username = $_REQUEST['username'];
    $password = $_REQUEST['password'];
    $stay_loggedin = $_REQUEST['stay-loggedin'];

    $user = new usermodel();
    if ($user->login($username, $password, $stay_loggedin) ) return ;
    else return page_not_allowed;
}

И вы можете задокументировать класс usermodel в самом файле класса usermodel.Надеюсь, это поможет

...