Merge pull request #5490 from kenjis/deprecated-seeder-faker

docs: deprecate Seeder::faker()

Author: kenjis

system/Database/Seeder.php

@@ -68,6 +68,8 @@ class Seeder
      * Faker Generator instance.
      *
      * @var Generator|null
+     *
+     * @deprecated
      */
     private static $faker;
 
@@ -98,6 +100,8 @@ public function __construct(Database $config, ?BaseConnection $db = null)
 
     /**
      * Gets the Faker Generator instance.
+     *
+     * @deprecated
      */
     public static function faker(): ?Generator
     {

tests/system/Database/DatabaseSeederTest.php

@@ -38,6 +38,9 @@ public function testInstantiateNotDirSeedPath()
         new Seeder($config);
     }
 
+    /**
+     * @TODO remove this when Seeder::faker() is removed
+     */
     public function testFakerGet()
     {
         $this->assertInstanceOf(Generator::class, Seeder::faker());

user_guide_src/source/changelogs/v4.1.6.rst

@@ -42,6 +42,8 @@ Changes
 Deprecations
 ************
 
+- ``Seeder::faker()`` and ``Seeder::$faker`` are deprecated.
+
 Sending Cookies
 ===============
 

user_guide_src/source/dbmgmt/seeds.rst

@@ -67,41 +67,6 @@ anywhere the autoloader can find them. This is great for more modular code bases
         $this->call('My\Database\Seeds\CountrySeeder');
     }
 
-Using Faker
-===========
-
-If you want to automate the generation of seed data, you can use
-the `Faker library <https://github.com/fakerphp/faker>`_.
-
-To install Faker into your project::
-
-    > composer require --dev fakerphp/faker
-
-After installation, an instance of ``Faker\Generator`` is available in the main ``Seeder``
-class and is accessible by all child seeders. You must use the static method ``faker()``
-to access the instance.
-
-::
-
-    <?php
-
-    namespace App\Database\Seeds;
-
-    use CodeIgniter\Database\Seeder;
-
-    class UserSeeder extends Seeder
-    {
-        public function run()
-        {
-            $model = model('UserModel');
-
-            $model->insert([
-                'email'      => static::faker()->email,
-                'ip_address' => static::faker()->ipv4,
-            ]);
-        }
-    }
-
 Using Seeders
 =============