我应该如何记录在控制器方法中使用GET或POST


how shall I document the use of GET or POST in a controller method?

我正在寻找一种在php中记录控制器方法的最佳实践方法。我想知道我应该如何记录我的POSTGET需求(我在这里使用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不是正确的方式,不是吗?

我还需要记录所需的用户模型类吗?如何?

感谢您的帮助

对于记录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类。希望它能帮助