Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 09de1854b1ac78f81264ca7a6b9d849ddcd1d159 / . / user_guide / general / scaffolding.html
blob: ea51137345c5edb0242c20da0be6cbf5ecd03439 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
5<title>Code Igniter User Guide</title>
6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]13<script type="text/javascript">
14window.onload = function() {
admine334c472006-10-21 19:44:22 +0000[diff] [blame]15 myHeight = new fx.Height('nav', {duration: 400});
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
25<meta name='description' content='Code Igniter User Guide' />
26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
Rick Ellis257651d2006-11-23 18:40:13 +0000[diff] [blame]36<td><h1>Code Igniter User Guide Version 1.5.1</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50Scaffolding
51</td>
52<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.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>
53</tr>
54</table>
55<!-- END BREADCRUMB -->
56
57<br clear="all" />
58
59
60<!-- START CONTENT -->
61<div id="content">
62
63<h1>Scaffolding</h1>
64
admine334c472006-10-21 19:44:22 +0000[diff] [blame]65<p>Code Igniter's Scaffolding feature provides a fast and very convenient way to add, edit, or delete information in your database
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]66during development.</p>
67
68<p class="important"><strong>Very Important:</strong> Scaffolding is intended for development use only. It provides very little
admine334c472006-10-21 19:44:22 +0000[diff] [blame]69security other than a "secret" word, so anyone who has access to your Code Igniter site can potentially edit or delete your information.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]70If you use scaffolding make sure you disable it immediately after you are through using it. DO NOT leave it enabled on a live site.
71And please, set a secret word before you use it.</p>
72
73
74<h2>Why would someone use scaffolding?</h2>
75
76<p>Here's a typical scenario: You create a new database table during development and you'd like a quick way to insert some data
77into it to work with. Without scaffolding your choices are either to write some inserts using the command line or to use a
admine334c472006-10-21 19:44:22 +0000[diff] [blame]78database management tool like phpMyAdmin. With Code Igniter's scaffolding feature you can quickly add some data using its browser
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]79interface. And when you are through using the data you can easily delete it.</p>
80
81<h2>Setting a Secret Word</h2>
82
83<p>Before enabling scaffolding please take a moment to set a secret word. This word, when encountered in your URL,
84will launch the scaffolding interface, so please pick something obscure that no one is likely to guess.</p>
85
86<p>To set a secret word, open your <kbd>application/config/routes.php</kbd> file and look for this item:</p>
87
88<code>$route['scaffolding_trigger'] = '';</code>
89
90<p>Once you've found it add your own unique word.</p>
91
92<p class="important"><strong>Note:</strong> The scaffolding word can <strong>not</strong> start with an underscore.</p>
93
94
95<h2>Enabling Scaffolding</h2>
96
97<p>Note: The information on this page assumes you already know how <a href="controllers.html">controllers</a> work, and that you have
admine334c472006-10-21 19:44:22 +0000[diff] [blame]98a working one available. It also assumes you have configured Code Igniter to auto-connect to your <a href="../database/index.html">database</a>.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]99If not, the information here won't be very relevant, so you are encouraged to go through those sections first.
100Lastly, it assumes you understand what a class constructor is. If not, read the last section of the <a href="controllers.html">controllers</a>
101page.</p>
102
103<p>To enable scaffolding you will initialize it in your constructor like this:</p>
104
105<code>
106&lt;?php<br />
107class Blog extends Controller {<br />
108<br />
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;function Blog()<br />
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br />
111&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parent::Controller();<br /><br />
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<samp>$this->load->scaffolding(</samp><kbd>'table_name'</kbd>);</samp><br />
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />
114}<br />
115?&gt;</code>
116
117<p>Where <kbd>table_name</kbd> is the name of the table (table, not database) you wish to work with.</p>
118
119<p>Once you've initialized scaffolding, you will access it with this URL prototype:
120
121<code>www.your-site.com/index.php/<var>class</var>/<dfn>secret_word</dfn>/</code>
122
123<p>For example, using a controller named <var>Blog</var>, and <dfn>abracadabra</dfn> as the secret word,
124you would access scaffolding like this:</p>
125
126<code>www.your-site.com/index.php/<var>blog</var>/<dfn>abracadabra</dfn>/</code>
127
128<p>The scaffolding interface should be self-explanatory. You can add, edit or delete records.</p>
129
130
131<h2>A Final Note:</h2>
132
133<p>The scaffolding feature will only work with tables that contain a primary key, as this is information is needed to perform the various
134database functions.</p>
135
136
137</div>
138<!-- END CONTENT -->
139
140
141<div id="footer">
142<p>
143Previous Topic:&nbsp;&nbsp;<a href="autoloader.html">Auto-loading Resources</a>
144&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
145<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
146<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
147Next Topic:&nbsp;&nbsp;<a href="routing.html">URI Routing</a>
148<p>
149<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
150</div>
151
152</body>
153</html>