helpers.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="utf-8" lang="utf-8">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=0" />
  6. <title>辅助函数 - CodeIgniter 中文手册|用户手册|用户指南|Wiki文档</title>
  7. <link rel="shortcut icon" href="http://codeigniter.org.cn/user_guide/../images/design/favicon.ico" type="image/x-icon" />
  8. <link rel="stylesheet" type="text/css" media="all" href="../userguide.css" />
  9. <link rel="search" href="http://codeigniter.org.cn/user_guide/../CodeIgniterSearch.xml" type="application/opensearchdescription+xml" title="CodeIgniter 搜索"/>
  10. <link rel="canonical" href="http://codeigniter.org.cn/user_guide/general/helpers.html" />
  11. <script type="text/javascript" src="../nav/mootools.js-ver=20130324.js"></script>
  12. <script type="text/javascript" src="../nav/mootools-more.js-ver=20130324.js"></script>
  13. <script type="text/javascript" src="../nav/nav.js-ver=20130324.js"></script>
  14. <script type="text/javascript" src="../nav/user_guide_menu.js-ver=20130324.js"></script>
  15. <meta name="robots" content="all" />
  16. <meta name="author" content="ExpressionEngine Dev Team" />
  17. <meta name="description" content="CodeIgniter 中文手册, CodeIgniter 用户指南, CodeIgniter User Guide, Wiki 文档" />
  18. </head>
  19. <body>
  20. <!-- START NAVIGATION -->
  21. <div id="nav">
  22. <div id="nav_inner">
  23. <script type="text/javascript">create_menu('../');</script>
  24. </div>
  25. </div>
  26. <script type="text/javascript">_setNavigation();</script>
  27. <div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="切换目录" alt="切换目录" /></a></div>
  28. <div id="masthead" class="clearfix">
  29. <div class="topbar-hd"><h1>CodeIgniter 用户指南 版本 2.2.0</h1></div>
  30. <div class="topbar-tip">编辑文档、查看近期更改请 <a href="#">登录</a> 或 <a href="#">注册</a>  <a href="#">找回密码</a></div> <div id="breadcrumb_right"><a href="../toc.html">目录页</a></div>
  31. </div>
  32. <!-- END NAVIGATION -->
  33. <!-- START BREADCRUMB -->
  34. <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  35. <tr>
  36. <td id="breadcrumb">
  37. <a href="#" target="_blank">CodeIgniter 中国首页</a>&nbsp;&#8250;&nbsp;
  38. <a href="../index.html">用户指南首页</a>&nbsp;&#8250;&nbsp;辅助函数 </td>
  39. <td id="searchbox">
  40. <form method="get" action="http://www.google.com.hk/search" target="google_window">
  41. <input type="hidden" name="client" value="pub-0176846097796333"></input>
  42. <input type="hidden" name="forid" value="1"></input>
  43. <input type="hidden" name="ie" value="UTF-8"></input>
  44. <input type="hidden" name="oe" value="UTF-8"></input>
  45. <input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.org.cn/user_guide/" />
  46. 搜索用户指南&nbsp;
  47. <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />
  48. &nbsp;
  49. <input type="submit" class="submit" name="sa" value="Go" />
  50. </form>
  51. </td>
  52. </tr>
  53. </table>
  54. <!-- END BREADCRUMB -->
  55. <div style="clear:both;text-align:right;padding: 6px 40px 0 0;">
  56. <a href="#" target="_blank">查看原文</a>
  57. </div>
  58. <!--<br clear="all" />--><!-- START CONTENT -->
  59. <div id="content">
  60. <h1>辅助函数</h1>
  61. <p>辅助函数,顾名思义,是帮助我们完成特定任务的函数。每个辅助函数文件仅仅是一些函数的集合。例如,<dfn>URL Helpers</dfn> 可以帮助我们创建链接,<dfn>Form Helpers</dfn> 可以帮助我们创建表单,<dfn>Text Helpers</dfn> 提供一系列的格式化输出方式,<dfn>Cookie Helpers</dfn> 能帮助我们设置和读取COOKIE, <dfn>File Helpers</dfn> 能帮助我们处理文件,等等。</p>
  62. <p>跟其他部分不同的是,辅助函数不是用类的方式来实现的。它们仅仅是一些简单的过程处理函数。
  63. 每个辅助函数处理一个特定的任务,并且不必依靠其他函数。</p>
  64. <p>CodeIgniter 默认是没有载入辅助函数文件的,所以如果你想用辅助函数,就必须先载入它。
  65. 一旦被载入,辅助函数将全局可用(globally available),你可以在 <a href="controllers.html">controller</a> 和 <a href="views.html">views</a> 中使用它们。</p>
  66. <p>辅助函数文件一般保存在 <dfn>system/helpers</dfn> 或 <dfn>application/helpers</dfn> 文件夹中。CodeIgniter 将会先在 <dfn>application/helpers</dfn> 寻找对应的辅助函数文件,
  67. 如果目录不存在或者目录下没有对应的辅助函数文件,CI 才会载入 <dfn>system/helpers</dfn> 下的辅助函数文件。</p>
  68. <h2>载入辅助函数</h2>
  69. <p>载入辅助函数是非常简单的:</p>
  70. <code>$this-&gt;load-&gt;helper('<var>name</var>');</code>
  71. <p><var>name</var> 是辅助函数文件的名字(不带.php后缀 和"helper" 部分)。</p>
  72. <p>例如,要载入文件名为<var>url_helper.php</var>的<dfn>URL Helper</dfn>,你将会用到下面的语句:</p>
  73. <code>$this-&gt;load-&gt;helper('<var>url</var>');</code>
  74. <p>辅助函数可以在你的控制器(controller)的任何地方被载入,甚至可以在视图(View)文件中被载入(我们并不建议你这么做)。
  75. 请在使用辅助函数之前载入他们。你可以在你的控制器构造函数中载入它们,以便辅助函数能自动在其他函数之前被载入。你也可以在要用到辅助函数的地方当场载入。</p>
  76. <p class="important">注意: 辅助函数载入函数并不返回值,所以不要尝试将它付给一个变量,直接像这样用就可以了。</p>
  77. <h2>载入多个辅助函数</h2>
  78. <p>如果你想一次载入多个辅助函数,你可以这样做:</p>
  79. <code>$this-&gt;load-&gt;helper( <samp>array(</samp>'<var>helper1</var>', '<var>helper2</var>', '<var>helper3</var>'<samp>)</samp> );</code>
  80. <h2>自动载入辅助函数</h2>
  81. <p>如果你想要的话,CodeIgniter可以自动为你载入辅助函数。你可以通过打开 <var>application/config/autoload.php</var> ,并往自动载入数组(autoload array)中增加辅助函数来实现。</p>
  82. <h2>使用辅助函数</h2>
  83. <p>一旦你载入了想要用到辅助函数文件,你就可以用标准的函数调用方法来使用里面的函数。</p>
  84. <p>例如,要使用<dfn>anchor()</dfn> 函数来建立一个链接,在视图(View)文件里面你可以这样做:</p>
  85. <code>&lt;?php echo anchor('blog/comments', 'Click Here');?&gt;</code>
  86. <p>"Click Here" 是链接的名字,"blog/comments" 是链接的URI。</p>
  87. <p>注意:辅助函数中的函数名最好做好命名规范,如果同时加载多个辅助函数文件,且其中有名称相同的函数,会导致 CI 出现空白页问题(也就是 PHP 语法错误)。</p>
  88. <h2>“扩展”辅助函数</h2>
  89. <p>你如果想 "扩展"一个原有的 Helpers,可以在你的 <dfn>application/helpers/</dfn> 目录下创建一个新的helper,新的helper的名字是在被“扩展”的Helper的名字开头多加一个 <kbd>MY_</kbd> (这是可以配置的. 见下.).</p>
  90. <p>如果你想做的只是在原有的helper中添加一些新的功能,比如,添加一两个新的方法,或者是修改一个方法;就不值得重写自己的helper。在这种情况下,最好是“扩展”已有的helper。“扩展”一词用在这里不是很恰当,因为Helper的方法是过程式的(procedural) 和离散(discrete)的,在传统的语言环境中无法被“扩展”,不过在CodeIgniter中,你可以添加或修改helper的方法。
  91. </p>
  92. <p>例如,扩展一个本地已有的 <kbd>Array Helper</kbd> 你应该建立一个文件: <dfn>application/helpers/</dfn><kbd>MY_array_helper.php</kbd>, 并添加或重写(override)其中的一些方法:</p>
  93. <code>
  94. // any_in_array() is not in the Array Helper, so it defines a new function<br />
  95. function any_in_array($needle, $haystack)<br />
  96. &#123;<br />
  97. &nbsp;&nbsp;&nbsp;&nbsp;$needle = (is_array($needle)) ? $needle : array($needle);<br />
  98. <br />
  99. &nbsp;&nbsp;&nbsp;&nbsp;foreach ($needle as $item)<br />
  100. &nbsp;&nbsp;&nbsp;&nbsp;&#123;<br />
  101. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (in_array($item, $haystack))<br />
  102. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#123;<br />
  103. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return TRUE;<br />
  104. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#125;<br />
  105. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#125;<br />
  106. <br />
  107. &nbsp;&nbsp;&nbsp;&nbsp;return FALSE;<br />
  108. &#125;<br />
  109. <br />
  110. // random_element() is included in Array Helper, so it overrides the native function<br />
  111. function random_element($array)<br />
  112. &#123;<br />
  113. &nbsp;&nbsp;&nbsp;&nbsp;shuffle($array);<br />
  114. &nbsp;&nbsp;&nbsp;&nbsp;return array_pop($array);<br />
  115. &#125;<br />
  116. </code>
  117. <h3>设定你自己的前缀(Prefix)</h3>
  118. <p>用于"扩展" helper 而加上前缀的文件同样也是对库和核心类的扩展.为了设置你自定义的前缀,请打开 <dfn>application/config/config.php</dfn> 文件,然后找到如下的条目:</p>
  119. <code>$config['subclass_prefix'] = 'MY_';</code>
  120. <p>请注意:由于所有CodeIgniter自带的库都被冠以 <kbd>CI_</kbd> 这样的前缀命名,所以请不要使用<kbd>CI_</kbd>来自定义前缀.</p>
  121. <h2>现在可以做什么?</h2>
  122. <p>在<a href="../toc.html">目录</a>里面有所有辅助函数的列表,你可以打开每个文件看看他们都能做些什么。</p>
  123. <p>不过目前还没有想到更好的方法让我们如何记住这些辅助函数!要不编辑个快速查询手册??如果你有更好的方法请告诉我!</p><p>&nbsp;</p>
  124. <div id="Contributors">
  125. 翻译贡献者:
  126. architectcom, borisauschina, chenshenghan, csfhc, Hex, levin, lishen2, longbill, ripen, sheshi37c, shishirui, tangjianft, thankwsx, Xwoder</div>
  127. <div id="DocDate">
  128. 最后修改: 2014-06-05 10:17:46</div>
  129. </div>
  130. <!-- END CONTENT -->
  131. <div id="footer">
  132. <p>
  133. 上一个主题:&nbsp;&nbsp;<a href="models.html">模型</a>&nbsp;&nbsp;&middot;&nbsp;&nbsp;<a href="#top">页首</a>
  134. &nbsp;&middot;&nbsp;&nbsp;<a href="../index.html">用户指南首页</a>&nbsp;&nbsp;&middot;&nbsp;&nbsp;下一个主题:&nbsp;&nbsp;<a href="libraries.html">使用类库</a> </p>
  135. <p><a href="#">CodeIgniter</a> &nbsp;&middot;&nbsp; 版权所有 &#169; 2006-2013 &nbsp;&middot;&nbsp; <a href="#">Ellislab, Inc.</a></p>
  136. <p>中文化: <a href="#">CodeIgniter 中国</a> &nbsp;&middot;&nbsp; 制作: Hex &nbsp;&middot;&nbsp; 版本: 1.30 &nbsp;&middot;&nbsp; 鸣谢: 子非鱼</p>
  137. </div>
  138. </body>
  139. </html>