123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432 |
- <!DOCTYPE HTML>
- <html lang="" >
- <head>
- <meta charset="UTF-8">
- <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
- <title>控制器 · GitBook</title>
- <meta http-equiv="X-UA-Compatible" content="IE=edge" />
- <meta name="description" content="">
- <meta name="generator" content="GitBook 3.2.3">
-
-
-
-
- <link rel="stylesheet" href="../gitbook/style.css">
-
-
-
- <link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
-
-
-
- <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
-
-
-
- <link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <meta name="HandheldFriendly" content="true"/>
- <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
- <meta name="apple-mobile-web-app-capable" content="yes">
- <meta name="apple-mobile-web-app-status-bar-style" content="black">
- <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
- <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
-
- <link rel="next" href="mo-xing.html" />
-
-
- <link rel="prev" href="lu-you.html" />
-
- </head>
- <body>
-
- <div class="book">
- <div class="book-summary">
-
-
- <div id="book-search-input" role="search">
- <input type="text" placeholder="Type to search" />
- </div>
-
- <nav role="navigation">
-
- <ul class="summary">
-
-
-
-
-
-
-
- <li class="chapter " data-level="1.1" data-path="../">
-
- <a href="../">
-
-
- 简介
-
- </a>
-
-
- </li>
-
- <li class="chapter " data-level="1.2" data-path="../chapter1.html">
-
- <a href="../chapter1.html">
-
-
- 基础用法
-
- </a>
-
-
- <ul class="articles">
-
-
- <li class="chapter " data-level="1.2.1" data-path="pei-zhi.html">
-
- <a href="pei-zhi.html">
-
-
- 配置
-
- </a>
-
-
- </li>
-
- <li class="chapter " data-level="1.2.2" data-path="lu-you.html">
-
- <a href="lu-you.html">
-
-
- 路由
-
- </a>
-
-
- </li>
-
- <li class="chapter active" data-level="1.2.3" data-path="kong-zhi-qi.html">
-
- <a href="kong-zhi-qi.html">
-
-
- 控制器
-
- </a>
-
-
- </li>
-
- <li class="chapter " data-level="1.2.4" data-path="mo-xing.html">
-
- <a href="mo-xing.html">
-
-
- 模型
-
- </a>
-
-
- </li>
-
- <li class="chapter " data-level="1.2.5" data-path="shi-tu.html">
-
- <a href="shi-tu.html">
-
-
- 视图
-
- </a>
-
-
- </li>
-
- </ul>
-
- </li>
-
- <li class="chapter " data-level="1.3" data-path="../qi-ta-bu-chong.html">
-
- <a href="../qi-ta-bu-chong.html">
-
-
- 其他补充
-
- </a>
-
-
- <ul class="articles">
-
-
- <li class="chapter " data-level="1.3.1" data-path="../qi-ta-bu-chong/param.html">
-
- <a href="../qi-ta-bu-chong/param.html">
-
-
- Param
-
- </a>
-
-
- </li>
-
- <li class="chapter " data-level="1.3.2" data-path="../qi-ta-bu-chong/tablehelper.html">
-
- <a href="../qi-ta-bu-chong/tablehelper.html">
-
-
- TableHelper
-
- </a>
-
-
- </li>
-
- <li class="chapter " data-level="1.3.3" data-path="../qi-ta-bu-chong/ke-zhi-xing-jiao-ben.html">
-
- <a href="../qi-ta-bu-chong/ke-zhi-xing-jiao-ben.html">
-
-
- 可执行脚本
-
- </a>
-
-
- </li>
-
- </ul>
-
- </li>
-
-
- <li class="divider"></li>
- <li>
- <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
- Published with GitBook
- </a>
- </li>
- </ul>
- </nav>
-
-
- </div>
- <div class="book-body">
-
- <div class="body-inner">
-
-
- <div class="book-header" role="navigation">
-
- <!-- Title -->
- <h1>
- <i class="fa fa-circle-o-notch fa-spin"></i>
- <a href=".." >控制器</a>
- </h1>
- </div>
- <div class="page-wrapper" tabindex="-1" role="main">
- <div class="page-inner">
-
- <div id="book-search-results">
- <div class="search-noresults">
-
- <section class="normal markdown-section">
-
- <h3 id="控制器">控制器</h3>
- <h6 id="命名约定">命名约定</h6>
- <p>类名使用UpperCamelCase风格, <code>XxxController</code>,Controller结尾,文件名和类名保持一致,继承<code>BaseController</code>。</p>
- <p>方法<code>actionXxx</code>,action开头,参数固定为<code>$args</code>接收请求数据(等效于$REQUEST)。</p>
- <p>示例:</p>
- <pre><code class="lang-php"><span class="hljs-comment">// file: FooController.php</span>
- <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">FooController</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">BaseController</span> </span>{
- <span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">actionBar</span><span class="hljs-params">($args)</span> </span>{
- <span class="hljs-comment">// code</span>
- }
- }
- </code></pre>
- <h6 id="登录态校验">登录态校验</h6>
- <p>重写<code>$loginActions</code>或者<code>$ajaxLoginActions</code>配置,区别在于校验失败返回数据格式不一样。</p>
- <p>校验方法为<code>User::checkLogin()</code>项目各自实现。</p>
- <p>示例:</p>
- <pre><code class="lang-php"><span class="hljs-keyword">protected</span> $loginActions = [
- <span class="hljs-string">'foo'</span>, <span class="hljs-comment">//不带action前缀</span>
- ];
- <span class="hljs-keyword">protected</span> $ajaxLoginAction = [
- <span class="hljs-string">'bar'</span>,
- ];
- </code></pre>
- <h6 id="参数校验">参数校验</h6>
- <p>任何需要接受参数的方法都应该使用<a href="../qi-ta-bu-chong/param.html"><code>Param</code></a>进行参数校验过滤,常用校验方法有<code>Param::checkParam</code>和<code>Param:checkParam2</code>区别在于<code>Param::checkParam2</code>会删除没定义校验规则的参数。</p>
- <p>实例:</p>
- <pre><code class="lang-php"><span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">actionFoo</span><span class="hljs-params">($args)</span> </span>{
- $rules = [
- <span class="hljs-string">'id'</span> => [<span class="hljs-string">'int'</span>, <span class="hljs-string">'desc'</span> => <span class="hljs-string">'用户id'</span>],
- ];
- Param::checkParam($rules, $args);
- }
- <span class="hljs-comment">// input: id=123&name=solu</span>
- <span class="hljs-comment">// output: $args = ['id' => 123, 'name' => 'solu'];</span>
- <span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">actionBar</span><span class="hljs-params">($args)</span> </span>{
- $rules = [
- <span class="hljs-string">'id'</span> => [<span class="hljs-string">'int'</span>, <span class="hljs-string">'desc'</span> => <span class="hljs-string">'用户id'</span>],
- ];
- Param::checkParam2($rules, $args);
- }
- <span class="hljs-comment">// input: id=123&name=solu</span>
- <span class="hljs-comment">// output: $args = ['id' => 123];</span>
- </code></pre>
- <h6 id="接口文档">接口文档</h6>
- <p>接口文档是通过反射解析<code>方法注释</code>和<code>$rules</code>参数校验规则自动生成,所以要求每个对外接口都要有相应注释。如果不想接口出现在文档可以添加<code>@ignore</code>注释。</p>
- <p>示例:</p>
- <pre><code class="lang-php"><span class="hljs-comment">/**
- * 测试接口
- * <span class="hljs-doctag">@author</span> solu
- */</span>
- <span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">actionFoo</span><span class="hljs-params">($args)</span> </span>{
- $rules = [
- <span class="hljs-string">'id'</span> => [<span class="hljs-string">'int'</span>, <span class="hljs-string">'desc'</span> => <span class="hljs-string">'用户id'</span>],
- ];
- Param::checkParam2($rules, $args);
- }
- </code></pre>
- <p>浏览<code>测试环境</code>//HOST/CONTROLLER/ACTION?doc=class 可预览文档。</p>
- <p><img src="../assets/doc.png" alt=""></p>
-
- </section>
-
- </div>
- <div class="search-results">
- <div class="has-results">
-
- <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
- <ul class="search-results-list"></ul>
-
- </div>
- <div class="no-results">
-
- <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
-
- </div>
- </div>
- </div>
- </div>
- </div>
-
- </div>
-
-
- <a href="lu-you.html" class="navigation navigation-prev " aria-label="Previous page: 路由">
- <i class="fa fa-angle-left"></i>
- </a>
-
-
- <a href="mo-xing.html" class="navigation navigation-next " aria-label="Next page: 模型">
- <i class="fa fa-angle-right"></i>
- </a>
-
-
-
- </div>
- <script>
- var gitbook = gitbook || [];
- gitbook.push(function() {
- gitbook.page.hasChanged({"page":{"title":"控制器","level":"1.2.3","depth":2,"next":{"title":"模型","level":"1.2.4","depth":2,"path":"chapter1/mo-xing.md","ref":"chapter1/mo-xing.md","articles":[]},"previous":{"title":"路由","level":"1.2.2","depth":2,"path":"chapter1/lu-you.md","ref":"chapter1/lu-you.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"chapter1/kong-zhi-qi.md","mtime":"2018-09-08T03:35:56.248Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-13T03:13:15.790Z"},"basePath":"..","book":{"language":""}});
- });
- </script>
- </div>
-
- <script src="../gitbook/gitbook.js"></script>
- <script src="../gitbook/theme.js"></script>
-
-
- <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-search/search.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
-
-
-
- <script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
-
-
- </body>
- </html>
|