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">
5
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
<title>Style Guide : CodeIgniter User Guide</title>
8
<style type='text/css' media='all'>@import url('../userguide.css');</style>
9
<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
11
<style type="text/css" media="screen">
17
<script type="text/javascript" src="../nav/nav.js"></script>
18
<script type="text/javascript" src="../nav/prototype.lite.js"></script>
19
<script type="text/javascript" src="../nav/moo.fx.js"></script>
20
<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
22
<meta http-equiv='expires' content='-1' />
23
<meta http-equiv= 'pragma' content='no-cache' />
24
<meta name='robots' content='all' />
25
<meta name='author' content='ExpressionEngine Dev Team' />
26
<meta name='description' content='CodeIgniter User Guide' />
31
<!-- START NAVIGATION -->
32
<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
33
<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>
35
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
37
<td><h1>CodeIgniter User Guide Version 2.1.3</h1></td>
38
<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
42
<!-- END NAVIGATION -->
45
<!-- START BREADCRUMB -->
46
<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
49
<a href="http://codeigniter.com/">CodeIgniter Home</a> ›
50
<a href="../index.html">User Guide Home</a> ›
53
<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 <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>
56
<!-- END BREADCRUMB -->
61
<!-- START CONTENT -->
65
<h1>General Style and Syntax</h1>
67
<p>The following page describes the use of coding rules adhered to when developing CodeIgniter.</p>
70
<h2>Table of Contents</h2>
72
<li><a href="#file_format">File Format</a></li>
73
<li><a href="#php_closing_tag">PHP Closing Tag</a></li>
74
<li><a href="#class_and_method_naming">Class and Method Naming</a></li>
75
<li><a href="#variable_names">Variable Names</a></li>
76
<li><a href="#commenting">Commenting</a></li>
77
<li><a href="#constants">Constants</a></li>
78
<li><a href="#true_false_and_null">TRUE, FALSE, and NULL</a></li>
79
<li><a href="#logical_operators">Logical Operators</a></li>
80
<li><a href="#comparing_return_values_and_typecasting">Comparing Return Values and Typecasting</a></li>
81
<li><a href="#debugging_code">Debugging Code</a></li>
82
<li><a href="#whitespace_in_files">Whitespace in Files</a></li>
83
<li><a href="#compatibility">Compatibility</a></li>
84
<li><a href="#class_and_file_names_using_common_words">Class and File Names using Common Words</a></li>
85
<li><a href="#database_table_names">Database Table Names</a></li>
86
<li><a href="#one_file_per_class">One File per Class</a></li>
87
<li><a href="#whitespace">Whitespace</a></li>
88
<li><a href="#line_breaks">Line Breaks</a></li>
89
<li><a href="#code_indenting">Code Indenting</a></li>
90
<li><a href="#bracket_spacing">Bracket and Parenthetic Spacing</li>
91
<li><a href="#localized_text">Localized Text</a></li>
92
<li><a href="#private_methods_and_variables">Private Methods and Variables</a></li>
93
<li><a href="#php_errors">PHP Errors</a></li>
94
<li><a href="#short_open_tags">Short Open Tags</a></li>
95
<li><a href="#one_statement_per_line">One Statement Per Line</a></li>
96
<li><a href="#strings">Strings</a></li>
97
<li><a href="#sql_queries">SQL Queries</a></li>
98
<li><a href="#default_function_arguments">Default Function Arguments</a></li>
103
<h2><a name="file_format"></a>File Format</h2>
104
<div class="guidelineDetails">
105
<p>Files should be saved with Unicode (UTF-8) encoding. The <abbr title="Byte Order Mark">BOM</abbr>
106
should <em>not</em> be used. Unlike UTF-16 and UTF-32, there's no byte order to indicate in
107
a UTF-8 encoded file, and the <abbr title="Byte Order Mark">BOM</abbr> can have a negative side effect in PHP of sending output,
108
preventing the application from being able to set its own headers. Unix line endings should
111
<p>Here is how to apply these settings in some of the more common text editors. Instructions for your
112
text editor may vary; check your text editor's documentation.</p>
117
<li>Open the Application Preferences</li>
118
<li>Click Advanced, and then the "Saving" tab</li>
119
<li>In "File Encoding", select "UTF-8 (recommended)"</li>
120
<li>In "Line Endings", select "LF (recommended)"</li>
121
<li><em>Optional:</em> Check "Use for existing files as well" if you wish to modify the line
122
endings of files you open to your new preference.</li>
128
<li>Open the Application Preferences</li>
129
<li>Select "Text Encodings" on the left.</li>
130
<li>In "Default text encoding for new documents", select "Unicode (UTF-8, no BOM)"</li>
131
<li><em>Optional:</em> In "If file's encoding can't be guessed, use", select
132
"Unicode (UTF-8, no BOM)"</li>
133
<li>Select "Text Files" on the left.</li>
134
<li>In "Default line breaks", select "Mac OS X and Unix (LF)"</li>
138
<h2><a name="php_closing_tag"></a>PHP Closing Tag</h2>
139
<div class="guidelineDetails">
140
<p>The PHP closing tag on a PHP document <strong>?></strong> is optional to the PHP parser. However, if used, any whitespace following the closing tag, whether introduced
141
by the developer, user, or an FTP application, can cause unwanted output, PHP errors, or if the latter are suppressed, blank pages. For this reason, all PHP files should
142
<strong>OMIT</strong> the closing PHP tag, and instead use a comment block to mark the end of file and it's location relative to the application root.
143
This allows you to still identify a file as being complete and not truncated.</p>
144
<code><strong>INCORRECT</strong>:
147
echo "Here's my code!";
151
<strong>CORRECT</strong>:
154
echo "Here's my code!";
156
/* End of file myfile.php */
157
/* Location: ./system/modules/mymodule/myfile.php */
162
<h2><a name="class_and_method_naming"></a>Class and Method Naming</h2>
163
<div class="guidelineDetails">
164
<p>Class names should always start with an uppercase letter. Multiple words should be separated with an underscore, and not CamelCased. All other class methods should be entirely lowercased and named to clearly indicate their function, preferably including a verb. Try to avoid overly long and verbose names.</p>
166
<code><strong>INCORRECT</strong>:
170
<strong>CORRECT</strong>:
171
class Super_class</code>
174
<code>class Super_class {
176
function __construct()
182
<p>Examples of improper and proper method naming:</p>
184
<code><strong>INCORRECT</strong>:
185
function fileproperties() // not descriptive and needs underscore separator
186
function fileProperties() // not descriptive and uses CamelCase
187
function getfileproperties() // Better! But still missing underscore separator
188
function getFileProperties() // uses CamelCase
189
function get_the_file_properties_from_the_file() // wordy
191
<strong>CORRECT</strong>:
192
function get_file_properties() // descriptive, underscore separator, and all lowercase letters</code>
197
<h2><a name="variable_names"></a>Variable Names</h2>
198
<div class="guidelineDetails">
199
<p>The guidelines for variable naming is very similar to that used for class methods. Namely, variables should contain only lowercase letters, use underscore separators, and be reasonably named to indicate their purpose and contents. Very short, non-word variables should only be used as iterators in for() loops.</p>
200
<code><strong>INCORRECT</strong>:
201
$j = 'foo'; // single letter variables should only be used in for() loops
202
$Str // contains uppercase letters
203
$bufferedText // uses CamelCasing, and could be shortened without losing semantic meaning
204
$groupid // multiple words, needs underscore separator
205
$name_of_last_city_used // too long
207
<strong>CORRECT</strong>:
208
for ($j = 0; $j < 10; $j++)
217
<h2><a name="commenting"></a>Commenting</h2>
218
<div class="guidelineDetails">
219
<p>In general, code should be commented prolifically. It not only helps describe the flow and intent of the code for less experienced programmers, but can prove invaluable when returning to your own code months down the line. There is not a required format for comments, but the following are recommended.</p>
221
<p><a href="http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblock">DocBlock</a> style comments preceding class and method declarations so they can be picked up by IDEs:</p>
226
* @package Package Name
227
* @subpackage Subpackage
229
* @author Author Name
230
* @link http://example.com
232
class Super_class {</code>
235
* Encodes string for use in XML
241
function xml_encode($str)</code>
243
<p>Use single line comments within code, leaving a blank line between large comment blocks and code.</p>
245
<code>// break up the string by newlines
246
$parts = explode("\n", $str);
248
// A longer comment that needs to give greater detail on what is
249
// occurring and why can use multiple single-line comments. Try to
250
// keep the width reasonable, around 70 characters is the easiest to
251
// read. Don't hesitate to link to permanent external resources
252
// that may provide greater detail:
254
// http://example.com/information_about_something/in_particular/
256
$parts = $this->foo($parts);
261
<h2><a name="constants"></a>Constants</h2>
262
<div class="guidelineDetails">
263
<p>Constants follow the same guidelines as do variables, except constants should always be fully uppercase. <em>Always use CodeIgniter constants when appropriate, i.e. SLASH, LD, RD, PATH_CACHE, etc.</em></p>
264
<code><strong>INCORRECT</strong>:
265
myConstant // missing underscore separator and not fully uppercase
266
N // no single-letter constants
267
S_C_VER // not descriptive
268
$str = str_replace('{foo}', 'bar', $str); // should use LD and RD constants
270
<strong>CORRECT</strong>:
274
$str = str_replace(LD.'foo'.RD, 'bar', $str);
279
<h2><a name="true_false_and_null"></a>TRUE, FALSE, and NULL</h2>
280
<div class="guidelineDetails">
281
<p><strong>TRUE</strong>, <strong>FALSE</strong>, and <strong>NULL</strong> keywords should always be fully uppercase.</p>
282
<code><strong>INCORRECT</strong>:
285
function foo($bar = null)
287
<strong>CORRECT</strong>:
290
function foo($bar = NULL)</code>
295
<h2><a name="logical_operators"></a>Logical Operators</h2>
296
<div class="guidelineDetails">
297
<p>Use of <strong>||</strong> is discouraged as its clarity on some output devices is low (looking like the number 11 for instance).
298
<strong>&&</strong> is preferred over <strong>AND</strong> but either are acceptable, and a space should always precede and follow <strong>!</strong>.</p>
299
<code><strong>INCORRECT</strong>:
301
if ($foo AND $bar) // okay but not recommended for common syntax highlighting applications
303
if (! is_array($foo))
305
<strong>CORRECT</strong>:
307
if ($foo && $bar) // recommended
309
if ( ! is_array($foo))
315
<h2><a name="comparing_return_values_and_typecasting"></a>Comparing Return Values and Typecasting</h2>
316
<div class="guidelineDetails">
317
<p>Some PHP functions return FALSE on failure, but may also have a valid return value of "" or 0, which would evaluate to FALSE in loose comparisons. Be explicit by comparing the variable type when using these return values in conditionals to ensure the return value is indeed what you expect, and not a value that has an equivalent loose-type evaluation.</p>
318
<p>Use the same stringency in returning and checking your own variables. Use <strong>===</strong> and <strong>!==</strong> as necessary.
320
<code><strong>INCORRECT</strong>:
321
// If 'foo' is at the beginning of the string, strpos will return a 0,
322
// resulting in this conditional evaluating as TRUE
323
if (strpos($str, 'foo') == FALSE)
325
<strong>CORRECT</strong>:
326
if (strpos($str, 'foo') === FALSE)
329
<code><strong>INCORRECT</strong>:
330
function build_string($str = "")
332
if ($str == "") // uh-oh! What if FALSE or the integer 0 is passed as an argument?
338
<strong>CORRECT</strong>:
339
function build_string($str = "")
347
<p>See also information regarding <a href="http://us3.php.net/manual/en/language.types.type-juggling.php#language.types.typecasting">typecasting</a>, which can be quite useful. Typecasting has a slightly different effect which may be desirable. When casting a variable as a string, for instance, NULL and boolean FALSE variables become empty strings, 0 (and other numbers) become strings of digits, and boolean TRUE becomes "1":</p>
349
<code>$str = (string) $str; // cast $str as a string</code>
354
<h2><a name="debugging_code"></a>Debugging Code</h2>
355
<div class="guidelineDetails">
356
<p>No debugging code can be left in place for submitted add-ons unless it is commented out, i.e. no var_dump(), print_r(), die(), and exit() calls that were used while creating the add-on, unless they are commented out.</p>
358
<code>// print_r($foo);</code>
363
<h2><a name="whitespace_in_files"></a>Whitespace in Files</h2>
364
<div class="guidelineDetails">
365
<p>No whitespace can precede the opening PHP tag or follow the closing PHP tag. Output is buffered, so whitespace in your files can cause output to begin before CodeIgniter outputs its content, leading to errors and an inability for CodeIgniter to send proper headers. In the examples below, select the text with your mouse to reveal the incorrect whitespace.</p>
367
<p><strong>INCORRECT</strong>:</p>
370
// ...there is whitespace and a linebreak above the opening PHP tag
371
// as well as whitespace after the closing PHP tag
374
<p><strong>CORRECT</strong>:</p>
376
// this sample has no whitespace before or after the opening and closing PHP tags
382
<h2><a name="compatibility"></a>Compatibility</h2>
383
<div class="guidelineDetails">
384
<p>Unless specifically mentioned in your add-on's documentation, all code must be compatible with PHP version 5.1+. Additionally, do not use PHP functions that require non-default libraries to be installed unless your code contains an alternative method when the function is not available, or you implicitly document that your add-on requires said PHP libraries.</p>
389
<h2><a name="class_and_file_names_using_common_words"></a>Class and File Names using Common Words</h2>
390
<div class="guidelineDetails">
391
<p>When your class or filename is a common word, or might quite likely be identically named in another PHP script, provide a unique prefix to help prevent collision. Always realize that your end users may be running other add-ons or third party PHP scripts. Choose a prefix that is unique to your identity as a developer or company.</p>
393
<code><strong>INCORRECT</strong>:
394
class Email pi.email.php
395
class Xml ext.xml.php
396
class Import mod.import.php
398
<strong>CORRECT</strong>:
399
class Pre_email pi.pre_email.php
400
class Pre_xml ext.pre_xml.php
401
class Pre_import mod.pre_import.php
406
<h2><a name="database_table_names"></a>Database Table Names</h2>
407
<div class="guidelineDetails">
408
<p>Any tables that your add-on might use must use the 'exp_' prefix, followed by a prefix uniquely identifying you as the developer or company, and then a short descriptive table name. You do not need to be concerned about the database prefix being used on the user's installation, as CodeIgniter's database class will automatically convert 'exp_' to what is actually being used.</p>
410
<code><strong>INCORRECT</strong>:
411
email_addresses // missing both prefixes
412
pre_email_addresses // missing exp_ prefix
413
exp_email_addresses // missing unique prefix
415
<strong>CORRECT</strong>:
416
exp_pre_email_addresses
419
<p class="important"><strong>NOTE:</strong> Be mindful that MySQL has a limit of 64 characters for table names. This should not be an issue as table names that would exceed this would likely have unreasonable names. For instance, the following table name exceeds this limitation by one character. Silly, no? <strong>exp_pre_email_addresses_of_registered_users_in_seattle_washington</strong>
424
<h2><a name="one_file_per_class"></a>One File per Class</h2>
425
<div class="guidelineDetails">
426
<p>Use separate files for each class your add-on uses, unless the classes are <em>closely related</em>. An example of CodeIgniter files that contains multiple classes is the Database class file, which contains both the DB class and the DB_Cache class, and the Magpie plugin, which contains both the Magpie and Snoopy classes.</p>
431
<h2><a name="whitespace"></a>Whitespace</h2>
432
<div class="guidelineDetails">
433
<p>Use tabs for whitespace in your code, not spaces. This may seem like a small thing, but using tabs instead of whitespace allows the developer looking at your code to have indentation at levels that they prefer and customize in whatever application they use. And as a side benefit, it results in (slightly) more compact files, storing one tab character versus, say, four space characters.</p>
438
<h2><a name="line_breaks"></a>Line Breaks</h2>
439
<div class="guidelineDetails">
440
<p>Files must be saved with Unix line breaks. This is more of an issue for developers who work in Windows, but in any case ensure that your text editor is setup to save files with Unix line breaks.</p>
445
<h2><a name="code_indenting"></a>Code Indenting</h2>
446
<div class="guidelineDetails">
447
<p>Use Allman style indenting. With the exception of Class declarations, braces are always placed on a line by themselves, and indented at the same level as the control statement that "owns" them.</p>
449
<code><strong>INCORRECT</strong>:
454
foreach ($arr as $key => $val) {
464
for ($i = 0; $i < 10; $i++)
466
for ($j = 0; $j < 10; $j++)
472
<strong>CORRECT</strong>:
478
foreach ($arr as $key => $val)
492
for ($i = 0; $i < 10; $i++)
494
for ($j = 0; $j < 10; $j++)
502
<h2><a name="bracket_spacing"></a>Bracket and Parenthetic Spacing</h2>
503
<div class="guidelineDetails">
504
<p>In general, parenthesis and brackets should not use any additional spaces. The exception is that a space should always follow PHP control structures that accept arguments with parenthesis (declare, do-while, elseif, for, foreach, if, switch, while), to help distinguish them from functions and increase readability.</p>
507
$arr[ $foo ] = 'foo';
510
$arr[$foo] = 'foo'; // no spaces around array keys
514
function foo ( $bar )
520
function foo($bar) // no spaces around parenthesis in function declarations
527
foreach( $query->result() as $row )
530
foreach ($query->result() as $row) // single space following PHP control structures, but not in interior parenthesis
536
<h2><a name="localized_text"></a>Localized Text</h2>
537
<div class="guidelineDetails">
538
<p>Any text that is output in the control panel should use language variables in your lang file to allow localization.</p>
541
return "Invalid Selection";
544
return $this->lang->line('invalid_selection');</code>
549
<h2><a name="private_methods_and_variables"></a>Private Methods and Variables</h2>
550
<div class="guidelineDetails">
551
<p>Methods and variables that are only accessed internally by your class, such as utility and helper functions that your public methods use for code abstraction, should be prefixed with an underscore.</p>
553
<code>convert_text() // public method
554
_convert_text() // private method</code>
559
<h2><a name="php_errors"></a>PHP Errors</h2>
560
<div class="guidelineDetails">
561
<p>Code must run error free and not rely on warnings and notices to be hidden to meet this requirement. For instance, never access a variable that you did not set yourself (such as $_POST array keys) without first checking to see that it isset().</p>
563
<p>Make sure that while developing your add-on, error reporting is enabled for ALL users, and that display_errors is enabled in the PHP environment. You can check this setting with:</p>
565
<code>if (ini_get('display_errors') == 1)
570
<p>On some servers where display_errors is disabled, and you do not have the ability to change this in the php.ini, you can often enable it with:</p>
572
<code>ini_set('display_errors', 1);</code>
574
<p class="important"><strong>NOTE:</strong> Setting the <a href="http://us.php.net/manual/en/ref.errorfunc.php#ini.display-errors">display_errors</a> setting with ini_set() at runtime is not identical to having it enabled in the PHP environment. Namely, it will not have any effect if the script has fatal errors</p>
579
<h2><a name="short_open_tags"></a>Short Open Tags</h2>
580
<div class="guidelineDetails">
581
<p>Always use full PHP opening tags, in case a server does not have short_open_tag enabled.</p>
583
<code><strong>INCORRECT</strong>:
584
<? echo $foo; ?>
588
<strong>CORRECT</strong>:
589
<?php echo $foo; ?></code>
594
<h2><a name="one_statement_per_line"></a>One Statement Per Line</h2>
595
<div class="guidelineDetails">
596
<p>Never combine statements on one line.</p>
598
<code><strong>INCORRECT</strong>:
599
$foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag);
601
<strong>CORRECT</strong>:
604
$bat = str_replace($foo, $bar, $bag);
610
<h2><a name="strings"></a>Strings</h2>
611
<div class="guidelineDetails">
612
<p>Always use single quoted strings unless you need variables parsed, and in cases where you do need variables parsed, use braces to prevent greedy token parsing. You may also use double-quoted strings if the string contains single quotes, so you do not have to use escape characters.</p>
614
<code><strong>INCORRECT</strong>:
615
"My String" // no variable parsing, so no use for double quotes
616
"My string $foo" // needs braces
617
'SELECT foo FROM bar WHERE baz = \'bag\'' // ugly
619
<strong>CORRECT</strong>:
622
"SELECT foo FROM bar WHERE baz = 'bag'"</code>
627
<h2><a name="sql_queries"></a>SQL Queries</h2>
628
<div class="guidelineDetails">
629
<p>MySQL keywords are always capitalized: SELECT, INSERT, UPDATE, WHERE, AS, JOIN, ON, IN, etc.</p>
631
<p>Break up long queries into multiple lines for legibility, preferably breaking for each clause.</p>
633
<code><strong>INCORRECT</strong>:
634
// keywords are lowercase and query is too long for
635
// a single line (... indicates continuation of line)
636
$query = $this->db->query("select foo, bar, baz, foofoo, foobar as raboof, foobaz from exp_pre_email_addresses
637
...where foo != 'oof' and baz != 'zab' order by foobaz limit 5, 100");
639
<strong>CORRECT</strong>:
640
$query = $this->db->query("SELECT foo, bar, baz, foofoo, foobar AS raboof, foobaz
641
FROM exp_pre_email_addresses
645
LIMIT 5, 100");</code>
650
<h2><a name="default_function_arguments"></a>Default Function Arguments</h2>
651
<div class="guidelineDetails">
652
<p>Whenever appropriate, provide function argument defaults, which helps prevent PHP errors with mistaken calls and provides common fallback values which can save a few lines of code. Example:</p>
654
<code>function foo($bar = '', $baz = FALSE)</code>
669
Previous Topic: <a href="security.html">Security</a>
670
·
671
<a href="#top">Top of Page</a> ·
672
<a href="../index.html">User Guide Home</a> ·
673
Next Topic: <a href="../doc_style/index.html">Writing Documentation</a>
675
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
b'\\ No newline at end of file'
added
removed
codeigniter/user_guide/general/styleguide.html
