creating_libraries.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  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/creating_libraries.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>当我们使用术语"类库"时,我们一般指的是位于<kbd>libraries</kbd> 文件夹中的类,它们在wiki的"类库参考"这个板块被讨论.在当前这个话题中,我们将讨论如何在 <dfn>application/libraries</dfn> 文件夹中建立你自己的类库,并使它们与全框架的资源维持分离.</p>
  62. <p>作为一个额外的功能,当你需要在原始类中简单地添加一些功能时,CodeIgniter能使你的类库<kbd>extend</kbd> 自原始类.你甚至可以通过在<dfn>application/libraries</dfn>文件夹下安放同名类库文件的方法来完全替换原始类.</p>
  63. <p>总之:</p>
  64. <ul>
  65. <li>你可以创建全新的类库.</li>
  66. <li>你可以扩展原始类库.</li>
  67. <li>你可以替换原始类库.</li>
  68. </ul>
  69. <p>以下页面将深入介绍这三个概念.</p>
  70. <p class="important"><strong>注意:</strong> 除了数据库类无法被扩展或替换,剩余其他类均可。</p>
  71. <h2>建立你的类库文件</h2>
  72. <p>你的类库文件必须保存在 <dfn>application/libraries</dfn> 文件夹,CodeIgniter将在这个文件夹中寻找并初始化它们.</p>
  73. <h2>命名约定</h2>
  74. <ul>
  75. <li>文件名首字母大写. 例如:&nbsp; <dfn>Myclass.php</dfn></li>
  76. <li>类声明首字母大写. 例如:&nbsp; <kbd>class Myclass</kbd></li>
  77. <li>类的名字和文件名应相同.</li>
  78. </ul>
  79. <h2>类文件</h2>
  80. <p>所有的类应有基础原型(注意,这里我们以 <kbd>Someclass</kbd> 这个名字为例):</p>
  81. <code>&lt;?php if (!defined('BASEPATH')) exit('No direct script access allowed');
  82. <br /><br />
  83. class Someclass &#123;<br />
  84. <br />
  85. &nbsp;&nbsp;&nbsp;&nbsp;public function some_function()<br />
  86. &nbsp;&nbsp;&nbsp;&nbsp;&#123;<br />
  87. &nbsp;&nbsp;&nbsp;&nbsp;&#125;<br />
  88. &#125;<br /><br />
  89. /* End of file Someclass.php */</code>
  90. <h2>使用你自己的类</h2>
  91. <p>在所有的<a href="controllers.html">Controller</a> 函数中,你可以用以下的标准方式初始化你的类:</p>
  92. <code>$this-&gt;load-&gt;library('<kbd>someclass</kbd>');</code>
  93. <p>当 <em>someclass</em> 是文件名时,不用加上".php"扩展名.这里名字不分大小写.</p>
  94. <p>一旦你自定义的类加载完毕,你可以通过以下方式调用类,注意使用 <kbd>小写</kbd> 的名字:</p>
  95. <code>$this-&gt;<kbd>someclass</kbd>-&gt;some_function();&nbsp; // 对象的实例名永远都是小写的
  96. </code>
  97. <h2>在初始化自定义类时传递参数</h2>
  98. <p>当初始化类库时,你可以通过第二个参数动态的传递数组到类的构造函数中去:</p>
  99. <code>
  100. $params = array('type' => 'large', 'color' => 'red');<br />
  101. <br />
  102. $this-&gt;load-&gt;library('Someclass', <kbd>$params</kbd>);</code>
  103. <p>当你使用这个特性时,你必须为类的构造函数加上参数:</p>
  104. <code>&lt;?php if (!defined('BASEPATH')) exit('No direct script access allowed');<br />
  105. <br />
  106. class Someclass &#123;<br />
  107. <br />
  108. &nbsp;&nbsp;&nbsp;&nbsp;public function __construct($params)<br />
  109. &nbsp;&nbsp;&nbsp;&nbsp;&#123;<br />
  110. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// Do something with $params<br />
  111. &nbsp;&nbsp;&nbsp;&nbsp;&#125;<br />
  112. &#125;<br /><br />
  113. ?&gt;</code>
  114. <p class="important">你也可以传递存于配置文件中的参数.你只需简单的建立一个与 <kbd>类文件名</kbd>相同的config文件,并保存在 <dfn>application/config/</dfn> 文件夹中.注意当你通过上文所述的方式动态传递参数时,config文件中的选项将不起作用.</p>
  115. <h2>在你自定义的类库中初始化CodeIgniter资源</h2>
  116. <p>要你自定义的类库中访问CodeIgniter的原始资源,你必须使用 <kbd>get_instance()</kbd> 函数.这个函数返回一个CodeIgniter super object.</p>
  117. <p>一般来说在你的控制器函数中你可以通过 <kbd>$this</kbd> 调用任何可用的CodeIgniter函数:</p>
  118. <code>
  119. <strong>$this</strong>-&gt;load-&gt;helper('url');<br />
  120. <strong>$this</strong>-&gt;load-&gt;library('session');<br />
  121. <strong>$this</strong>-&gt;config-&gt;item('base_url');<br />
  122. //etc.
  123. </code>
  124. <p><kbd>$this</kbd>, 只直接作用在你自己的控制器,模型和视图中.当你在自定义类中想使用CodeIgniter原始类时,你可以这样做:</p>
  125. <p>首先,定义CodeIgniter对象赋给一个变量:</p>
  126. <code>$CI =& get_instance();</code>
  127. <p>一旦定义某个对象为一个变量,你就可以使用那个变量名 <em>取代</em> <kbd>$this</kbd>:</p>
  128. <code>
  129. $CI =& get_instance();<br /><br />
  130. $CI-&gt;load-&gt;helper('url');<br />
  131. $CI-&gt;load-&gt;library('session');<br />
  132. $CI-&gt;config-&gt;item('base_url');<br />
  133. //etc.
  134. </code>
  135. <p class="important"><strong>注意:</strong> 你将注意到get_instance()这个函数通过被引用的方式被传递:<br /><br />
  136. <var>$CI =&amp; get_instance();</var>
  137. <br /><br />
  138. <kbd>这十分重要.</kbd> 通过引用的方式赋给变量将使用原始的 CodeIgniter 对象,而不是创建一个副本。</p>
  139. <h2>用你自己的类替换原始类</h2>
  140. <p>简单的将你自己的类命名为与原始类一样就能使CodeIgniter使用这个新类.要使用这个特性,文件名与类声明必须与原始类完全一致。例如,要替换原始的 <kbd>Email</kbd> 类库。你必须创建一个文件<dfn>application/libraries/Email.php</dfn>, 并按如下方式声明类:</p>
  141. <code>
  142. class CI_Email &#123;<br /><br />
  143. &#125;</code>
  144. <p>注意大多数原始类以<kbd>CI_</kbd>为前缀.</p>
  145. <p>你可以只用标准载入函数来载入你自己的类:</p>
  146. <code>$this-&gt;load-&gt;library('<kbd>email</kbd>');</code>
  147. <p class="important"><strong>注意:</strong> 这个时候Database无法替换为你自定义的类.</p>
  148. <h2>扩展现有类</h2>
  149. <p>如果你需要在现有类库中加入一两个新的功能,那就完全不必要替换整个类库文件.你只需简单地扩展(继承)现有的类,扩展一个类就像在类中增加一些例外:</p>
  150. <ul>
  151. <li>扩展的类必须申明由父类扩展而来.</li>
  152. <li>新扩展的类所在的文件必须以 <kbd>MY_</kbd> 为前缀(这个选项是可配置的,下面有说明).</li>
  153. </ul>
  154. <p>例如,要扩展原始类 <kbd>Email</kbd> 类你要建立文件 <dfn>application/libraries/</dfn><kbd>MY_Email.php</kbd>, 并按如下方式在文件中声明:</p>
  155. <code>
  156. class MY_Email extends CI_Email &#123;<br /><br />
  157. &#125;</code>
  158. <p>注意:如果你需要在类中使用构造函数,你必须在构造函数中显式继承父类构造函数:</p>
  159. <code>
  160. class MY_Email extends CI_Email &#123;<br />
  161. <br />
  162. &nbsp;&nbsp;&nbsp;&nbsp;public function __construct()<br />
  163. &nbsp;&nbsp;&nbsp;&nbsp;&#123;<br />
  164. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parent::__construct();<br />
  165. &nbsp;&nbsp;&nbsp;&nbsp;&#125;<br />
  166. &#125;</code>
  167. <h3>载入你的子类</h3>
  168. <p>要载入扩展子类,你应该使用标准字符名. 请不要使用前缀. 例如,要载入上文说过的email扩展子类,你应该这样写:</p>
  169. <code>$this-&gt;load-&gt;library('<kbd>email</kbd>');</code>
  170. <p>扩展子类一旦被载入,就能像一般的类一样使用它们. Email类中的所有函数就能被调用:</p>
  171. <code>$this-&gt;<kbd>email</kbd>-&gt;some_function();</code>
  172. <h3>设定自定义前缀</h3>
  173. <p>要设定你自己的子类前缀,请打开 <dfn>application/config/config.php</dfn> 文件并找到这一项:</p>
  174. <code>$config['subclass_prefix'] = 'MY_';</code>
  175. <p>注意所有原始CodeIgniter类库以 <kbd>CI_</kbd> 作为前缀,所以请勿以CI_作为你自己的前缀.</p><p>&nbsp;</p>
  176. <div id="Contributors">
  177. 翻译贡献者:
  178. benfeng, billycui, Deloz, dustin, Hex, IT不倒翁, shishirui, soyota, thinksand, walkbird, 志明</div>
  179. <div id="DocDate">
  180. 最后修改: 2014-04-09 17:17:10</div>
  181. </div>
  182. <!-- END CONTENT -->
  183. <div id="footer">
  184. <p>
  185. 上一个主题:&nbsp;&nbsp;<a href="libraries.html">使用 CodeIgniter 程序库</a>&nbsp;&nbsp;&middot;&nbsp;&nbsp;<a href="#top">页首</a>
  186. &nbsp;&middot;&nbsp;&nbsp;<a href="../index.html">用户指南首页</a>&nbsp;&nbsp;&middot;&nbsp;&nbsp;下一个主题:&nbsp;&nbsp;<a href="drivers.html">使用 CodeIgniter 适配器</a> </p>
  187. <p><a href="#">CodeIgniter</a> &nbsp;&middot;&nbsp; 版权所有 &#169; 2006-2013 &nbsp;&middot;&nbsp; <a href="#">Ellislab, Inc.</a></p>
  188. <p>中文化: <a href="#">CodeIgniter 中国</a> &nbsp;&middot;&nbsp; 制作: Hex &nbsp;&middot;&nbsp; 版本: 1.30 &nbsp;&middot;&nbsp; 鸣谢: 子非鱼</p>
  189. </div>
  190. </body>
  191. </html>