codeigniter_vender 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (350) hide show
  1. data/.gitignore +2 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README +40 -0
  4. data/Rakefile +18 -0
  5. data/VERSION +1 -0
  6. data/codeigniter_vender.gemspec +389 -0
  7. data/generators/ci_app/USAGE +8 -0
  8. data/generators/ci_app/ci_app_generator.rb +12 -0
  9. data/generators/ci_app/templates/CodeIgniter_1.7.2/index.php +118 -0
  10. data/generators/ci_app/templates/CodeIgniter_1.7.2/license.txt +52 -0
  11. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/autoload.php +116 -0
  12. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/config.php +329 -0
  13. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/constants.php +41 -0
  14. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/database.php +55 -0
  15. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/doctypes.php +15 -0
  16. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/hooks.php +16 -0
  17. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/index.html +10 -0
  18. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/mimes.php +105 -0
  19. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/routes.php +48 -0
  20. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/smileys.php +66 -0
  21. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/config/user_agents.php +175 -0
  22. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/controllers/index.html +10 -0
  23. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/controllers/welcome.php +17 -0
  24. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_404.php +34 -0
  25. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_db.php +34 -0
  26. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_general.php +34 -0
  27. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/error_php.php +10 -0
  28. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/errors/index.html +10 -0
  29. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/helpers/index.html +10 -0
  30. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/hooks/index.html +10 -0
  31. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/index.html +10 -0
  32. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/language/english/index.html +10 -0
  33. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/libraries/index.html +10 -0
  34. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/models/index.html +10 -0
  35. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/views/index.html +10 -0
  36. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/application/views/welcome_message.php +62 -0
  37. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/cache/index.html +10 -0
  38. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Base4.php +69 -0
  39. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Base5.php +56 -0
  40. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/CodeIgniter.php +280 -0
  41. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Common.php +421 -0
  42. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/Compat.php +93 -0
  43. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/codeigniter/index.html +10 -0
  44. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB.php +146 -0
  45. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_active_rec.php +1820 -0
  46. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_cache.php +195 -0
  47. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_driver.php +1366 -0
  48. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_forge.php +375 -0
  49. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_result.php +342 -0
  50. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/DB_utility.php +389 -0
  51. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/index.html +10 -0
  52. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/index.html +10 -0
  53. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_driver.php +667 -0
  54. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_forge.php +248 -0
  55. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_result.php +169 -0
  56. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mssql/mssql_utility.php +123 -0
  57. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/index.html +10 -0
  58. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_driver.php +670 -0
  59. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_forge.php +254 -0
  60. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_result.php +169 -0
  61. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysql/mysql_utility.php +245 -0
  62. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/index.html +10 -0
  63. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_driver.php +671 -0
  64. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_forge.php +254 -0
  65. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_result.php +169 -0
  66. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/mysqli/mysqli_utility.php +123 -0
  67. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/index.html +10 -0
  68. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_driver.php +780 -0
  69. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_forge.php +248 -0
  70. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_result.php +249 -0
  71. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/oci8/oci8_utility.php +122 -0
  72. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/index.html +10 -0
  73. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_driver.php +639 -0
  74. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_forge.php +266 -0
  75. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_result.php +228 -0
  76. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/odbc/odbc_utility.php +148 -0
  77. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/index.html +10 -0
  78. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_driver.php +684 -0
  79. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_forge.php +248 -0
  80. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_result.php +169 -0
  81. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/postgre/postgre_utility.php +124 -0
  82. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/index.html +10 -0
  83. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_driver.php +657 -0
  84. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_forge.php +265 -0
  85. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_result.php +179 -0
  86. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/drivers/sqlite/sqlite_utility.php +141 -0
  87. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/database/index.html +10 -0
  88. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/fonts/index.html +10 -0
  89. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/fonts/texb.ttf +0 -0
  90. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/array_helper.php +78 -0
  91. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/compatibility_helper.php +498 -0
  92. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/cookie_helper.php +144 -0
  93. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/date_helper.php +611 -0
  94. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/directory_helper.php +84 -0
  95. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/download_helper.php +100 -0
  96. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/email_helper.php +62 -0
  97. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/file_helper.php +464 -0
  98. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/form_helper.php +1025 -0
  99. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/html_helper.php +416 -0
  100. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/index.html +10 -0
  101. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/inflector_helper.php +171 -0
  102. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/language_helper.php +58 -0
  103. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/number_helper.php +75 -0
  104. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/path_helper.php +72 -0
  105. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/security_helper.php +126 -0
  106. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/smiley_helper.php +273 -0
  107. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/string_helper.php +273 -0
  108. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/text_helper.php +462 -0
  109. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/typography_helper.php +71 -0
  110. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/url_helper.php +593 -0
  111. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/helpers/xml_helper.php +62 -0
  112. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/index.html +10 -0
  113. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/calendar_lang.php +51 -0
  114. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/date_lang.php +60 -0
  115. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/db_lang.php +28 -0
  116. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/email_lang.php +24 -0
  117. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/form_validation_lang.php +24 -0
  118. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/ftp_lang.php +17 -0
  119. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/imglib_lang.php +24 -0
  120. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/index.html +10 -0
  121. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/number_lang.php +10 -0
  122. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/profiler_lang.php +19 -0
  123. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/scaffolding_lang.php +17 -0
  124. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/unit_test_lang.php +24 -0
  125. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/upload_lang.php +22 -0
  126. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/english/validation_lang.php +24 -0
  127. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/language/index.html +10 -0
  128. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Benchmark.php +113 -0
  129. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Calendar.php +477 -0
  130. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Cart.php +550 -0
  131. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Config.php +244 -0
  132. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Controller.php +127 -0
  133. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Email.php +2041 -0
  134. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Encrypt.php +484 -0
  135. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Exceptions.php +174 -0
  136. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Form_validation.php +1278 -0
  137. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Ftp.php +618 -0
  138. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Hooks.php +226 -0
  139. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Image_lib.php +1544 -0
  140. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Input.php +1067 -0
  141. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Language.php +123 -0
  142. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Loader.php +1085 -0
  143. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Log.php +117 -0
  144. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Model.php +83 -0
  145. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Output.php +409 -0
  146. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Pagination.php +244 -0
  147. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Parser.php +173 -0
  148. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Profiler.php +392 -0
  149. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Router.php +389 -0
  150. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Session.php +758 -0
  151. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Sha1.php +251 -0
  152. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Table.php +440 -0
  153. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Trackback.php +547 -0
  154. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Typography.php +406 -0
  155. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/URI.php +586 -0
  156. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Unit_test.php +347 -0
  157. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Upload.php +970 -0
  158. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/User_agent.php +502 -0
  159. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Validation.php +875 -0
  160. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Xmlrpc.php +1421 -0
  161. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Xmlrpcs.php +536 -0
  162. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/Zip.php +359 -0
  163. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/libraries/index.html +10 -0
  164. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/logs/index.html +10 -0
  165. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/plugins/captcha_pi.php +356 -0
  166. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/plugins/index.html +10 -0
  167. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/plugins/js_calendar_pi.php +629 -0
  168. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/Scaffolding.php +291 -0
  169. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/images/background.jpg +0 -0
  170. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/images/index.html +10 -0
  171. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/images/logo.jpg +0 -0
  172. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/index.html +10 -0
  173. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/add.php +32 -0
  174. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/delete.php +9 -0
  175. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/edit.php +33 -0
  176. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/footer.php +10 -0
  177. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/header.php +29 -0
  178. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/index.html +10 -0
  179. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/no_data.php +8 -0
  180. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/stylesheet.css +143 -0
  181. data/generators/ci_app/templates/CodeIgniter_1.7.2/system/scaffolding/views/view.php +27 -0
  182. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/changelog.html +1080 -0
  183. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/active_record.html +757 -0
  184. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/caching.html +220 -0
  185. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/call_function.html +118 -0
  186. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/configuration.html +157 -0
  187. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/connecting.html +186 -0
  188. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/examples.html +217 -0
  189. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/fields.html +163 -0
  190. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/forge.html +234 -0
  191. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/helpers.html +151 -0
  192. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/index.html +99 -0
  193. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/queries.html +153 -0
  194. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/results.html +238 -0
  195. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/table_data.html +113 -0
  196. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/transactions.html +200 -0
  197. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/database/utilities.html +295 -0
  198. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/doc_style/index.html +86 -0
  199. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/doc_style/template.html +128 -0
  200. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/alternative_php.html +147 -0
  201. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/ancillary_classes.html +117 -0
  202. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/autoloader.html +101 -0
  203. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/caching.html +115 -0
  204. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/common_functions.html +119 -0
  205. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/controllers.html +385 -0
  206. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/core_classes.html +185 -0
  207. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/creating_libraries.html +298 -0
  208. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/credits.html +86 -0
  209. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/errors.html +138 -0
  210. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/helpers.html +185 -0
  211. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/hooks.html +167 -0
  212. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/libraries.html +94 -0
  213. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/managing_apps.html +133 -0
  214. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/models.html +251 -0
  215. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/plugins.html +127 -0
  216. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/profiling.html +104 -0
  217. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/quick_reference.html +77 -0
  218. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/requirements.html +82 -0
  219. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/reserved_names.html +156 -0
  220. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/routing.html +176 -0
  221. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/scaffolding.html +147 -0
  222. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/security.html +153 -0
  223. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/styleguide.html +687 -0
  224. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/urls.html +151 -0
  225. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/general/views.html +274 -0
  226. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/array_helper.html +119 -0
  227. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/compatibility_helper.html +118 -0
  228. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/cookie_helper.html +147 -0
  229. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/date_helper.html +408 -0
  230. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/directory_helper.html +143 -0
  231. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/download_helper.html +112 -0
  232. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/email_helper.html +102 -0
  233. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/file_helper.html +178 -0
  234. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/form_helper.html +484 -0
  235. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/html_helper.html +385 -0
  236. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/inflector_helper.html +151 -0
  237. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/language_helper.html +98 -0
  238. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/number_helper.html +107 -0
  239. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/path_helper.html +106 -0
  240. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/security_helper.html +125 -0
  241. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/smiley_helper.html +215 -0
  242. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/string_helper.html +176 -0
  243. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/text_helper.html +192 -0
  244. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/typography_helper.html +112 -0
  245. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/url_helper.html +289 -0
  246. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/helpers/xml_helper.html +105 -0
  247. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/appflowchart.gif +0 -0
  248. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/arrow.gif +0 -0
  249. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/ci_logo.jpg +0 -0
  250. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/ci_logo_flame.jpg +0 -0
  251. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/ci_quick_ref.png +0 -0
  252. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_helper_reference.pdf +0 -0
  253. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_helper_reference.png +0 -0
  254. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_library_reference.pdf +0 -0
  255. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/codeigniter_1.7.1_library_reference.png +0 -0
  256. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/file.gif +0 -0
  257. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/folder.gif +0 -0
  258. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/nav_bg_darker.jpg +0 -0
  259. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/nav_separator_darker.jpg +0 -0
  260. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/nav_toggle_darker.jpg +0 -0
  261. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/smile.gif +0 -0
  262. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/images/transparent.gif +0 -0
  263. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/index.html +99 -0
  264. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/downloads.html +105 -0
  265. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/index.html +97 -0
  266. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/troubleshooting.html +90 -0
  267. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_120.html +92 -0
  268. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_130.html +203 -0
  269. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_131.html +102 -0
  270. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_132.html +100 -0
  271. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_133.html +112 -0
  272. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_140.html +145 -0
  273. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_141.html +148 -0
  274. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_150.html +178 -0
  275. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_152.html +111 -0
  276. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_153.html +100 -0
  277. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_154.html +116 -0
  278. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_160.html +125 -0
  279. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_161.html +98 -0
  280. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_162.html +106 -0
  281. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_163.html +99 -0
  282. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_170.html +121 -0
  283. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_171.html +98 -0
  284. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_172.html +105 -0
  285. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrade_b11.html +144 -0
  286. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/installation/upgrading.html +101 -0
  287. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/benchmark.html +198 -0
  288. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/calendar.html +249 -0
  289. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/cart.html +346 -0
  290. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/config.html +181 -0
  291. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/email.html +307 -0
  292. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/encryption.html +182 -0
  293. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/file_uploading.html +451 -0
  294. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/form_validation.html +1221 -0
  295. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/ftp.html +303 -0
  296. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/image_lib.html +666 -0
  297. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/input.html +231 -0
  298. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/language.html +137 -0
  299. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/loader.html +214 -0
  300. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/output.html +145 -0
  301. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/pagination.html +218 -0
  302. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/parser.html +208 -0
  303. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/sessions.html +311 -0
  304. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/table.html +292 -0
  305. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/trackback.html +246 -0
  306. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/typography.html +160 -0
  307. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/unit_testing.html +205 -0
  308. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/uri.html +252 -0
  309. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/user_agent.html +201 -0
  310. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/validation.html +740 -0
  311. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/xmlrpc.html +517 -0
  312. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/libraries/zip.html +278 -0
  313. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/license.html +107 -0
  314. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/hacks.txt +9 -0
  315. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/moo.fx.js +119 -0
  316. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/moo.fx.pack.js +241 -0
  317. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/nav.js +139 -0
  318. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/prototype.lite.js +127 -0
  319. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/nav/user_guide_menu.js +4 -0
  320. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/appflow.html +95 -0
  321. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/at_a_glance.html +172 -0
  322. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/cheatsheets.html +83 -0
  323. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/features.html +120 -0
  324. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/getting_started.html +92 -0
  325. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/goals.html +98 -0
  326. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/index.html +84 -0
  327. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/overview/mvc.html +100 -0
  328. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/toc.html +209 -0
  329. data/generators/ci_app/templates/CodeIgniter_1.7.2/user_guide/userguide.css +406 -0
  330. data/generators/ci_app/templates/README +1 -0
  331. data/generators/ci_controller/USAGE +2 -0
  332. data/generators/ci_controller/ci_controller_generator.rb +11 -0
  333. data/generators/ci_controller/templates/ci_controller.php.erb +15 -0
  334. data/generators/ci_controller/templates/ci_view.php.erb +8 -0
  335. data/generators/ci_layout/USAGE +2 -0
  336. data/generators/ci_layout/ci_layout_generator.rb +24 -0
  337. data/generators/ci_layout/templates/application_layout.php.erb +19 -0
  338. data/generators/ci_model/USAGE +2 -0
  339. data/generators/ci_model/ci_model_generator.rb +42 -0
  340. data/generators/ci_model/templates/ci_model.php.erb +15 -0
  341. data/generators/ci_model/templates/model.rb +5 -0
  342. data/generators/ci_model/templates/model_migration.rb.erb +16 -0
  343. data/init.rb +1 -0
  344. data/install.rb +1 -0
  345. data/lib/codeigniter_vender.rb +1 -0
  346. data/lib/tasks/app.rake +8 -0
  347. data/test/codeigniter_vender_test.rb +8 -0
  348. data/test/test_helper.rb +3 -0
  349. data/uninstall.rb +1 -0
  350. metadata +411 -0
