From 024cfeceedc17fc8442b2bca9dfc73c361dfaac3 Mon Sep 17 00:00:00 2001 From: vlakoff Date: Wed, 9 Jan 2013 18:10:20 +0100 Subject: Syntax fixes in documentation source --- user_guide_src/source/changelog.rst | 2 +- .../source/general/ancillary_classes.rst | 38 +++++++++++----------- user_guide_src/source/general/core_classes.rst | 12 +++---- .../source/general/creating_libraries.rst | 38 +++++++++++----------- user_guide_src/source/installation/upgrade_300.rst | 6 ++-- .../source/libraries/form_validation.rst | 4 +-- user_guide_src/source/libraries/migration.rst | 2 +- 7 files changed, 51 insertions(+), 51 deletions(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst index 5534a1ee7..744150bb4 100644 --- a/user_guide_src/source/changelog.rst +++ b/user_guide_src/source/changelog.rst @@ -231,7 +231,7 @@ Release Date: Not Released - Native PHP functions used as rules can now accept an additional parameter, other than the data itself. - Updated method ``set_rules()`` to accept an array of rules as well as a string. - Fields that have empty rules set no longer run through validation (and therefore are not considered erroneous). - - Added rule **differs* to check if the value of a field differs from the value of another field. + - Added rule **differs** to check if the value of a field differs from the value of another field. - Added rule **valid_url**. - Added support for named parameters in error messages. - :doc:`Language ` line keys must now be prefixed with **form_validation_**. diff --git a/user_guide_src/source/general/ancillary_classes.rst b/user_guide_src/source/general/ancillary_classes.rst index a4befc7b3..5dc058ad4 100644 --- a/user_guide_src/source/general/ancillary_classes.rst +++ b/user_guide_src/source/general/ancillary_classes.rst @@ -58,30 +58,30 @@ won't need to call ``get_instance()`` in every single method. Example:: -class Example { + class Example { - protected $CI; + protected $CI; - // We'll use a constructor, as you can't directly call a function - // from a property definition. - public function __construct() - { - // Assign the CodeIgniter super-object - $this->CI =& get_instance(); - } + // We'll use a constructor, as you can't directly call a function + // from a property definition. + public function __construct() + { + // Assign the CodeIgniter super-object + $this->CI =& get_instance(); + } - public function foo() - { - $this->CI->load->helper('url'); - redirect(); - } + public function foo() + { + $this->CI->load->helper('url'); + redirect(); + } - public function bar() - { - $this->CI->config_item('base_url'); - } + public function bar() + { + $this->CI->config_item('base_url'); + } -} + } In the above example, both methods ``foo()`` and ``bar()`` will work after you instantiate the Example class, without the need to call diff --git a/user_guide_src/source/general/core_classes.rst b/user_guide_src/source/general/core_classes.rst index ce57aeef0..07c0b00ba 100644 --- a/user_guide_src/source/general/core_classes.rst +++ b/user_guide_src/source/general/core_classes.rst @@ -76,15 +76,15 @@ application/core/MY_Input.php, and declare your class with:: } .. note:: If you need to use a constructor in your class make sure you -extend the parent constructor:: + extend the parent constructor:: - class MY_Input extends CI_Input { + class MY_Input extends CI_Input { - public function __construct() - { - parent::__construct(); + public function __construct() + { + parent::__construct(); + } } - } **Tip:** Any functions in your class that are named identically to the methods in the parent class will be used instead of the native ones diff --git a/user_guide_src/source/general/creating_libraries.rst b/user_guide_src/source/general/creating_libraries.rst index 8bafd4532..4fc8ed72f 100644 --- a/user_guide_src/source/general/creating_libraries.rst +++ b/user_guide_src/source/general/creating_libraries.rst @@ -148,30 +148,30 @@ take full advantage of the OOP principles. So, in order to be able to use the CodeIgniter super-object in all of the class methods, you're encouraged to assign it to a property instead:: -class Example_library { + class Example_library { - protected $CI; + protected $CI; - // We'll use a constructor, as you can't directly call a function - // from a property definition. - public function __construct() - { - // Assign the CodeIgniter super-object - $this->CI =& get_instance(); - } + // We'll use a constructor, as you can't directly call a function + // from a property definition. + public function __construct() + { + // Assign the CodeIgniter super-object + $this->CI =& get_instance(); + } - public function foo() - { - $this->CI->load->helper('url'); - redirect(); - } + public function foo() + { + $this->CI->load->helper('url'); + redirect(); + } - public function bar() - { - echo $this->CI->config_item('base_url'); - } + public function bar() + { + echo $this->CI->config_item('base_url'); + } -} + } Replacing Native Libraries with Your Versions ============================================= diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index ff601867e..94f6321be 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -302,7 +302,7 @@ CodeIgniter 3.1+. String helper random_string() types 'unique' and 'encrypt' ========================================================== -When using the :doc:`String Helper ` function :php:func:`random_string()`, +When using the :doc:`String Helper <../helpers/string_helper>` function :php:func:`random_string()`, you should no longer pass the **unique** and **encrypt** randomization types. They are only aliases for **md5** and **sha1** respectively and are now deprecated and scheduled for removal in CodeIgniter 3.1+. @@ -313,7 +313,7 @@ in CodeIgniter 3.1+. URL helper url_title() separators 'dash' and 'underscore' ========================================================= -When using the :doc:`URL Helper ` function :php:func:`url_title()`, you +When using the :doc:`URL Helper <../helpers/url_helper>` function :php:func:`url_title()`, you should no longer pass **dash** or **underscore** as the word separator. This function will now accept any character and you should just pass the chosen character directly, so you should write '-' instead of 'dash' and '_' instead of 'underscore'. @@ -327,7 +327,7 @@ in CodeIgniter 3.1+. Database Forge method add_column() with an AFTER clause ======================================================= -If you have used the **third parameter** for :doc:`Database Forge ` method +If you have used the **third parameter** for :doc:`Database Forge <../database/forge>` method ``add_column()`` to add a field for an AFTER clause, then you should change its usage. That third parameter has been deprecated and scheduled for removal in CodeIgniter 3.1+. diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst index ce1695d62..ae7859aa3 100644 --- a/user_guide_src/source/libraries/form_validation.rst +++ b/user_guide_src/source/libraries/form_validation.rst @@ -479,7 +479,7 @@ Message is the text you would like displayed. If you'd like to include a field's "human" name, or the optional parameter some rules allow for (such as max_length), you can add the -**{field}** and **{param}** tags to your message, respectively. +**{field}** and **{param}** tags to your message, respectively:: $this->form_validation->set_message('min_length', '{field} must have at least {param} characters.'); @@ -491,7 +491,7 @@ error would display: "Username must have at least 5 characters." use one or the other. In the callback rule example above, the error message was set by passing -the name of the method (without the "callback_" prefix):: +the name of the method (without the "callback\_" prefix):: $this->form_validation->set_message('username_check') diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst index 1a73fb78d..9a7b10d64 100644 --- a/user_guide_src/source/libraries/migration.rst +++ b/user_guide_src/source/libraries/migration.rst @@ -158,6 +158,6 @@ Preference Default Options Des version number. **migration_auto_latest** FALSE TRUE / FALSE Enable or disable automatically running migrations. -**migration_type** 'timestamp' 'timestamp' / 'sequential' The type of numeric identifier used to name +**migration_type** 'timestamp' 'timestamp' / 'sequential' The type of numeric identifier used to name migration files. ========================== ====================== ========================== ============================================= -- cgit v1.2.3-24-g4f1b