Etusivu Tutki Apua
Kirjaudu sisään
wangsaitao
/
guotianyun-sp-yh
1
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Branch: master
Branchit Tagit
guotianyun-s...
/
user_guide
/
general
/
creating_libraries.html

creating_libraries.html 51 KB
Pysyvä linkki Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    9. 

  9.   
    10. 

  10.   <title>Creating Libraries &mdash; CodeIgniter 3.1.11 documentation</title>
    11. 

  11.   
    12. 

  12. 

  13.   
    14. 

  14.   
    15. 

  15.     <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
    16. 

  16.   
    17. 

  17. 

  18.   
    19. 

  19.   <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   
    28. 

  28.   
    29. 

  29.     <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
    30. 

  30.   
    31. 

  31. 

  32.   
    33. 

  33.         <link rel="index" title="Index"
    34. 

  34.               href="../genindex.html"/>
    35. 

  35.         <link rel="search" title="Search" href="../search.html"/>
    36. 

  36.     <link rel="top" title="CodeIgniter 3.1.11 documentation" href="../index.html"/>
    37. 

  37.         <link rel="up" title="General Topics" href="index.html"/>
    38. 

  38.         <link rel="next" title="Using CodeIgniter Drivers" href="drivers.html"/>
    39. 

  39.         <link rel="prev" title="Using CodeIgniter Libraries" href="libraries.html"/> 
    40. 

  40. 

  41.   
    42. 

  42.   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
    43. 

  43. 

  44. </head>
    45. 

  45. 

  46. <body class="wy-body-for-nav" role="document">
    47. 

  47. 

  48.   <div id="nav">
    49. 

  49.   <div id="nav_inner">
    50. 

  50.     
    51. 

  51.     
    52. 

  52.     
    53. 

  53.       <div id="pulldown-menu" class="ciNav">
    54. 

  54.         <ul>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="welcome.html">Welcome to CodeIgniter</a></li>
    56. 

  56. </ul>
    57. 

  57. <ul>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    59. 

  59. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    60. 

  60. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    61. 

  61. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    62. 

  62. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    63. 

  63. </ul>
    64. 

  64. </li>
    65. 

  65. </ul>
    66. 

  66. <ul>
    67. 

  67. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    69. 

  69. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    71. 

  71. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    72. 

  72. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    73. 

  73. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    74. 

  74. </ul>
    75. 

  75. </li>
    76. 

  76. </ul>
    77. 

  77. <ul>
    78. 

  78. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    80. 

  80. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    82. 

  82. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    83. 

  83. </ul>
    84. 

  84. </li>
    85. 

  85. </ul>
    86. 

  86. <ul>
    87. 

  87. <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
    88. 

  88. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    90. 

  90. </ul>
    91. 

  91. </li>
    92. 

  92. </ul>
    93. 

  93. <ul class="current">
    94. 

  94. <li class="toctree-l1 current"><a class="reference internal" href="index.html">General Topics</a><ul class="current">
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="urls.html">CodeIgniter URLs</a></li>
    96. 

  96. <li class="toctree-l2"><a class="reference internal" href="controllers.html">Controllers</a></li>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="reserved_names.html">Reserved Names</a></li>
    98. 

  98. <li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
    99. 

  99. <li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
    100. 

  100. <li class="toctree-l2"><a class="reference internal" href="helpers.html">Helpers</a></li>
    101. 

  101. <li class="toctree-l2"><a class="reference internal" href="libraries.html">Using CodeIgniter Libraries</a></li>
    102. 

  102. <li class="toctree-l2 current"><a class="current reference internal" href="#">Creating Libraries</a></li>
    103. 

  103. <li class="toctree-l2"><a class="reference internal" href="drivers.html">Using CodeIgniter Drivers</a></li>
    104. 

  104. <li class="toctree-l2"><a class="reference internal" href="creating_drivers.html">Creating Drivers</a></li>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="core_classes.html">Creating Core System Classes</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="ancillary_classes.html">Creating Ancillary Classes</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="hooks.html">Hooks - Extending the Framework Core</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="autoloader.html">Auto-loading Resources</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="common_functions.html">Common Functions</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="compatibility_functions.html">Compatibility Functions</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="routing.html">URI Routing</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="errors.html">Error Handling</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="profiling.html">Profiling Your Application</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="cli.html">Running via the CLI</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="managing_apps.html">Managing your Applications</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="environments.html">Handling Multiple Environments</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="styleguide.html">PHP Style Guide</a></li>
    121. 

  121. </ul>
    122. 

  122. </li>
    123. 

  123. </ul>
    124. 

  124. <ul>
    125. 

  125. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    148. 

  148. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    149. 

  149. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    150. 

  150. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    151. 

  151. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    152. 

  152. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    153. 

  153. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    156. 

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. <ul>
    160. 

  160. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    161. 

  161. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    162. 

  162. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    163. 

  163. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    165. 

  165. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    167. 

  167. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    168. 

  168. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    169. 

  169. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    170. 

  170. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    171. 

  171. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    172. 

  172. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    173. 

  173. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    174. 

  174. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    175. 

  175. </ul>
    176. 

  176. </li>
    177. 

  177. </ul>
    178. 

  178. <ul>
    179. 

  179. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    180. 

  180. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    181. 

  181. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    182. 

  182. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    183. 

  183. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    184. 

  184. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    185. 

  185. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    186. 

  186. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    187. 

  187. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    188. 

  188. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    189. 

  189. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    190. 

  190. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    191. 

  191. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    192. 

  192. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    193. 

  193. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    194. 

  194. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    195. 

  195. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    196. 

  196. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    197. 

  197. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    198. 

  198. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    199. 

  199. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    200. 

  200. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    201. 

  201. </ul>
    202. 

  202. </li>
    203. 

  203. </ul>
    204. 

  204. 

  205.       </div>
    206. 

  206.     
    207. 

  207.       
    208. 

  208.   </div>
    209. 

  209. </div>
    210. 

  210. <div id="nav2">
    211. 

  211.   <a href="#" id="openToc">
    212. 

  212.     <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
    213. 

  213.   </a>
    214. 

  214. </div>
    215. 

  215. 

  216.   <div class="wy-grid-for-nav">
    217. 

  217. 

  218.     
    219. 

  219.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    220. 

  220.       <div class="wy-side-nav-search">
    221. 

  221.         
    222. 

  222.           <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
    223. 

  223.         
    224. 

  224.         
    225. 

  225. <div role="search">
    226. 

  226.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    227. 

  227.     <input type="text" name="q" placeholder="Search docs" />
    228. 

  228.     <input type="hidden" name="check_keywords" value="yes" />
    229. 

  229.     <input type="hidden" name="area" value="default" />
    230. 

  230.   </form>
    231. 

  231. </div>
    232. 

  232.       </div>
    233. 

  233. 

  234.       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    235. 

  235.         
    236. 

  236.           
    237. 

  237.           
    238. 

  238.               <ul>
    239. 

  239. <li class="toctree-l1"><a class="reference internal" href="welcome.html">Welcome to CodeIgniter</a></li>
    240. 

  240. </ul>
    241. 

  241. <ul>
    242. 

  242. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    243. 

  243. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    244. 

  244. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    245. 

  245. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    246. 

  246. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    247. 

  247. </ul>
    248. 

  248. </li>
    249. 

  249. </ul>
    250. 

  250. <ul>
    251. 

  251. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    252. 

  252. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    253. 

  253. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    254. 

  254. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    255. 

  255. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    257. 

  257. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    258. 

  258. </ul>
    259. 

  259. </li>
    260. 

  260. </ul>
    261. 

  261. <ul>
    262. 

  262. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    263. 

  263. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    264. 

  264. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    265. 

  265. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    266. 

  266. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    267. 

  267. </ul>
    268. 

  268. </li>
    269. 

  269. </ul>
    270. 

  270. <ul>
    271. 

  271. <li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
    272. 

  272. <li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
    273. 

  273. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    274. 

  274. </ul>
    275. 

  275. </li>
    276. 

  276. </ul>
    277. 

  277. <ul class="current">
    278. 

  278. <li class="toctree-l1 current"><a class="reference internal" href="index.html">General Topics</a><ul class="current">
    279. 

  279. <li class="toctree-l2"><a class="reference internal" href="urls.html">CodeIgniter URLs</a></li>
    280. 

  280. <li class="toctree-l2"><a class="reference internal" href="controllers.html">Controllers</a></li>
    281. 

  281. <li class="toctree-l2"><a class="reference internal" href="reserved_names.html">Reserved Names</a></li>
    282. 

  282. <li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
    283. 

  283. <li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
    284. 

  284. <li class="toctree-l2"><a class="reference internal" href="helpers.html">Helpers</a></li>
    285. 

  285. <li class="toctree-l2"><a class="reference internal" href="libraries.html">Using CodeIgniter Libraries</a></li>
    286. 

  286. <li class="toctree-l2 current"><a class="current reference internal" href="#">Creating Libraries</a></li>
    287. 

  287. <li class="toctree-l2"><a class="reference internal" href="drivers.html">Using CodeIgniter Drivers</a></li>
    288. 

  288. <li class="toctree-l2"><a class="reference internal" href="creating_drivers.html">Creating Drivers</a></li>
    289. 

  289. <li class="toctree-l2"><a class="reference internal" href="core_classes.html">Creating Core System Classes</a></li>
    290. 

  290. <li class="toctree-l2"><a class="reference internal" href="ancillary_classes.html">Creating Ancillary Classes</a></li>
    291. 

  291. <li class="toctree-l2"><a class="reference internal" href="hooks.html">Hooks - Extending the Framework Core</a></li>
    292. 

  292. <li class="toctree-l2"><a class="reference internal" href="autoloader.html">Auto-loading Resources</a></li>
    293. 

  293. <li class="toctree-l2"><a class="reference internal" href="common_functions.html">Common Functions</a></li>
    294. 

  294. <li class="toctree-l2"><a class="reference internal" href="compatibility_functions.html">Compatibility Functions</a></li>
    295. 

  295. <li class="toctree-l2"><a class="reference internal" href="routing.html">URI Routing</a></li>
    296. 

  296. <li class="toctree-l2"><a class="reference internal" href="errors.html">Error Handling</a></li>
    297. 

  297. <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching</a></li>
    298. 

  298. <li class="toctree-l2"><a class="reference internal" href="profiling.html">Profiling Your Application</a></li>
    299. 

  299. <li class="toctree-l2"><a class="reference internal" href="cli.html">Running via the CLI</a></li>
    300. 

  300. <li class="toctree-l2"><a class="reference internal" href="managing_apps.html">Managing your Applications</a></li>
    301. 

  301. <li class="toctree-l2"><a class="reference internal" href="environments.html">Handling Multiple Environments</a></li>
    302. 

  302. <li class="toctree-l2"><a class="reference internal" href="alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    303. 

  303. <li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li>
    304. 

  304. <li class="toctree-l2"><a class="reference internal" href="styleguide.html">PHP Style Guide</a></li>
    305. 

  305. </ul>
    306. 

  306. </li>
    307. 

  307. </ul>
    308. 

  308. <ul>
    309. 

  309. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    310. 

  310. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    311. 

  311. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    312. 

  312. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    313. 

  313. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    314. 

  314. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    315. 

  315. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    316. 

  316. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    317. 

  317. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    318. 

  318. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    319. 

  319. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    320. 

  320. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    321. 

  321. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    322. 

  322. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    323. 

  323. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    324. 

  324. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    326. 

  326. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    327. 

  327. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    328. 

  328. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    330. 

  330. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    331. 

  331. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    332. 

  332. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    333. 

  333. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    334. 

  334. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    335. 

  335. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    336. 

  336. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    337. 

  337. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    338. 

  338. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    339. 

  339. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    340. 

  340. </ul>
    341. 

  341. </li>
    342. 

  342. </ul>
    343. 

  343. <ul>
    344. 

  344. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    345. 

  345. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    346. 

  346. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    347. 

  347. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    348. 

  348. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    349. 

  349. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    350. 

  350. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    351. 

  351. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    352. 

  352. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    353. 

  353. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    354. 

  354. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    355. 

  355. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    356. 

  356. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    357. 

  357. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    358. 

  358. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    359. 

  359. </ul>
    360. 

  360. </li>
    361. 

  361. </ul>
    362. 

  362. <ul>
    363. 

  363. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    364. 

  364. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    365. 

  365. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    366. 

  366. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    367. 

  367. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    368. 

  368. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    369. 

  369. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    370. 

  370. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    371. 

  371. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    372. 

  372. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    373. 

  373. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    374. 

  374. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    375. 

  375. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    376. 

  376. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    377. 

  377. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    378. 

  378. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    379. 

  379. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    380. 

  380. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    381. 

  381. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    382. 

  382. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    383. 

  383. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    384. 

  384. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    385. 

  385. </ul>
    386. 

  386. </li>
    387. 

  387. </ul>
    388. 

  388. 

  389.           
    390. 

  390.         
    391. 

  391.       </div>
    392. 

  392.       &nbsp;
    393. 

  393.     </nav>
    394. 

  394. 

  395.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    396. 

  396. 

  397.       
    398. 

  398.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    399. 

  399.         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    400. 

  400.         <a href="../index.html">CodeIgniter</a>
    401. 

  401.       </nav>
    402. 

  402. 

  403. 

  404.       
    405. 

  405.       <div class="wy-nav-content">
    406. 

  406.         <div class="rst-content">
    407. 

  407.           <div role="navigation" aria-label="breadcrumbs navigation">
    408. 

  408.   <ul class="wy-breadcrumbs">
    409. 

  409.     <li><a href="../index.html">Docs</a> &raquo;</li>
    410. 

  410.       
    411. 

  411.         <li><a href="index.html">General Topics</a> &raquo;</li>
    412. 

  412.       
    413. 

  413.     <li>Creating Libraries</li>
    414. 

  414.     <li class="wy-breadcrumbs-aside">
    415. 

  415.       
    416. 

  416.     </li>
    417. 

  417.     <div style="float:right;margin-left:5px;" id="closeMe">
    418. 

  418.       <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
    419. 

  419.     </div>
    420. 

  420.   </ul>
    421. 

  421.   <hr/>
    422. 

  422. </div>
    423. 

  423.           <div role="main" class="document">
    424. 

  424.             
    425. 

  425.   <div class="section" id="creating-libraries">
    426. 

  426. <h1>Creating Libraries<a class="headerlink" href="#creating-libraries" title="Permalink to this headline">¶</a></h1>
    427. 

  427. <p>When we use the term “Libraries” we are normally referring to the
    428. 

  428. classes that are located in the libraries directory and described in the
    429. 

  429. Class Reference of this user guide. In this case, however, we will
    430. 

  430. instead describe how you can create your own libraries within your
    431. 

  431. application/libraries directory in order to maintain separation between
    432. 

  432. your local resources and the global framework resources.</p>
    433. 

  433. <p>As an added bonus, CodeIgniter permits your libraries to extend native
    434. 

  434. classes if you simply need to add some functionality to an existing
    435. 

  435. library. Or you can even replace native libraries just by placing
    436. 

  436. identically named versions in your <em>application/libraries</em> directory.</p>
    437. 

  437. <p>In summary:</p>
    438. 

  438. <ul class="simple">
    439. 

  439. <li>You can create entirely new libraries.</li>
    440. 

  440. <li>You can extend native libraries.</li>
    441. 

  441. <li>You can replace native libraries.</li>
    442. 

  442. </ul>
    443. 

  443. <p>The page below explains these three concepts in detail.</p>
    444. 

  444. <div class="admonition note">
    445. 

  445. <p class="first admonition-title">Note</p>
    446. 

  446. <p class="last">The Database classes can not be extended or replaced with your
    447. 

  447. own classes. All other classes are able to be replaced/extended.</p>
    448. 

  448. </div>
    449. 

  449. <div class="section" id="storage">
    450. 

  450. <h2>Storage<a class="headerlink" href="#storage" title="Permalink to this headline">¶</a></h2>
    451. 

  451. <p>Your library classes should be placed within your <em>application/libraries</em>
    452. 

  452. directory, as this is where CodeIgniter will look for them when they are
    453. 

  453. initialized.</p>
    454. 

  454. </div>
    455. 

  455. <div class="section" id="naming-conventions">
    456. 

  456. <h2>Naming Conventions<a class="headerlink" href="#naming-conventions" title="Permalink to this headline">¶</a></h2>
    457. 

  457. <ul class="simple">
    458. 

  458. <li>File names must be capitalized. For example: Myclass.php</li>
    459. 

  459. <li>Class declarations must be capitalized. For example: class Myclass</li>
    460. 

  460. <li>Class names and file names must match.</li>
    461. 

  461. </ul>
    462. 

  462. </div>
    463. 

  463. <div class="section" id="the-class-file">
    464. 

  464. <h2>The Class File<a class="headerlink" href="#the-class-file" title="Permalink to this headline">¶</a></h2>
    465. 

  465. <p>Classes should have this basic prototype:</p>
    466. 

  466. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
    467. 

  467. <span class="nb">defined</span><span class="p">(</span><span class="s1">&#39;BASEPATH&#39;</span><span class="p">)</span> <span class="k">OR</span> <span class="k">exit</span><span class="p">(</span><span class="s1">&#39;No direct script access allowed&#39;</span><span class="p">);</span>
    468. 

  468. 

  469. <span class="k">class</span> <span class="nc">Someclass</span> <span class="p">{</span>
    470. 

  470. 

  471.         <span class="k">public</span> <span class="k">function</span> <span class="nf">some_method</span><span class="p">()</span>
    472. 

  472.         <span class="p">{</span>
    473. 

  473.         <span class="p">}</span>
    474. 

  474. <span class="p">}</span>
    475. 

  475. </pre></div>
    476. 

  476. </div>
    477. 

  477. <div class="admonition note">
    478. 

  478. <p class="first admonition-title">Note</p>
    479. 

  479. <p class="last">We are using the name Someclass purely as an example.</p>
    480. 

  480. </div>
    481. 

  481. </div>
    482. 

  482. <div class="section" id="using-your-class">
    483. 

  483. <h2>Using Your Class<a class="headerlink" href="#using-your-class" title="Permalink to this headline">¶</a></h2>
    484. 

  484. <p>From within any of your <a class="reference internal" href="controllers.html"><span class="doc">Controller</span></a> methods you
    485. 

  485. can initialize your class using the standard:</p>
    486. 

  486. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">library</span><span class="p">(</span><span class="s1">&#39;someclass&#39;</span><span class="p">);</span>
    487. 

  487. </pre></div>
    488. 

  488. </div>
    489. 

  489. <p>Where <em>someclass</em> is the file name, without the “.php” file extension.
    490. 

  490. You can submit the file name capitalized or lower case. CodeIgniter
    491. 

  491. doesn’t care.</p>
    492. 

  492. <p>Once loaded you can access your class using the lower case version:</p>
    493. 

  493. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">someclass</span><span class="o">-&gt;</span><span class="na">some_method</span><span class="p">();</span><span class="nx"> </span> <span class="c1">// Object instances will always be lower case</span>
    494. 

  494. </pre></div>
    495. 

  495. </div>
    496. 

  496. </div>
    497. 

  497. <div class="section" id="passing-parameters-when-initializing-your-class">
    498. 

  498. <h2>Passing Parameters When Initializing Your Class<a class="headerlink" href="#passing-parameters-when-initializing-your-class" title="Permalink to this headline">¶</a></h2>
    499. 

  499. <p>In the library loading method you can dynamically pass data as an
    500. 

  500. array via the second parameter and it will be passed to your class
    501. 

  501. constructor:</p>
    502. 

  502. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$params</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">&#39;type&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;large&#39;</span><span class="p">,</span> <span class="s1">&#39;color&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;red&#39;</span><span class="p">);</span>
    503. 

  503. 

  504. <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">library</span><span class="p">(</span><span class="s1">&#39;someclass&#39;</span><span class="p">,</span> <span class="nv">$params</span><span class="p">);</span>
    505. 

  505. </pre></div>
    506. 

  506. </div>
    507. 

  507. <p>If you use this feature you must set up your class constructor to expect
    508. 

  508. data:</p>
    509. 

  509. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span> <span class="nb">defined</span><span class="p">(</span><span class="s1">&#39;BASEPATH&#39;</span><span class="p">)</span> <span class="k">OR</span> <span class="k">exit</span><span class="p">(</span><span class="s1">&#39;No direct script access allowed&#39;</span><span class="p">);</span>
    510. 

  510. 

  511. <span class="k">class</span> <span class="nc">Someclass</span> <span class="p">{</span>
    512. 

  512. 

  513.         <span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">(</span><span class="nv">$params</span><span class="p">)</span>
    514. 

  514.         <span class="p">{</span>
    515. 

  515.                 <span class="c1">// Do something with $params</span>
    516. 

  516.         <span class="p">}</span>
    517. 

  517. <span class="p">}</span>
    518. 

  518. </pre></div>
    519. 

  519. </div>
    520. 

  520. <p>You can also pass parameters stored in a config file. Simply create a
    521. 

  521. config file named identically to the class file name and store it in
    522. 

  522. your <em>application/config/</em> directory. Note that if you dynamically pass
    523. 

  523. parameters as described above, the config file option will not be
    524. 

  524. available.</p>
    525. 

  525. </div>
    526. 

  526. <div class="section" id="utilizing-codeigniter-resources-within-your-library">
    527. 

  527. <h2>Utilizing CodeIgniter Resources within Your Library<a class="headerlink" href="#utilizing-codeigniter-resources-within-your-library" title="Permalink to this headline">¶</a></h2>
    528. 

  528. <p>To access CodeIgniter’s native resources within your library use the
    529. 

  529. <code class="docutils literal"><span class="pre">get_instance()</span></code> method. This method returns the CodeIgniter super
    530. 

  530. object.</p>
    531. 

  531. <p>Normally from within your controller methods you will call any of the
    532. 

  532. available CodeIgniter methods using the <code class="docutils literal"><span class="pre">$this</span></code> construct:</p>
    533. 

  533. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">helper</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">);</span>
    534. 

  534. <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">library</span><span class="p">(</span><span class="s1">&#39;session&#39;</span><span class="p">);</span>
    535. 

  535. <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">config</span><span class="o">-&gt;</span><span class="na">item</span><span class="p">(</span><span class="s1">&#39;base_url&#39;</span><span class="p">);</span>
    536. 

  536. <span class="c1">// etc.</span>
    537. 

  537. </pre></div>
    538. 

  538. </div>
    539. 

  539. <p><code class="docutils literal"><span class="pre">$this</span></code>, however, only works directly within your controllers, your
    540. 

  540. models, or your views. If you would like to use CodeIgniter’s classes
    541. 

  541. from within your own custom classes you can do so as follows:</p>
    542. 

  542. <p>First, assign the CodeIgniter object to a variable:</p>
    543. 

  543. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$CI</span> <span class="o">=&amp;</span> <span class="nx">get_instance</span><span class="p">();</span>
    544. 

  544. </pre></div>
    545. 

  545. </div>
    546. 

  546. <p>Once you’ve assigned the object to a variable, you’ll use that variable
    547. 

  547. <em>instead</em> of <code class="docutils literal"><span class="pre">$this</span></code>:</p>
    548. 

  548. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$CI</span> <span class="o">=&amp;</span> <span class="nx">get_instance</span><span class="p">();</span>
    549. 

  549. 

  550. <span class="nv">$CI</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">helper</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">);</span>
    551. 

  551. <span class="nv">$CI</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">library</span><span class="p">(</span><span class="s1">&#39;session&#39;</span><span class="p">);</span>
    552. 

  552. <span class="nv">$CI</span><span class="o">-&gt;</span><span class="na">config</span><span class="o">-&gt;</span><span class="na">item</span><span class="p">(</span><span class="s1">&#39;base_url&#39;</span><span class="p">);</span>
    553. 

  553. <span class="c1">// etc.</span>
    554. 

  554. </pre></div>
    555. 

  555. </div>
    556. 

  556. <div class="admonition note">
    557. 

  557. <p class="first admonition-title">Note</p>
    558. 

  558. <p>You’ll notice that the above <code class="docutils literal"><span class="pre">get_instance()</span></code> function is being
    559. 

  559. passed by reference:</p>
    560. 

  560. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$CI</span> <span class="o">=&amp;</span> <span class="nx">get_instance</span><span class="p">();</span>
    561. 

  561. </pre></div>
    562. 

  562. </div>
    563. 

  563. <p class="last">This is very important. Assigning by reference allows you to use the
    564. 

  564. original CodeIgniter object rather than creating a copy of it.</p>
    565. 

  565. </div>
    566. 

  566. <p>However, since a library is a class, it would be better if you
    567. 

  567. take full advantage of the OOP principles. So, in order to
    568. 

  568. be able to use the CodeIgniter super-object in all of the class
    569. 

  569. methods, you’re encouraged to assign it to a property instead:</p>
    570. 

  570. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Example_library</span> <span class="p">{</span>
    571. 

  571. 

  572.         <span class="k">protected</span> <span class="nv">$CI</span><span class="p">;</span>
    573. 

  573. 

  574.         <span class="c1">// We&#39;ll use a constructor, as you can&#39;t directly call a function</span>
    575. 

  575.         <span class="c1">// from a property definition.</span>
    576. 

  576.         <span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">()</span>
    577. 

  577.         <span class="p">{</span>
    578. 

  578.                 <span class="c1">// Assign the CodeIgniter super-object</span>
    579. 

  579.                 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">CI</span> <span class="o">=&amp;</span> <span class="nx">get_instance</span><span class="p">();</span>
    580. 

  580.         <span class="p">}</span>
    581. 

  581. 

  582.         <span class="k">public</span> <span class="k">function</span> <span class="nf">foo</span><span class="p">()</span>
    583. 

  583.         <span class="p">{</span>
    584. 

  584.                 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">CI</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">helper</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">);</span>
    585. 

  585.                 <span class="nx">redirect</span><span class="p">();</span>
    586. 

  586.         <span class="p">}</span>
    587. 

  587. 

  588.         <span class="k">public</span> <span class="k">function</span> <span class="nf">bar</span><span class="p">()</span>
    589. 

  589.         <span class="p">{</span>
    590. 

  590.                 <span class="k">echo</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">CI</span><span class="o">-&gt;</span><span class="na">config</span><span class="o">-&gt;</span><span class="na">item</span><span class="p">(</span><span class="s1">&#39;base_url&#39;</span><span class="p">);</span>
    591. 

  591.         <span class="p">}</span>
    592. 

  592. 

  593. <span class="p">}</span>
    594. 

  594. </pre></div>
    595. 

  595. </div>
    596. 

  596. </div>
    597. 

  597. <div class="section" id="replacing-native-libraries-with-your-versions">
    598. 

  598. <h2>Replacing Native Libraries with Your Versions<a class="headerlink" href="#replacing-native-libraries-with-your-versions" title="Permalink to this headline">¶</a></h2>
    599. 

  599. <p>Simply by naming your class files identically to a native library will
    600. 

  600. cause CodeIgniter to use it instead of the native one. To use this
    601. 

  601. feature you must name the file and the class declaration exactly the
    602. 

  602. same as the native library. For example, to replace the native Email
    603. 

  603. library you’ll create a file named <em>application/libraries/Email.php</em>,
    604. 

  604. and declare your class with:</p>
    605. 

  605. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">CI_Email</span> <span class="p">{</span>
    606. 

  606. 

  607. <span class="p">}</span>
    608. 

  608. </pre></div>
    609. 

  609. </div>
    610. 

  610. <p>Note that most native classes are prefixed with CI_.</p>
    611. 

  611. <p>To load your library you’ll see the standard loading method:</p>
    612. 

  612. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">library</span><span class="p">(</span><span class="s1">&#39;email&#39;</span><span class="p">);</span>
    613. 

  613. </pre></div>
    614. 

  614. </div>
    615. 

  615. <div class="admonition note">
    616. 

  616. <p class="first admonition-title">Note</p>
    617. 

  617. <p class="last">At this time the Database classes can not be replaced with
    618. 

  618. your own versions.</p>
    619. 

  619. </div>
    620. 

  620. </div>
    621. 

  621. <div class="section" id="extending-native-libraries">
    622. 

  622. <h2>Extending Native Libraries<a class="headerlink" href="#extending-native-libraries" title="Permalink to this headline">¶</a></h2>
    623. 

  623. <p>If all you need to do is add some functionality to an existing library -
    624. 

  624. perhaps add a method or two - then it’s overkill to replace the entire
    625. 

  625. library with your version. In this case it’s better to simply extend the
    626. 

  626. class. Extending a class is nearly identical to replacing a class with a
    627. 

  627. couple exceptions:</p>
    628. 

  628. <ul class="simple">
    629. 

  629. <li>The class declaration must extend the parent class.</li>
    630. 

  630. <li>Your new class name and filename must be prefixed with MY_ (this
    631. 

  631. item is configurable. See below.).</li>
    632. 

  632. </ul>
    633. 

  633. <p>For example, to extend the native Email class you’ll create a file named
    634. 

  634. <em>application/libraries/MY_Email.php</em>, and declare your class with:</p>
    635. 

  635. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MY_Email</span> <span class="k">extends</span> <span class="nx">CI_Email</span> <span class="p">{</span>
    636. 

  636. 

  637. <span class="p">}</span>
    638. 

  638. </pre></div>
    639. 

  639. </div>
    640. 

  640. <p>If you need to use a constructor in your class make sure you
    641. 

  641. extend the parent constructor:</p>
    642. 

  642. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MY_Email</span> <span class="k">extends</span> <span class="nx">CI_Email</span> <span class="p">{</span>
    643. 

  643. 

  644.         <span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">(</span><span class="nv">$config</span> <span class="o">=</span> <span class="k">array</span><span class="p">())</span>
    645. 

  645.         <span class="p">{</span>
    646. 

  646.                 <span class="k">parent</span><span class="o">::</span><span class="na">__construct</span><span class="p">(</span><span class="nv">$config</span><span class="p">);</span>
    647. 

  647.                 <span class="c1">// Your own constructor code</span>
    648. 

  648.         <span class="p">}</span>
    649. 

  649. 

  650. <span class="p">}</span>
    651. 

  651. </pre></div>
    652. 

  652. </div>
    653. 

  653. <div class="admonition note">
    654. 

  654. <p class="first admonition-title">Note</p>
    655. 

  655. <p class="last">Not all of the libraries have the same (or any) parameters
    656. 

  656. in their constructor. Take a look at the library that you’re
    657. 

  657. extending first to see how it should be implemented.</p>
    658. 

  658. </div>
    659. 

  659. <div class="section" id="loading-your-sub-class">
    660. 

  660. <h3>Loading Your Sub-class<a class="headerlink" href="#loading-your-sub-class" title="Permalink to this headline">¶</a></h3>
    661. 

  661. <p>To load your sub-class you’ll use the standard syntax normally used. DO
    662. 

  662. NOT include your prefix. For example, to load the example above, which
    663. 

  663. extends the Email class, you will use:</p>
    664. 

  664. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">library</span><span class="p">(</span><span class="s1">&#39;email&#39;</span><span class="p">);</span>
    665. 

  665. </pre></div>
    666. 

  666. </div>
    667. 

  667. <p>Once loaded you will use the class variable as you normally would for
    668. 

  668. the class you are extending. In the case of the email class all calls
    669. 

  669. will use:</p>
    670. 

  670. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">email</span><span class="o">-&gt;</span><span class="na">some_method</span><span class="p">();</span>
    671. 

  671. </pre></div>
    672. 

  672. </div>
    673. 

  673. </div>
    674. 

  674. <div class="section" id="setting-your-own-prefix">
    675. 

  675. <h3>Setting Your Own Prefix<a class="headerlink" href="#setting-your-own-prefix" title="Permalink to this headline">¶</a></h3>
    676. 

  676. <p>To set your own sub-class prefix, open your
    677. 

  677. <em>application/config/config.php</em> file and look for this item:</p>
    678. 

  678. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$config</span><span class="p">[</span><span class="s1">&#39;subclass_prefix&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;MY_&#39;</span><span class="p">;</span>
    679. 

  679. </pre></div>
    680. 

  680. </div>
    681. 

  681. <p>Please note that all native CodeIgniter libraries are prefixed with CI_
    682. 

  682. so DO NOT use that as your prefix.</p>
    683. 

  683. </div>
    684. 

  684. </div>
    685. 

  685. </div>
    686. 

  686. 

  687. 

  688.           </div>
    689. 

  689.           <footer>
    690. 

  690.   
    691. 

  691.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    692. 

  692.       
    693. 

  693.         <a href="drivers.html" class="btn btn-neutral float-right" title="Using CodeIgniter Drivers">Next <span class="fa fa-arrow-circle-right"></span></a>
    694. 

  694.       
    695. 

  695.       
    696. 

  696.         <a href="libraries.html" class="btn btn-neutral" title="Using CodeIgniter Libraries"><span class="fa fa-arrow-circle-left"></span> Previous</a>
    697. 

  697.       
    698. 

  698.     </div>
    699. 

  699.   
    700. 

  700. 

  701.   <hr/>
    702. 

  702. 

  703.   <div role="contentinfo">
    704. 

  704.     <p>
    705. 

  705.         &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
    706. 

  706.       Last updated on Sep 19, 2019.
    707. 

  707.     </p>
    708. 

  708.   </div>
    709. 

  709. 

  710.   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
    711. 

  711.   
    712. 

  712. </footer>
    713. 

  713.         </div>
    714. 

  714.       </div>
    715. 

  715. 

  716.     </section>
    717. 

  717. 

  718.   </div>
    719. 

  719.   
    720. 

  720. 

  721. 

  722.   
    723. 

  723. 

  724.     <script type="text/javascript">
    725. 

  725.         var DOCUMENTATION_OPTIONS = {
    726. 

  726.             URL_ROOT:'../',
    727. 

  727.             VERSION:'3.1.11',
    728. 

  728.             COLLAPSE_INDEX:false,
    729. 

  729.             FILE_SUFFIX:'.html',
    730. 

  730.             HAS_SOURCE:  false
    731. 

  731.         };
    732. 

  732.     </script>
    733. 

  733.       <script type="text/javascript" src="../_static/jquery.js"></script>
    734. 

  734.       <script type="text/javascript" src="../_static/underscore.js"></script>
    735. 

  735.       <script type="text/javascript" src="../_static/doctools.js"></script>
    736. 

  736. 

  737.   
    738. 

  738. 

  739.   
    740. 

  740.   
    741. 

  741.     <script type="text/javascript" src="../_static/js/theme.js"></script>
    742. 

  742.   
    743. 

  743. 

  744.   
    745. 

  745.   
    746. 

  746.   <script type="text/javascript">
    747. 

  747.       jQuery(function () {
    748. 

  748.           SphinxRtdTheme.StickyNav.enable();
    749. 

  749.       });
    750. 

  750.   </script>
    751. 

  751.    
    752. 

  752. 

  753. </body>
    754. 

  754. </html>
    755.