Merge pull request #6027 from kenjis/fix-docs-concepts

docs: small improvements in concepts

Author: kenjis

user_guide_src/source/concepts/autoloader.rst

@@ -28,13 +28,13 @@ The autoloader is always active, being registered with ``spl_autoload_register()
 beginning of the framework's execution.
 
 Configuration
-=============
+*************
 
 Initial configuration is done in **app/Config/Autoload.php**. This file contains two primary
 arrays: one for the classmap, and one for PSR-4 compatible namespaces.
 
 Namespaces
-==========
+**********
 
 The recommended method for organizing your classes is to create one or more namespaces for your
 application's files. This is most important for any business-logic related classes, entity classes,
@@ -61,7 +61,7 @@ You will need to modify any existing files that are referencing the current name
     namespace has changed.
 
 Classmap
-========
+********
 
 The classmap is used extensively by CodeIgniter to eke the last ounces of performance out of the system
 by not hitting the file-system with extra ``is_file()`` calls. You can use the classmap to link to
@@ -72,7 +72,7 @@ third-party libraries that are not namespaced:
 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.
 
 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

user_guide_src/source/concepts/factories.rst

@@ -7,10 +7,10 @@ Factories
     :depth: 2
 
 Introduction
-============
+************
 
 What are Factories?
--------------------
+===================
 
 Like :doc:`./services`, **Factories** are an extension of autoloading that helps keep your code
 concise yet optimal, without having to pass around object instances between classes.
@@ -25,7 +25,7 @@ to work on or transmit common data. The framework itself uses Factories internal
 make sure the correct configuration is loaded when using the ``Config`` class.
 
 Differences from Services
--------------------------
+=========================
 
 Factories require a concrete class name to instantiate and do not have code to create instances.
 
@@ -37,7 +37,7 @@ that needs other services or class instances. When you get a service, Services r
 not a class name, so the returned instance can be changed without changing the client code.
 
 Example
--------
+=======
 
 Take a look at **Models** as an example. You can access the Factory specific to Models
 by using the magic static method of the Factories class, ``Factories::models()``.
@@ -69,26 +69,26 @@ you get back the instance as before:
 .. literalinclude:: factories/003.php
 
 Convenience Functions
-=====================
+*********************
 
 Two shortcut functions for Factories have been provided. These functions are always available.
 
 config()
---------
+========
 
 The first is ``config()`` which returns a new instance of a Config class. The only required parameter is the class name:
 
 .. literalinclude:: factories/008.php
 
 model()
---------
+=======
 
 The second function, ``model()`` returns a new instance of a Model class. The only required parameter is the class name:
 
 .. literalinclude:: factories/009.php
 
 Factory Parameters
-==================
+******************
 
 ``Factories`` takes as a second parameter an array of option values (described below).
 These directives will override the default options configured for each component.
@@ -106,7 +106,7 @@ class instance that uses the alternate database connection.
 .. _factories-options:
 
 Factories Options
-==================
+*****************
 
 The default behavior might not work for every component. For example, say your component
 name and its path do not align, or you need to limit instances to a certain type of class.
@@ -127,7 +127,7 @@ preferApp  boolean        Whether a class with the same basename in the App name
 ========== ============== ============================================================ ===================================================
 
 Factories Behavior
-==================
+******************
 
 Options can be applied in one of three ways (listed in ascending priority):
 
@@ -136,7 +136,7 @@ Options can be applied in one of three ways (listed in ascending priority):
 * Passing options directly at call time with a parameter.
 
 Configurations
---------------
+==============
 
 To set default component options, create a new Config files at **app/Config/Factory.php**
 that supplies options as an array property that matches the name of the component.
@@ -154,7 +154,7 @@ This would prevent conflict of an third-party module which happened to have an
 unrelated ``Filters`` path in its namespace.
 
 setOptions Method
------------------
+=================
 
 The ``Factories`` class has a static method to allow runtime option configuration: simply
 supply the desired array of options using the ``setOptions()`` method and they will be
@@ -163,7 +163,7 @@ merged with the default values and stored for the next call:
 .. literalinclude:: factories/006.php
 
 Parameter Options
------------------
+=================
 
 ``Factories``'s magic static call takes as a second parameter an array of option values.
 These directives will override the stored options configured for each component and can be
@@ -175,4 +175,4 @@ a component. By adding a second parameter to the magic static call, you can cont
 that single call will return a new or shared instance:
 
 .. literalinclude:: factories/007.php
-   :lines: 2-
+   :lines: 2-

user_guide_src/source/concepts/http.rst

@@ -9,8 +9,12 @@ concepts behind HTTP is a **must** for all developers that want to be successful
 The first part of this chapter gives an overview. After the concepts are out of the way, we will discuss
 how to work with the requests and responses within CodeIgniter.
 
+.. contents::
+    :local:
+    :depth: 2
+
 What is HTTP?
-=============
+*************
 
 HTTP is simply a text-based convention that allows two machines to talk to each other. When a browser
 requests a page, it asks the server if it can get the page. The server then prepares the page and sends
@@ -22,7 +26,8 @@ you develop web applications is to always understand what the browser is request
 respond appropriately.
 
 The Request
------------
+===========
+
 Whenever a client (a web browser, smartphone app, etc) makes a request, it sends a small text message
 to the server and waits for a response.
 
@@ -42,7 +47,7 @@ client accepts, and much more. Wikipedia has an article that lists `all header f
 <https://en.wikipedia.org/wiki/List_of_HTTP_header_fields>`_ if you want to look it over.
 
 The Response
-------------
+============
 
 Once the server receives the request, your application will take that information and generate some output.
 The server will bundle your output as part of its response to the client. This is also represented as
@@ -64,7 +69,7 @@ wasn't found (404). Head over to IANA for a `full list of HTTP status codes
 <https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml>`_.
 
 Working with Requests and Responses
------------------------------------
+***********************************
 
 While PHP provides ways to interact with the request and response headers, CodeIgniter, like most frameworks,
 abstracts them so that you have a consistent, simple interface to them. The :doc:`IncomingRequest class </incoming/incomingrequest>`

user_guide_src/source/concepts/mvc.rst

@@ -2,10 +2,20 @@
 Models, Views, and Controllers
 ##############################
 
+.. contents::
+    :local:
+    :depth: 2
+
+************
+What is MVC?
+************
+
 Whenever you create an application, you have to find a way to organize the code to make it simple to locate
 the proper files and make it simple to maintain. Like most of the web frameworks, CodeIgniter uses the Model,
 View, Controller (MVC) pattern to organize the files. This keeps the data, the presentation, and flow through the
-application as separate parts. It should be noted that there are many views on the exact roles of each element,
+application as separate parts.
+
+It should be noted that there are many views on the exact roles of each element,
 but this document describes our take on it. If you think of it differently, you're free to modify how you use
 each piece as you need.
 
@@ -18,7 +28,7 @@ the data storage.
 
 At their most basic, controllers and models are simply classes that have a specific job. They are not the only class
 types that you can use, obviously, but they make up the core of how this framework is designed to be used. They even
-have designated directories in the **/app** directory for their storage, though you're free to store them
+have designated directories in the **app** directory for their storage, though you're free to store them
 wherever you desire, as long as they are properly namespaced. We will discuss that in more detail below.
 
 Let's take a closer look at each of these three main components.