Merge pull request #5457 from kenjis/fix-docs-entities.rst

docs: fix entities.rst

Author: kenjis

user_guide_src/source/models/entities.rst

@@ -106,13 +106,13 @@ Now that all of the pieces are in place, you would work with the Entity class as
     $user->email    = 'foo@example.com';
     $userModel->save($user);
 
-You may have noticed that the User class has not set any properties for the columns, but you can still
-access them as if they were public properties. The base class, **CodeIgniter\\Entity**, takes care of this for you, as
-well as providing the ability to check the properties with **isset()**, or **unset()** the property, and keep track
+You may have noticed that the ``User`` class has not set any properties for the columns, but you can still
+access them as if they were public properties. The base class, ``CodeIgniter\Entity\Entity``, takes care of this for you, as
+well as providing the ability to check the properties with ``isset()``, or ``unset()`` the property, and keep track
 of what columns have changed since the object was created or pulled from the database.
 
-When the User is passed to the model's **save()** method, it automatically takes care of reading the  properties
-and saving any changes to columns listed in the model's **$allowedFields** property. It also knows whether to create
+When the User is passed to the model's ``save()`` method, it automatically takes care of reading the  properties
+and saving any changes to columns listed in the model's ``$allowedFields`` property. It also knows whether to create
 a new row, or update an existing one.
 
 .. note:: When we are making a call to the ``insert()`` all the values from Entity are passed to the method, but when we
@@ -123,7 +123,7 @@ Filling Properties Quickly
 
 The Entity class also provides a method, ``fill()`` that allows you to shove an array of key/value pairs into the class
 and populate the class properties. Any property in the array will be set on the Entity. However, when saving through
-the model, only the fields in $allowedFields will actually be saved to the database, so you can store additional data
+the model, only the fields in ``$allowedFields`` will actually be saved to the database, so you can store additional data
 on your entities without worrying much about stray fields getting saved incorrectly.
 
 ::
@@ -198,7 +198,7 @@ Here's an updated User entity to provide some examples of how this could be used
 
 The first thing to notice is the name of the methods we've added. For each one, the class expects the snake_case
 column name to be converted into PascalCase, and prefixed with either ``set`` or ``get``. These methods will then
-be automatically called whenever you set or retrieve the class property using the direct syntax (i.e., $user->email).
+be automatically called whenever you set or retrieve the class property using the direct syntax (i.e., ``$user->email``).
 The methods do not need to be public unless you want them accessed from other classes. For example, the ``created_at``
 class property will be accessed through the ``setCreatedAt()`` and ``getCreatedAt()`` methods.
 
@@ -239,10 +239,10 @@ As an example, imagine you have the simplified User Entity that is used througho
     class User extends Entity
     {
         protected $attributes = [
-            'id' => null,
-            'name' => null, // Represents a username
-            'email' => null,
-            'password' => null,
+            'id'         => null,
+            'name'       => null, // Represents a username
+            'email'      => null,
+            'password'   => null,
             'created_at' => null,
             'updated_at' => null,
         ];
@@ -266,10 +266,10 @@ simply map the ``full_name`` column in the database to the ``$name`` property, a
     class User extends Entity
     {
         protected $attributes = [
-            'id' => null,
-            'name' => null, // Represents a username
-            'email' => null,
-            'password' => null,
+            'id'         => null,
+            'name'       => null, // Represents a username
+            'email'      => null,
+            'password'   => null,
             'created_at' => null,
             'updated_at' => null,
         ];
@@ -299,7 +299,7 @@ By default, the Entity class will convert fields named `created_at`, `updated_at
 :doc:`Time </libraries/time>` instances whenever they are set or retrieved. The Time class provides a large number
 of helpful methods in an immutable, localized way.
 
-You can define which properties are automatically converted by adding the name to the **options['dates']** array::
+You can define which properties are automatically converted by adding the name to the ``$dates`` property::
 
     <?php
 
@@ -327,14 +327,14 @@ current timezone, as set in **app/Config/App.php**::
 Property Casting
 ----------------
 
-You can specify that properties in your Entity should be converted to common data types with the **casts** property.
+You can specify that properties in your Entity should be converted to common data types with the ``$casts`` property.
 This option should be an array where the key is the name of the class property, and the value is the data type it
 should be cast to. Casting only affects when values are read. No conversions happen that affect the permanent value in
 either the entity or the database. Properties can be cast to any of the following data types:
 **integer**, **float**, **double**, **string**, **boolean**, **object**, **array**, **datetime**, **timestamp**, and **uri**.
 Add a question mark at the beginning of type to mark property as nullable, i.e., **?string**, **?integer**.
 
-For example, if you had a User entity with an **is_banned** property, you can cast it as a boolean::
+For example, if you had a User entity with an ``is_banned`` property, you can cast it as a boolean::
 
     <?php
 
@@ -356,8 +356,8 @@ Array/Json Casting
 Array/Json casting is especially useful with fields that store serialized arrays or json in them. When cast as:
 
 * an **array**, they will automatically be unserialized,
-* a **json**, they will automatically be set as an value of json_decode($value, false),
-* a **json-array**, they will automatically be set as an value of json_decode($value, true),
+* a **json**, they will automatically be set as an value of ``json_decode($value, false)``,
+* a **json-array**, they will automatically be set as an value of ``json_decode($value, true)``,
 
 when you set the property's value.
 Unlike the rest of the data types that you can cast properties into, the:
@@ -425,15 +425,15 @@ Custom casting
 You can define your own conversion types for getting and setting data.
 
 At first you need to create a handler class for your type.
-Let's say the class will be located in the 'app/Entity/Cast' directory::
+Let's say the class will be located in the **app/Entity/Cast** directory::
 
     <?php
 
     namespace App\Entity\Cast;
 
     use CodeIgniter\Entity\Cast\BaseCast;
 
-    //The class must inherit the CodeIgniter\Entity\Cast\BaseCast class
+    // The class must inherit the CodeIgniter\Entity\Cast\BaseCast class
     class CastBase64 extends BaseCast
     {
         public static function get($value, array $params = [])
@@ -462,13 +462,13 @@ Now you need to register it::
             'key' => 'base64',
         ];
 
-        //Bind the type to the handler
+        // Bind the type to the handler
         protected $castHandlers = [
             'base64' => \App\Entity\Cast\CastBase64::class,
         ];
     }
 
-    //...
+    // ...
 
     $entity->key = 'test'; // dGVzdA==
     echo $entity->key;     // test