Phpdocumentor和Slim路由器文档

时间:2013-01-07 12:30:02

标签: php routing documentation slim phpdoc

我使用phpdocumentor为我的项目生成文档。它为我的函数生成了很好的文档,如:

    /**
       * Hash generator
       *
       * Long description
       *
       * @param string $password Password
       * @return string
       */
    function generate_hash($password) {
        global $PASSWORD_SALT;
        return crypt($password, $PASSWORD_SALT);
    }

但我还没有找到一种方法来记录slim(php框架)的映射:

    /**
     * Delete news
     *
     * Delete news by id
     *
     * @link /news/delete/:id
     *
     */
    $app->get('/news/delete/:id', function ($id) use ($app) {
        $item = ORM::for_table('news')->find_one($id);
        if ($item)
            $item->delete();
        $app->redirect('/');
    })->conditions(array('id'=>'\d+'));

记录这样的事情的正确方法是什么?

1 个答案:

答案 0 :(得分:0)

要将我的评论描述为一个答案,我会指出一些类似于:

的内容
/**
 * Delete news
 *
 * Delete news by id
 *
 * @link /news/delete/:id
 *
 */
public function deleteNewsByID (&$app, $id)
{
     return $app->get('/news/delete/:id', function ($id) use ($app) {
         $item = ORM::for_table('news')->find_one($id);
         if ($item)
             $item->delete();
         $app->redirect('/');
     })->conditions(array('id'=>'\d+'));
}

但我不熟悉苗条,所以我无法保证它会起作用。如下面的评论所述,它不推荐也不漂亮。