diff options
| author | Pascal Kriete <pascal.kriete@ellislab.com> | 2010-11-10 22:41:23 +0100 |
|---|---|---|
| committer | Pascal Kriete <pascal.kriete@ellislab.com> | 2010-11-10 22:41:23 +0100 |
| commit | e79d41a0de8a21db83fdb6b3e25ae65c9923c46d (patch) | |
| tree | 6eddba47a27b9ee5d7a53315aaaaa7bf86df856c /user_guide | |
| parent | 00921a54feb7fde4444401ab93d77780c6c3bb96 (diff) | |
Userguide tweaks to show proper PHP 5 examples and removing the compat helper from the menu.
Diffstat (limited to 'user_guide')
| -rw-r--r-- | user_guide/general/controllers.html | 2 | ||||
| -rw-r--r-- | user_guide/general/core_classes.html | 8 | ||||
| -rw-r--r-- | user_guide/general/creating_libraries.html | 6 | ||||
| -rw-r--r-- | user_guide/general/models.html | 12 | ||||
| -rw-r--r-- | user_guide/general/styleguide.html | 5 | ||||
| -rw-r--r-- | user_guide/installation/upgrade_200.html | 9 | ||||
| -rw-r--r-- | user_guide/nav/nav.js | 1 |
7 files changed, 22 insertions, 21 deletions
diff --git a/user_guide/general/controllers.html b/user_guide/general/controllers.html index bcd0e4bce..1d9cd0328 100644 --- a/user_guide/general/controllers.html +++ b/user_guide/general/controllers.html @@ -340,7 +340,7 @@ class <kbd>Blog</kbd> extends CI_Controller {<br /> <br /> function <kbd>__construct()</kbd><br /> {<br /> - <var>parent::CI_Controller();</var><br /> + <var>parent::__construct();</var><br /> // Your own constructor code<br /> }<br /> }<br /> diff --git a/user_guide/general/core_classes.html b/user_guide/general/core_classes.html index ac965aee3..35043d9ca 100644 --- a/user_guide/general/core_classes.html +++ b/user_guide/general/core_classes.html @@ -131,9 +131,9 @@ class MY_Input extends CI_Input {<br /><br /> <code> class MY_Input extends CI_Input {<br /> <br /> - function MY_Input()<br /> + function __construct()<br /> {<br /> - parent::CI_Input();<br /> + parent::__construct();<br /> }<br /> }</code> @@ -145,9 +145,9 @@ This allows you to substantially alter the CodeIgniter core.</p> <code>class Welcome extends MY_Controller {<br /> <br /> - function Welcome()<br /> + function __construct()<br /> {<br /> - parent::MY_Controller();<br /> + parent::__construct();<br /> }<br /> <br /> function index()<br /> diff --git a/user_guide/general/creating_libraries.html b/user_guide/general/creating_libraries.html index 3f0e32cb0..00d0f4aa4 100644 --- a/user_guide/general/creating_libraries.html +++ b/user_guide/general/creating_libraries.html @@ -141,7 +141,7 @@ $this->load->library('Someclass', <kbd>$params</kbd>);</code> <br /> class Someclass {<br /> <br /> - function Someclass($params)<br /> + function __construct($params)<br /> {<br /> // Do something with $params<br /> }<br /> @@ -248,9 +248,9 @@ class MY_Email extends CI_Email {<br /><br /> <code> class MY_Email extends CI_Email {<br /> <br /> - function My_Email()<br /> + function __construct()<br /> {<br /> - parent::CI_Email();<br /> + parent::__construct();<br /> }<br /> }</code> diff --git a/user_guide/general/models.html b/user_guide/general/models.html index 35ab08d20..466996648 100644 --- a/user_guide/general/models.html +++ b/user_guide/general/models.html @@ -83,10 +83,10 @@ class Blogmodel extends CI_Model {<br /> var $content = '';<br /> var $date = '';<br /> <br /> - function Blogmodel()<br /> + function __construct()<br /> {<br /> // Call the Model constructor<br /> - parent::CI_Model();<br /> + parent::__construct();<br /> }<br /> <br /> function get_last_ten_entries()<br /> @@ -128,9 +128,9 @@ want this type of organization.</p> <code> class <var>Model_name</var> extends CI_Model {<br /> <br /> - function <var>Model_name</var>()<br /> + function <var>__construct</var>()<br /> {<br /> - parent::CI_Model();<br /> + parent::__construct();<br /> }<br /> }</code> @@ -142,9 +142,9 @@ Make sure your class extends the base Model class.</p> <code> class <var>User_model</var> extends CI_Model {<br /> <br /> - function <var>User_model</var>()<br /> + function <var>__construct</var>()<br /> {<br /> - parent::CI_Model();<br /> + parent::__construct();<br /> }<br /> }</code> diff --git a/user_guide/general/styleguide.html b/user_guide/general/styleguide.html index 7b7d837d9..f30f45529 100644 --- a/user_guide/general/styleguide.html +++ b/user_guide/general/styleguide.html @@ -161,7 +161,7 @@ echo "Here's my code!"; <h2><a name="class_and_method_naming"></a>Class and Method Naming</h2> <div class="guidelineDetails"> - <p>Class names should always have their first letter uppercase, and the constructor method should match identically. 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> + <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> <code><strong>INCORRECT</strong>: class superclass @@ -170,11 +170,10 @@ class SuperClass <strong>CORRECT</strong>: class Super_class</code> - <p>Notice that the Class and constructor methods are identically named and cased:</p> <code>class Super_class { - function Super_class() + function __construct() { } diff --git a/user_guide/installation/upgrade_200.html b/user_guide/installation/upgrade_200.html index fa57dfb25..16c7d8d3b 100644 --- a/user_guide/installation/upgrade_200.html +++ b/user_guide/installation/upgrade_200.html @@ -100,13 +100,16 @@ to <p>Please read <a href="../libraries/encryption.html#legacy">how to use this method</a> in the Encryption library documentation.</p> -</p> +<h2>Step 5: Remove loading calls for the compatibility helper.</h2> +<p>The compatibility helper has been removed from the CodeIgniter core. All methods in it should be natively available in supported PHP versions.</p> -<h2>Step 5: Update Class extension</h2> +<h2>Step 6: Update Class extension</h2> <p>All core classes are now prefixed with <kbd>CI_</kbd>. Update Models and Controllers to extend CI_Model and CI_Controller, respectively.</p> +<h2>Step 7: Update Parent Constructor calls</h2> +<p>All native CodeIgniter classes now use the PHP 5 <kbd>__construct()</kbd> convention. Please update extended libraries to call <kbd>parent::__construct()</kbd>.</p> -<h2>Step 6: Update your user guide</h2> +<h2>Step 8: Update your user guide</h2> <p>Please replace your local copy of the user guide with the new version, including the image files.</p> </div> diff --git a/user_guide/nav/nav.js b/user_guide/nav/nav.js index bad23d20a..4ac109914 100644 --- a/user_guide/nav/nav.js +++ b/user_guide/nav/nav.js @@ -104,7 +104,6 @@ function create_menu(basepath) '<ul>' + '<li><a href="'+base+'helpers/array_helper.html">Array Helper</a></li>' + '<li><a href="'+base+'helpers/captcha_helper.html">CAPTCHA Helper</a></li>' + - '<li><a href="'+base+'helpers/compatibility_helper.html">Compatibility Helper</a></li>' + '<li><a href="'+base+'helpers/cookie_helper.html">Cookie Helper</a></li>' + '<li><a href="'+base+'helpers/date_helper.html">Date Helper</a></li>' + '<li><a href="'+base+'helpers/directory_helper.html">Directory Helper</a></li>' + |