@@ -0,0 +1,182 @@
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="en" lang="en">
3
+ <head>
4
+
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Encryption Class : CodeIgniter User Guide</title>
7
+
8
+ <style type='text/css' media='all'>@import url('../userguide.css');</style>
9
+ <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
+
11
+ <script type="text/javascript" src="../nav/nav.js"></script>
12
+ <script type="text/javascript" src="../nav/prototype.lite.js"></script>
13
+ <script type="text/javascript" src="../nav/moo.fx.js"></script>
14
+ <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
+
16
+ <meta http-equiv='expires' content='-1' />
17
+ <meta http-equiv= 'pragma' content='no-cache' />
18
+ <meta name='robots' content='all' />
19
+ <meta name='author' content='ExpressionEngine Dev Team' />
20
+ <meta name='description' content='CodeIgniter User Guide' />
21
+
22
+ </head>
23
+ <body>
24
+
25
+ <!-- START NAVIGATION -->
26
+ <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
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="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28
+ <div id="masthead">
29
+ <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30
+ <tr>
31
+ <td><h1>CodeIgniter User Guide Version 1.7.2</h1></td>
32
+ <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33
+ </tr>
34
+ </table>
35
+ </div>
36
+ <!-- END NAVIGATION -->
37
+
38
+
39
+ <!-- START BREADCRUMB -->
40
+ <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41
+ <tr>
42
+ <td id="breadcrumb">
43
+ <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44
+ <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45
+ Encryption Class
46
+ </td>
47
+ <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
48
+ </tr>
49
+ </table>
50
+ <!-- END BREADCRUMB -->
51
+
52
+ <br clear="all" />
53
+
54
+
55
+ <!-- START CONTENT -->
56
+ <div id="content">
57
+
58
+
59
+ <h1>Encryption Class</h1>
60
+
61
+ <p>The Encryption Class provides two-way data encryption. It uses a scheme that pre-compiles
62
+ the message using a randomly hashed bitwise XOR encoding scheme, which is then encrypted using
63
+ the Mcrypt library. If Mcrypt is not available on your server the encoded message will
64
+ still provide a reasonable degree of security for encrypted sessions or other such "light" purposes.
65
+ If Mcrypt is available, you'll effectively end up with a double-encrypted message string, which should
66
+ provide a very high degree of security.</p>
67
+
68
+
69
+ <h2>Setting your Key</h2>
70
+
71
+ <p>A <em>key</em> is a piece of information that controls the cryptographic process and permits an encrypted string to be decoded.
72
+ In fact, the key you chose will provide the <strong>only</strong> means to decode data that was encrypted with that key,
73
+ so not only must you choose the key carefully, you must never change it if you intend use it for persistent data.</p>
74
+
75
+ <p>It goes without saying that you should guard your key carefully.
76
+ Should someone gain access to your key, the data will be easily decoded. If your server is not totally under your control
77
+ it's impossible to ensure key security so you may want to think carefully before using it for anything
78
+ that requires high security, like storing credit card numbers.</p>
79
+
80
+ <p>To take maximum advantage of the encryption algorithm, your key should be 32 characters in length (128 bits).
81
+ The key should be as random a string as you can concoct, with numbers and uppercase and lowercase letters.
82
+ Your key should <strong>not</strong> be a simple text string. In order to be cryptographically secure it
83
+ needs to be as random as possible.</p>
84
+
85
+ <p>Your key can be either stored in your <dfn>application/config/config.php</dfn>, or you can design your own
86
+ storage mechanism and pass the key dynamically when encoding/decoding.</p>
87
+
88
+ <p>To save your key to your <dfn>application/config/config.php</dfn>, open the file and set:</p>
89
+ <code>$config['encryption_key'] = "YOUR KEY";</code>
90
+
91
+
92
+ <h2>Message Length</h2>
93
+
94
+ <p>It's important for you to know that the encoded messages the encryption function generates will be approximately 2.6 times longer than the original
95
+ message. For example, if you encrypt the string "my super secret data", which is 21 characters in length, you'll end up
96
+ with an encoded string that is roughly 55 characters (we say "roughly" because the encoded string length increments in
97
+ 64 bit clusters, so it's not exactly linear). Keep this information in mind when selecting your data storage mechanism. Cookies,
98
+ for example, can only hold 4K of information.</p>
99
+
100
+
101
+ <h2>Initializing the Class</h2>
102
+
103
+ <p>Like most other classes in CodeIgniter, the Encryption class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>
104
+
105
+ <code>$this->load->library('encrypt');</code>
106
+ <p>Once loaded, the Encrypt library object will be available using: <dfn>$this->encrypt</dfn></p>
107
+
108
+
109
+ <h2>$this->encrypt->encode()</h2>
110
+
111
+ <p>Performs the data encryption and returns it as a string. Example:</p>
112
+ <code>
113
+ $msg = 'My secret message';<br />
114
+ <br />
115
+ $encrypted_string = $this->encrypt->encode($msg);</code>
116
+
117
+ <p>You can optionally pass your encryption key via the second parameter if you don't want to use the one in your config file:</p>
118
+
119
+ <code>
120
+ $msg = 'My secret message';<br />
121
+ $key = 'super-secret-key';<br />
122
+ <br />
123
+ $encrypted_string = $this->encrypt->encode($msg, $key);</code>
124
+
125
+
126
+ <h2>$this->encrypt->decode()</h2>
127
+
128
+ <p>Decrypts an encoded string. Example:</p>
129
+
130
+ <code>
131
+ $encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84';<br />
132
+ <br />
133
+ $plaintext_string = $this->encrypt->decode($encrypted_string);</code>
134
+
135
+
136
+ <h2>$this->encrypt->set_cipher();</h2>
137
+
138
+ <p>Permits you to set an Mcrypt cipher. By default it uses <samp>MCRYPT_RIJNDAEL_256</samp>. Example:</p>
139
+ <code>$this->encrypt->set_cipher(MCRYPT_BLOWFISH);</code>
140
+ <p>Please visit php.net for a list of <a href="http://php.net/mcrypt">available ciphers</a>.</p>
141
+
142
+ <p>If you'd like to manually test whether your server supports Mcrypt you can use:</p>
143
+ <code>echo ( ! function_exists('mcrypt_encrypt')) ? 'Nope' : 'Yup';</code>
144
+
145
+
146
+ <h2>$this->encrypt->set_mode();</h2>
147
+
148
+ <p>Permits you to set an Mcrypt mode. By default it uses <samp>MCRYPT_MODE_ECB</samp>. Example:</p>
149
+ <code>$this->encrypt->set_mode(MCRYPT_MODE_CFB);</code>
150
+ <p>Please visit php.net for a list of <a href="http://php.net/mcrypt">available modes</a>.</p>
151
+
152
+
153
+ <h2>$this->encrypt->sha1();</h2>
154
+ <p>SHA1 encoding function. Provide a string and it will return a 160 bit one way hash. Note: SHA1, just like MD5 is non-decodable. Example:</p>
155
+ <code>$hash = $this->encrypt->sha1('Some string');</code>
156
+
157
+ <p>Many PHP installations have SHA1 support by default so if all you need is to encode a hash it's simpler to use the native
158
+ function:</p>
159
+
160
+ <code>$hash = sha1('Some string');</code>
161
+
162
+ <p>If your server does not support SHA1 you can use the provided function.</p>
163
+
164
+
165
+
166
+ </div>
167
+ <!-- END CONTENT -->
168
+
169
+
170
+ <div id="footer">
171
+ <p>
172
+ Previous Topic:&nbsp;&nbsp;<a href="email.html">Email Class</a>
173
+ &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
174
+ <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
175
+ <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
176
+ Next Topic:&nbsp;&nbsp;<a href="file_uploading.html">File Uploading Class</a>
177
+ </p>
178
+ <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2010 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
179
+ </div>
180
+
181
+ </body>
182
+ </html>
@@ -0,0 +1,451 @@
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="en" lang="en">
3
+ <head>
4
+
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>File Uploading Class : CodeIgniter User Guide</title>
7
+
8
+ <style type='text/css' media='all'>@import url('../userguide.css');</style>
9
+ <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
+
11
+ <script type="text/javascript" src="../nav/nav.js"></script>
12
+ <script type="text/javascript" src="../nav/prototype.lite.js"></script>
13
+ <script type="text/javascript" src="../nav/moo.fx.js"></script>
14
+ <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
+
16
+ <meta http-equiv='expires' content='-1' />
17
+ <meta http-equiv= 'pragma' content='no-cache' />
18
+ <meta name='robots' content='all' />
19
+ <meta name='author' content='ExpressionEngine Dev Team' />
20
+ <meta name='description' content='CodeIgniter User Guide' />
21
+
22
+ </head>
23
+ <body>
24
+
25
+ <!-- START NAVIGATION -->
26
+ <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
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="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28
+ <div id="masthead">
29
+ <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30
+ <tr>
31
+ <td><h1>CodeIgniter User Guide Version 1.7.2</h1></td>
32
+ <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33
+ </tr>
34
+ </table>
35
+ </div>
36
+ <!-- END NAVIGATION -->
37
+
38
+
39
+ <!-- START BREADCRUMB -->
40
+ <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41
+ <tr>
42
+ <td id="breadcrumb">
43
+ <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44
+ <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45
+ File Uploading Class
46
+ </td>
47
+ <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
48
+ </tr>
49
+ </table>
50
+ <!-- END BREADCRUMB -->
51
+
52
+ <br clear="all" />
53
+
54
+
55
+ <!-- START CONTENT -->
56
+ <div id="content">
57
+
58
+
59
+ <h1>File Uploading Class</h1>
60
+
61
+ <p>CodeIgniter's File Uploading Class permits files to be uploaded. You can set various
62
+ preferences, restricting the type and size of the files.</p>
63
+
64
+
65
+ <h2>The Process</h2>
66
+
67
+ <p>Uploading a file involves the following general process:</p>
68
+
69
+
70
+ <ul>
71
+ <li>An upload form is displayed, allowing a user to select a file and upload it.</li>
72
+ <li>When the form is submitted, the file is uploaded to the destination you specify.</li>
73
+ <li>Along the way, the file is validated to make sure it is allowed to be uploaded based on the preferences you set.</li>
74
+ <li>Once uploaded, the user will be shown a success message.</li>
75
+ </ul>
76
+
77
+ <p>To demonstrate this process here is brief tutorial. Afterward you'll find reference information.</p>
78
+
79
+ <h2>Creating the Upload Form</h2>
80
+
81
+
82
+
83
+ <p>Using a text editor, create a form called <dfn>upload_form.php</dfn>. In it, place this code and save it to your <samp>applications/views/</samp>
84
+ folder:</p>
85
+
86
+
87
+ <textarea class="textarea" style="width:100%" cols="50" rows="23">
88
+ &lt;html>
89
+ &lt;head>
90
+ &lt;title>Upload Form&lt;/title>
91
+ &lt;/head>
92
+ &lt;body>
93
+
94
+ &lt;?php echo $error;?>
95
+
96
+ &lt;?php echo form_open_multipart('upload/do_upload');?>
97
+
98
+ &lt;input type="file" name="userfile" size="20" />
99
+
100
+ &lt;br />&lt;br />
101
+
102
+ &lt;input type="submit" value="upload" />
103
+
104
+ &lt;/form>
105
+
106
+ &lt;/body>
107
+ &lt;/html></textarea>
108
+
109
+ <p>You'll notice we are using a form helper to create the opening form tag. File uploads require a multipart form, so the helper
110
+ creates the proper syntax for you. You'll also notice we have an $error variable. This is so we can show error messages in the event
111
+ the user does something wrong.</p>
112
+
113
+
114
+ <h2>The Success Page</h2>
115
+
116
+ <p>Using a text editor, create a form called <dfn>upload_success.php</dfn>.
117
+ In it, place this code and save it to your <samp>applications/views/</samp> folder:</p>
118
+
119
+ <textarea class="textarea" style="width:100%" cols="50" rows="20">&lt;html>
120
+ &lt;head>
121
+ &lt;title>Upload Form&lt;/title>
122
+ &lt;/head>
123
+ &lt;body>
124
+
125
+ &lt;h3>Your file was successfully uploaded!&lt;/h3>
126
+
127
+ &lt;ul>
128
+ &lt;?php foreach($upload_data as $item => $value):?>
129
+ &lt;li>&lt;?php echo $item;?>: &lt;?php echo $value;?>&lt;/li>
130
+ &lt;?php endforeach; ?>
131
+ &lt;/ul>
132
+
133
+ &lt;p>&lt;?php echo anchor('upload', 'Upload Another File!'); ?>&lt;/p>
134
+
135
+ &lt;/body>
136
+ &lt;/html></textarea>
137
+
138
+
139
+ <h2>The Controller</h2>
140
+
141
+ <p>Using a text editor, create a controller called <dfn>upload.php</dfn>. In it, place this code and save it to your <samp>applications/controllers/</samp>
142
+ folder:</p>
143
+
144
+
145
+ <textarea class="textarea" style="width:100%" cols="50" rows="43">&lt;?php
146
+
147
+ class Upload extends Controller {
148
+
149
+ function Upload()
150
+ {
151
+ parent::Controller();
152
+ $this->load->helper(array('form', 'url'));
153
+ }
154
+
155
+ function index()
156
+ {
157
+ $this->load->view('upload_form', array('error' => ' ' ));
158
+ }
159
+
160
+ function do_upload()
161
+ {
162
+ $config['upload_path'] = './uploads/';
163
+ $config['allowed_types'] = 'gif|jpg|png';
164
+ $config['max_size'] = '100';
165
+ $config['max_width'] = '1024';
166
+ $config['max_height'] = '768';
167
+
168
+ $this->load->library('upload', $config);
169
+
170
+ if ( ! $this->upload->do_upload())
171
+ {
172
+ $error = array('error' => $this->upload->display_errors());
173
+
174
+ $this->load->view('upload_form', $error);
175
+ }
176
+ else
177
+ {
178
+ $data = array('upload_data' => $this->upload->data());
179
+
180
+ $this->load->view('upload_success', $data);
181
+ }
182
+ }
183
+ }
184
+ ?&gt;</textarea>
185
+
186
+
187
+ <h2>The Upload Folder</h2>
188
+
189
+ <p>You'll need a destination folder for your uploaded images. Create a folder at the root of your CodeIgniter installation called
190
+ <dfn>uploads</dfn> and set its file permissions to 777.</p>
191
+
192
+
193
+ <h2>Try it!</h2>
194
+
195
+ <p>To try your form, visit your site using a URL similar to this one:</p>
196
+
197
+ <code>example.com/index.php/<var>upload</var>/</code>
198
+
199
+ <p>You should see an upload form. Try uploading an image file (either a jpg, gif, or png). If the path in your
200
+ controller is correct it should work.</p>
201
+
202
+
203
+ <p>&nbsp;</p>
204
+
205
+ <h1>Reference Guide</h1>
206
+
207
+
208
+ <h2>Initializing the Upload Class</h2>
209
+
210
+ <p>Like most other classes in CodeIgniter, the Upload class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>
211
+
212
+ <code>$this->load->library('upload');</code>
213
+ <p>Once the Upload class is loaded, the object will be available using: <dfn>$this->upload</dfn></p>
214
+
215
+
216
+ <h2>Setting Preferences</h2>
217
+
218
+ <p>Similar to other libraries, you'll control what is allowed to be upload based on your preferences. In the controller you
219
+ built above you set the following preferences:</p>
220
+
221
+ <code>$config['upload_path'] = './uploads/';<br />
222
+ $config['allowed_types'] = 'gif|jpg|png';<br />
223
+ $config['max_size'] = '100';<br />
224
+ $config['max_width'] = '1024';<br />
225
+ $config['max_height'] = '768';<br />
226
+ <br />
227
+ $this->load->library('upload', $config);<br /><br />
228
+
229
+ // Alternately you can set preferences by calling the initialize function. Useful if you auto-load the class:<br />
230
+ $this->upload->initialize($config);</code>
231
+
232
+ <p>The above preferences should be fairly self-explanatory. Below is a table describing all available preferences.</p>
233
+
234
+
235
+ <h2>Preferences</h2>
236
+
237
+ <p>The following preferences are available. The default value indicates what will be used if you do not specify that preference.</p>
238
+
239
+ <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
240
+ <tr>
241
+ <th>Preference</th>
242
+ <th>Default&nbsp;Value</th>
243
+ <th>Options</th>
244
+ <th>Description</th>
245
+ </tr>
246
+
247
+ <tr>
248
+ <td class="td"><strong>upload_path</strong></td>
249
+ <td class="td">None</td>
250
+ <td class="td">None</td>
251
+ <td class="td">The path to the folder where the upload should be placed. The folder must be writable and the path can be absolute or relative.</td>
252
+ </tr>
253
+
254
+ <tr>
255
+ <td class="td"><strong>allowed_types</strong></td>
256
+ <td class="td">None</td>
257
+ <td class="td">None</td>
258
+ <td class="td">The mime types corresponding to the types of files you allow to be uploaded. Usually the file extension can be used as the mime type. Separate multiple types with a pipe.</td>
259
+ </tr>
260
+
261
+
262
+ <tr>
263
+ <td class="td"><strong>file_name</strong></td>
264
+ <td class="td">None</td>
265
+ <td class="td">Desired file name</td>
266
+ <td class="td">
267
+ <p>If set CodeIgniter will rename the uploaded file to this name. The extension provided in the file name must also be an allowed file type.</p>
268
+ </td>
269
+ </tr>
270
+
271
+ <tr>
272
+ <td class="td"><strong>overwrite</strong></td>
273
+ <td class="td">FALSE</td>
274
+ <td class="td">TRUE/FALSE (boolean)</td>
275
+ <td class="td">If set to true, if a file with the same name as the one you are uploading exists, it will be overwritten. If set to false, a number will be appended to the filename if another with the same name exists.</td>
276
+ </tr>
277
+
278
+
279
+ <tr>
280
+ <td class="td"><strong>max_size</strong></td>
281
+ <td class="td">0</td>
282
+ <td class="td">None</td>
283
+ <td class="td">The maximum size (in kilobytes) that the file can be. Set to zero for no limit. Note: Most PHP installations have their own limit, as specified in the php.ini file. Usually 2 MB (or 2048 KB) by default.</td>
284
+ </tr>
285
+
286
+ <tr>
287
+ <td class="td"><strong>max_width</strong></td>
288
+ <td class="td">0</td>
289
+ <td class="td">None</td>
290
+ <td class="td">The maximum width (in pixels) that the file can be. Set to zero for no limit.</td>
291
+ </tr>
292
+
293
+ <tr>
294
+ <td class="td"><strong>max_height</strong></td>
295
+ <td class="td">0</td>
296
+ <td class="td">None</td>
297
+ <td class="td">The maximum height (in pixels) that the file can be. Set to zero for no limit.</td>
298
+ </tr>
299
+
300
+ <tr>
301
+ <td class="td"><strong>max_filename</strong></td>
302
+ <td class="td">0</td>
303
+ <td class="td">None</td>
304
+ <td class="td">The maximum length that a file name can be. Set to zero for no limit.</td>
305
+ </tr>
306
+
307
+ <tr>
308
+ <td class="td"><strong>encrypt_name</strong></td>
309
+ <td class="td">FALSE</td>
310
+ <td class="td">TRUE/FALSE (boolean)</td>
311
+ <td class="td">If set to TRUE the file name will be converted to a random encrypted string. This can be useful if you would like the file saved with a name that can not be discerned by the person uploading it.</td>
312
+ </tr>
313
+
314
+ <tr>
315
+ <td class="td"><strong>remove_spaces</strong></td>
316
+ <td class="td">TRUE</td>
317
+ <td class="td">TRUE/FALSE (boolean)</td>
318
+ <td class="td">If set to TRUE, any spaces in the file name will be converted to underscores. This is recommended.</td>
319
+ </tr>
320
+ </table>
321
+
322
+
323
+ <h2>Setting preferences in a config file</h2>
324
+
325
+ <p>If you prefer not to set preferences using the above method, you can instead put them into a config file.
326
+ Simply create a new file called the <var>upload.php</var>, add the <var>$config</var>
327
+ array in that file. Then save the file in: <var>config/upload.php</var> and it will be used automatically. You
328
+ will NOT need to use the <dfn>$this->upload->initialize</dfn> function if you save your preferences in a config file.</p>
329
+
330
+
331
+ <h2>Function Reference</h2>
332
+
333
+ <p>The following functions are available</p>
334
+
335
+
336
+ <h2>$this->upload->do_upload()</h2>
337
+
338
+ <p>Performs the upload based on the preferences you've set. Note: By default the upload routine expects the file to come from a form field
339
+ called <dfn>userfile</dfn>, and the form must be a "multipart type:</p>
340
+
341
+ <code>&lt;form method="post" action="some_action" enctype="multipart/form-data" /></code>
342
+
343
+ <p>If you would like to set your own field name simply pass its value to the <dfn>do_upload</dfn> function:</p>
344
+
345
+ <code>
346
+ $field_name = "some_field_name";<br />
347
+ $this->upload->do_upload($field_name)</code>
348
+
349
+
350
+ <h2>$this->upload->display_errors()</h2>
351
+
352
+ <p>Retrieves any error messages if the <dfn>do_upload()</dfn> function returned false. The function does not echo automatically, it
353
+ returns the data so you can assign it however you need.</p>
354
+
355
+ <h3>Formatting Errors</h3>
356
+ <p>By default the above function wraps any errors within &lt;p> tags. You can set your own delimiters like this:</p>
357
+
358
+ <code>$this->upload->display_errors('<var>&lt;p></var>', '<var>&lt;/p></var>');</code>
359
+
360
+ <h2>$this->upload->data()</h2>
361
+
362
+ <p>This is a helper function that returns an array containing all of the data related to the file you uploaded.
363
+ Here is the array prototype:</p>
364
+
365
+ <code>Array<br />
366
+ (<br />
367
+ &nbsp;&nbsp;&nbsp;&nbsp;[file_name]&nbsp;&nbsp;&nbsp;&nbsp;=> mypic.jpg<br />
368
+ &nbsp;&nbsp;&nbsp;&nbsp;[file_type]&nbsp;&nbsp;&nbsp;&nbsp;=> image/jpeg<br />
369
+ &nbsp;&nbsp;&nbsp;&nbsp;[file_path]&nbsp;&nbsp;&nbsp;&nbsp;=> /path/to/your/upload/<br />
370
+ &nbsp;&nbsp;&nbsp;&nbsp;[full_path]&nbsp;&nbsp;&nbsp;&nbsp;=> /path/to/your/upload/jpg.jpg<br />
371
+ &nbsp;&nbsp;&nbsp;&nbsp;[raw_name]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;=> mypic<br />
372
+ &nbsp;&nbsp;&nbsp;&nbsp;[orig_name]&nbsp;&nbsp;&nbsp;&nbsp;=> mypic.jpg<br />
373
+ &nbsp;&nbsp;&nbsp;&nbsp;[client_name]&nbsp;&nbsp;=> mypic.jpg<br />
374
+ &nbsp;&nbsp;&nbsp;&nbsp;[file_ext]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;=> .jpg<br />
375
+ &nbsp;&nbsp;&nbsp;&nbsp;[file_size]&nbsp;&nbsp;&nbsp;&nbsp;=> 22.2<br />
376
+ &nbsp;&nbsp;&nbsp;&nbsp;[is_image]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;=> 1<br />
377
+ &nbsp;&nbsp;&nbsp;&nbsp;[image_width]&nbsp;&nbsp;=> 800<br />
378
+ &nbsp;&nbsp;&nbsp;&nbsp;[image_height] => 600<br />
379
+ &nbsp;&nbsp;&nbsp;&nbsp;[image_type]&nbsp;&nbsp;&nbsp;=> jpeg<br />
380
+ &nbsp;&nbsp;&nbsp;&nbsp;[image_size_str] => width="800" height="200"<br />
381
+ )</code>
382
+
383
+ <h3>Explanation</h3>
384
+
385
+ <p>Here is an explanation of the above array items.</p>
386
+
387
+ <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
388
+ <tr><th>Item</th><th>Description</th></tr>
389
+
390
+ <tr><td class="td"><strong>file_name</strong></td>
391
+ <td class="td">The name of the file that was uploaded including the file extension.</td></tr>
392
+
393
+ <tr><td class="td"><strong>file_type</strong></td>
394
+ <td class="td">The file's Mime type</td></tr>
395
+
396
+ <tr><td class="td"><strong>file_path</strong></td>
397
+ <td class="td">The absolute server path to the file</td></tr>
398
+
399
+ <tr><td class="td"><strong>full_path</strong></td>
400
+ <td class="td">The absolute server path including the file name</td></tr>
401
+
402
+ <tr><td class="td"><strong>raw_name</strong></td>
403
+ <td class="td">The file name without the extension</td></tr>
404
+
405
+ <tr><td class="td"><strong>orig_name</strong></td>
406
+ <td class="td">The original file name. This is only useful if you use the encrypted name option.</td></tr>
407
+
408
+ <tr><td class="td"><strong>client_name</strong></td>
409
+ <td class="td">The file name as supplied by the client user agent, prior to any file name preparation or incrementing.</td></tr>
410
+
411
+ <tr><td class="td"><strong>file_ext</strong></td>
412
+ <td class="td">The file extension with period</td></tr>
413
+
414
+ <tr><td class="td"><strong>file_size</strong></td>
415
+ <td class="td">The file size in kilobytes</td></tr>
416
+
417
+ <tr><td class="td"><strong>is_image</strong></td>
418
+ <td class="td">Whether the file is an image or not. 1 = image. 0 = not.</td></tr>
419
+
420
+ <tr><td class="td"><strong>image_width</strong></td>
421
+ <td class="td">Image width.</td></tr>
422
+
423
+ <tr><td class="td"><strong>image_heigth</strong></td>
424
+ <td class="td">Image height</td></tr>
425
+
426
+ <tr><td class="td"><strong>image_type</strong></td>
427
+ <td class="td">Image type. Typically the file extension without the period.</td></tr>
428
+
429
+ <tr><td class="td"><strong>image_size_str</strong></td>
430
+ <td class="td">A string containing the width and height. Useful to put into an image tag.</td></tr>
431
+
432
+
433
+ </table>
434
+
435
+ </div>
436
+ <!-- END CONTENT -->
437
+
438
+
439
+ <div id="footer">
440
+ <p>
441
+ Previous Topic:&nbsp;&nbsp;<a href="encryption.html">Encryption Helper</a>
442
+ &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
443
+ <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
444
+ <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
445
+ Next Topic:&nbsp;&nbsp;<a href="form_validation.html">Form Validation Class</a>
446
+ </p>
447
+ <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2010 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
448
+ </div>
449
+
450
+ </body>
451
+ </html>