Merge pull request #2884 from jreklund/general-topics

Added more Common functions and improved rendering in userguide

Author: lonnieezell

user_guide_src/source/concepts/autoloader.rst

@@ -40,10 +40,10 @@ application's files. This is most important for any business-logic related class
 etc. The ``psr4`` array in the configuration file allows you to map the namespace to the directory
 those classes can be found in::
 
-	$psr4 = [
-		'App'         => APPPATH,
-		'CodeIgniter' => SYSTEMPATH,
-	];
+    $psr4 = [
+        'App'         => APPPATH,
+        'CodeIgniter' => SYSTEMPATH,
+    ];
 
 The key of each row is the namespace itself. This does not need a trailing slash. If you use double-quotes
 to define the array, be sure to escape the backward slash. That means that it would be ``My\\App``,
@@ -55,13 +55,13 @@ libraries, or models in the application directory, if you do, they will be found
 You may change this namespace by editing the **/app/Config/Constants.php** file and setting the
 new namespace value under the ``APP_NAMESPACE`` setting::
 
-	define('APP_NAMESPACE', 'App');
+    define('APP_NAMESPACE', 'App');
 
 You will need to modify any existing files that are referencing the current namespace.
 
 .. important:: Config files are namespaced in the ``Config`` namespace, not in ``App\Config`` as you might
-	expect. This allows the core system files to always be able to locate them, even when the application
-	namespace has changed.
+    expect. This allows the core system files to always be able to locate them, even when the application
+    namespace has changed.
 
 Classmap
 ========
@@ -70,9 +70,9 @@ The classmap is used extensively by CodeIgniter to eke the last ounces of perfor
 by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
 third-party libraries that are not namespaced::
 
-	$classmap = [
-		'Markdown' => APPPATH .'third_party/markdown.php'
-	];
+    $classmap = [
+        'Markdown' => APPPATH .'third_party/markdown.php'
+    ];
 
 The key of each row is the name of the class that you want to locate. The value is the path to locate it at.
 
@@ -89,7 +89,7 @@ Composer Support
 ================
 
 Composer support is automatically initialized by default. By default, it looks for Composer's autoload file at
-ROOTPATH.'vendor/autoload.php'. If you need to change the location of that file for any reason, you can modify
+``ROOTPATH.'vendor/autoload.php'``. If you need to change the location of that file for any reason, you can modify
 the value defined in ``Config\Constants.php``.
 
 .. note:: If the same namespace is defined in both CodeIgniter and Composer, CodeIgniter's autoloader will be

user_guide_src/source/general/ajax.rst

@@ -16,13 +16,9 @@ Fetch API
     fetch(url, {
         method: "get",
         headers: {
-
           "Content-Type": "application/json",
-
           "X-Requested-With": "XMLHttpRequest"
-
         }
-
     });
 
 
@@ -35,9 +31,7 @@ For libraries like jQuery for example, it is not necessary to make explicit the
 
     $.ajax({
         url: "your url",
-
         headers: {'X-Requested-With': 'XMLHttpRequest'}
-
     });
 
 

user_guide_src/source/general/common_functions.rst

@@ -2,7 +2,7 @@
 Global Functions and Constants
 ##############################
 
-CodeIgniter uses provides a few functions and variables that are globally defined, and are available to you at any point.
+CodeIgniter provides a few functions and variables that are globally defined, and are available to you at any point.
 These do not require loading any additional libraries or helpers.
 
 .. contents::
@@ -81,6 +81,14 @@ Service Accessors
 
 	For more information, see the :doc:`Localization </outgoing/localization>` page.
 
+.. php:function:: model($name [, $getShared = true [, &$conn = null ]])
+
+    :param string                   $name:
+    :param boolean                  $getShared:
+    :param ConnectionInterface|null $conn:
+    :returns: More simple way of getting model instances
+    :rtype: mixed
+
 .. php:function:: old( $key[, $default = null, [, $escape = 'html' ]] )
 
 	:param string $key: The name of the old form data to check for.
@@ -166,9 +174,27 @@ Service Accessors
 
 	For more details, see the :doc:`Views </outgoing/views>` page.
 
+.. php:function:: view_cell ( $library [, $params = null [, $ttl = 0 [, $cacheName = null]]] )
+
+    :param string      $library:
+    :param null        $params:
+    :param integer     $ttl:
+    :param string|null $cacheName:
+    :returns: View cells are used within views to insert HTML chunks that are managed by other classes.
+    :rtype: string
+
+    For more details, see the :doc:`View Cells </outgoing/view_cells>` page.
+
 Miscellaneous Functions
 =======================
 
+.. php:function:: app_timezone ()
+
+    :returns: The timezone the application has been set to display dates in.
+    :rtype: string
+
+    Returns the timezone the application has been set to display dates in.
+
 .. php:function:: csrf_token ()
 
 	:returns: The name of the current CSRF token.
@@ -195,7 +221,7 @@ Miscellaneous Functions
 	:returns: A string with the HTML for hidden input with all required CSRF information.
 	:rtype: string
 
-	Returns a hidden input with the CSRF information already inserted:
+	Returns a hidden input with the CSRF information already inserted::
 
 		<input type="hidden" name="{csrf_token}" value="{csrf_hash}">
 
@@ -204,7 +230,7 @@ Miscellaneous Functions
 	:returns: A string with the HTML for meta tag with all required CSRF information.
 	:rtype: string
 
-	Returns a meta tag with the CSRF information already inserted:
+	Returns a meta tag with the CSRF information already inserted::
 
 		<meta name="{csrf_header}" content="{csrf_hash}">
 
