docs: update coding style and its explanation

Author: kenjis

user_guide_src/source/tutorial/create_news_items.rst

@@ -33,7 +33,7 @@ the slug from our title in the model. Create a new view at
 
     <h2><?= esc($title) ?></h2>
 
-    <?= \Config\Services::validation()->listErrors() ?>
+    <?= service('validation')->listErrors() ?>
 
     <form action="/news/create" method="post">
         <?= csrf_field() ?>
@@ -48,7 +48,7 @@ the slug from our title in the model. Create a new view at
     </form>
 
 There are probably only two things here that look unfamiliar. The
-``\Config\Services::validation()->listErrors()`` function is used to report
+``service('validation')->listErrors()`` function is used to report
 errors related to form validation. The ``csrf_field()`` function creates
 a hidden input with a CSRF token that helps protect against some common attacks.
 
@@ -61,7 +61,7 @@ validation <../libraries/validation>` library to do this.
 
     public function create()
     {
-        $model = new NewsModel();
+        $model = model(NewsModel::class);
 
         if ($this->request->getMethod() === 'post' && $this->validate([
             'title' => 'required|min_length[3]|max_length[255]',
@@ -74,7 +74,6 @@ validation <../libraries/validation>` library to do this.
             ]);
 
             echo view('news/success');
-
         } else {
             echo view('templates/header', ['title' => 'Create a news item']);
             echo view('news/create');

user_guide_src/source/tutorial/news_section.rst

@@ -27,10 +27,10 @@ and :doc:`Seeds <../dbmgmt/seeds>` to create more useful database setups later.
 ::
 
     CREATE TABLE news (
-        id int(11) NOT NULL AUTO_INCREMENT,
-        title varchar(128) NOT NULL,
-        slug varchar(128) NOT NULL,
-        body text NOT NULL,
+        id INT UNSIGNED NOT NULL AUTO_INCREMENT,
+        title VARCHAR(128) NOT NULL,
+        slug VARCHAR(128) NOT NULL,
+        body TEXT NOT NULL,
         PRIMARY KEY (id),
         KEY slug (slug)
     );
@@ -111,22 +111,20 @@ following code to your model.
             return $this->findAll();
         }
 
-        return $this->asArray()
-                    ->where(['slug' => $slug])
-                    ->first();
+        return return $this->where(['slug' => $slug])->first();
     }
 
 With this code, you can perform two different queries. You can get all
-news records, or get a news item by its `slug <#>`_. You might have
-noticed that the ``$slug`` variable wasn't sanitized before running the
+news records, or get a news item by its slug. You might have
+noticed that the ``$slug`` variable wasn't escaped before running the
 query; :doc:`Query Builder <../database/query_builder>` does this for you.
 
 The two methods used here, ``findAll()`` and ``first()``, are provided
-by the Model class. They already know the table to use based on the ``$table``
+by the ``CodeIgniter\Model`` class. They already know the table to use based on the ``$table``
 property we set in **NewsModel** class, earlier. They are helper methods
 that use the Query Builder to run their commands on the current table, and
 returning an array of results in the format of your choice. In this example,
-``findAll()`` returns an array of objects.
+``findAll()`` returns an array of array.
 
 Display the news
 -------------------------------------------------------
@@ -150,14 +148,14 @@ a new ``News`` controller is defined. Create the new controller at
     {
         public function index()
         {
-            $model = new NewsModel();
+            $model = model(NewsModel::class);
 
             $data['news'] = $model->getNews();
         }
 
         public function view($slug = null)
         {
-            $model = new NewsModel();
+            $model = model(NewsModel::class);
 
             $data['news'] = $model->getNews($slug);
         }
@@ -170,7 +168,13 @@ access to the current ``Request`` and ``Response`` objects, as well as the
 ``Logger`` class, for saving information to disk.
 
 Next, there are two methods, one to view all news items, and one for a specific
-news item. You can see that the ``$slug`` variable is passed to the model's
+news item.
+
+Next, the ``model()`` function is used to create the **NewsModel** instance.
+This is a helper function. You can read more about it :doc:`here </general/common_functions>`.
+You could also write ``$model = new NewsModel();``, if you don't use it.
+
+You can see that the ``$slug`` variable is passed to the model's
 method in the second method. The model is using this slug to identify the
 news item to be returned.
 
@@ -180,7 +184,7 @@ the views. Modify the ``index()`` method to look like this::
 
     public function index()
     {
-        $model = new NewsModel();
+        $model = model(NewsModel::class);
 
         $data = [
             'news'  => $model->getNews(),
@@ -202,7 +206,7 @@ and add the next piece of code.
 
     <h2><?= esc($title) ?></h2>
 
-    <?php if (! empty($news) && is_array($news)) : ?>
+    <?php if (! empty($news) && is_array($news)): ?>
 
         <?php foreach ($news as $news_item): ?>
 
@@ -215,7 +219,7 @@ and add the next piece of code.
 
         <?php endforeach; ?>
 
-    <?php else : ?>
+    <?php else: ?>
 
         <h3>No News</h3>
 
@@ -244,13 +248,12 @@ add some code to the controller and create a new view. Go back to the
 
     public function view($slug = null)
     {
-        $model = new NewsModel();
+        $model = model(NewsModel::class);
 
         $data['news'] = $model->getNews($slug);
 
-        if (empty($data['news']))
-        {
-            throw new \CodeIgniter\Exceptions\PageNotFoundException('Cannot find the news item: '. $slug);
+        if (empty($data['news'])) {
+            throw new \CodeIgniter\Exceptions\PageNotFoundException('Cannot find the news item: ' . $slug);
         }
 
         $data['title'] = $data['news']['title'];

user_guide_src/source/tutorial/static_pages.rst

@@ -129,15 +129,15 @@ in the ``Pages`` controller created above:
 
     public function view($page = 'home')
     {
-        if ( ! is_file(APPPATH.'/Views/pages/'.$page.'.php')) {
+        if (! is_file(APPPATH . 'Views/pages/' . $page . '.php')) {
             // Whoops, we don't have a page for that!
             throw new \CodeIgniter\Exceptions\PageNotFoundException($page);
         }
 
         $data['title'] = ucfirst($page); // Capitalize the first letter
 
         echo view('templates/header', $data);
-        echo view('pages/'.$page, $data);
+        echo view('pages/' . $page, $data);
         echo view('templates/footer', $data);
     }