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

发布于 2025-01-07 14:12:07 字数 616 浏览 0 评论 0原文

我正在寻找一种最佳实践方法来在 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 不是正确的方式，不是吗？

我还应该记录所需的用户模型类吗？又如何呢？

感谢您的帮助

原文

I am searching for a best-practice-way to document my controller methods in php.
I was wondering how I should document my POST and GET requirements (I used REQUEST here to show I need it for both ways).

i.e. see this method:

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;
}

It would be great if someone can tell me a way which is php-doc compatible...
I mean @param wouldn't be the right way, woudldn't it?

Shall I document the required usermodel class as well? And how?

thanks for your help

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

紫南 2025-01-14 14:12:07

要记录 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 类。
希望有帮助

For documenting GET/POST methods you can do like:


/**
 * 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;
}

And you could document the usermodel class in usermodel class file itself.
Hope it helps

回复收藏 0 原文

~没有更多了~