@@ -219,11 +245,23 @@ Miscellaneous Functions
 	but through HTTPS. Will set the HTTP Strict Transport Security header, which instructs
 	modern browsers to automatically modify any HTTP requests to HTTPS requests for the $duration.
 
+.. php:function:: function_usable ( $function_name )
+
+    :param string $function_name: Function to check for
+    :returns: TRUE if the function exists and is safe to call, FALSE otherwise.
+    :rtype: bool
+
 .. php:function:: is_cli ()
 
 	:returns: TRUE if the script is being executed from the command line or FALSE otherwise.
 	:rtype: bool
 
+.. php:function:: is_really_writable ( $file )
+
+    :param string $file: The filename being checked.
+    :returns: TRUE if you can write to the file, FALSE otherwise.
+    :rtype: bool
+
 .. php:function:: log_message ($level, $message [, $context])
 
 	:param   string   $level: The level of severity
@@ -319,6 +357,14 @@ Miscellaneous Functions
 	function will return a new instance of the class, where **service** returns the same
 	instance every time.
 
+.. php:function:: slash_item ( $item )
+
+    :param string $item: Config item name
+    :returns: The configuration item or NULL if the item doesn't exist
+    :rtype:  string|null
+
+    Fetch a config file item with slash appended (if not empty)
+
 .. php:function:: stringify_attributes ( $attributes [, $js] )
 
 	:param   mixed    $attributes: string, array of key value pairs, or object

user_guide_src/source/general/errors.rst

@@ -20,39 +20,40 @@ This section is a quick overview for newer programmers, or for developers who ar
 Exceptions are simply events that happen when the exception is "thrown". This halts the current flow of the script, and
 execution is then sent to the error handler which displays the appropriate error page::
 
-	throw new \Exception("Some message goes here");
+    throw new \Exception("Some message goes here");
 
 If you are calling a method that might throw an exception, you can catch that exception using a ``try/catch`` block::
 
-	try {
-		$user = $userModel->find($id);
-	}
-	catch (\Exception $e)
-	{
-		die($e->getMessage());
-	}
+    try
+    {
+        $user = $userModel->find($id);
+    }
+    catch (\Exception $e)
+    {
+        die($e->getMessage());
+    }
 
 If the ``$userModel`` throws an exception, it is caught and the code within the catch block is executed. In this example,
 the scripts dies, echoing the error message that the ``UserModel`` defined.
 
-In this example, we catch any type of Exception. If we only want to watch for specific types of exceptions, like
-a UnknownFileException, we can specify that in the catch parameter. Any other exceptions that are thrown and are
+In the example above, we catch any type of Exception. If we only want to watch for specific types of exceptions, like
+a ``UnknownFileException``, we can specify that in the catch parameter. Any other exceptions that are thrown and are
 not child classes of the caught exception will be passed on to the error handler::
 
-	catch (\CodeIgniter\UnknownFileException $e)
-	{
-		// do something here...
-	}
+    catch (\CodeIgniter\UnknownFileException $e)
+    {
+        // do something here...
+    }
 
 This can be handy for handling the error yourself, or for performing cleanup before the script ends. If you want
 the error handler to function as normal, you can throw a new exception within the catch block::
 
-	catch (\CodeIgniter\UnknownFileException $e)
-	{
-		// do something here...
+    catch (\CodeIgniter\UnknownFileException $e)
+    {
+        // do something here...
 
-		throw new \RuntimeException($e->getMessage(), $e->getCode(), $e);
-	}
+        throw new \RuntimeException($e->getMessage(), $e->getCode(), $e);
+    }
 
 Configuration
 =============
@@ -97,10 +98,10 @@ This is used to signal a 404, Page Not Found error. When thrown, the system will
 If, in ``Config/Routes.php``, you have specified a 404 Override, that will be called instead of the standard
 404 page::
 
-	if (! $page = $pageModel->find($id))
-	{
-		throw \CodeIgniter\Exceptions\PageNotFoundException::forPageNotFound();
-	}
+    if (! $page = $pageModel->find($id))
+    {
+        throw \CodeIgniter\Exceptions\PageNotFoundException::forPageNotFound();
+    }
 
 You can pass a message into the exception that will be displayed in place of the default message on the 404 page.
 
@@ -110,7 +111,7 @@ ConfigException
 This exception should be used when the values from the configuration class are invalid, or when the config class
 is not the right type, etc::
 
-	throw new \CodeIgniter\Exceptions\ConfigException();
+    throw new \CodeIgniter\Exceptions\ConfigException();
 
 This provides an HTTP status code of 500 and an exit code of 3.
 
@@ -120,7 +121,7 @@ DatabaseException
 This exception is thrown for database errors, such as when the database connection cannot be created,
 or when it is temporarily lost::
 
-	throw new \CodeIgniter\Database\Exceptions\DatabaseException();
+    throw new \CodeIgniter\Database\Exceptions\DatabaseException();
 
 This provides an HTTP status code of 500 and an exit code of 8.
 
@@ -130,9 +131,9 @@ RedirectException
 This exception is a special case allowing for overriding of all other response routing and
 forcing a redirect to a specific route or URL::
 
-	throw new \CodeIgniter\Router\Exceptions\RedirectException($route);
+    throw new \CodeIgniter\Router\Exceptions\RedirectException($route);
 
 ``$route`` may be a named route, relative URI, or a complete URL. You can also supply a
 redirect code to use instead of the default (``302``, "temporary redirect")::
 
-	throw new \CodeIgniter\Router\Exceptions\RedirectException($route, 301);
+    throw new \CodeIgniter\Router\Exceptions\RedirectException($route, 301);