Merge pull request #5772 from kenjis/fix-docs-fix-empty-line

docs: add/remove empty line in sample code

user_guide_src/source/concepts/services/007.php

@@ -10,5 +10,6 @@ class Services extends BaseService
     {
         return new \App\Router\MyRouter();
     }
+
     // ...
 }

user_guide_src/source/concepts/services/008.php

@@ -10,5 +10,6 @@ class Services extends BaseService
     {
         return new \CodeIgniter\View\View($viewPath);
     }
+
     // ...
 }

user_guide_src/source/concepts/services/010.php

@@ -14,5 +14,6 @@ class Services extends BaseService
 
         return static::getSharedInstance('routes');
     }
+
     // ...
 }

user_guide_src/source/database/configuration/006.php

@@ -24,5 +24,6 @@ class Database extends Config
         'strictOn' => false,
         'failover' => [],
     ];
+
     // ...
 }

user_guide_src/source/database/helpers/001.php

@@ -1,5 +1,4 @@
 <?php
 
 echo $db->table('my_table')->countAll();
-
 // Produces an integer, like 25

user_guide_src/source/database/helpers/002.php

@@ -1,5 +1,4 @@
 <?php
 
 echo $db->table('my_table')->like('title', 'match')->countAllResults();
-
 // Produces an integer, like 5

user_guide_src/source/database/query_builder/005.php

@@ -2,5 +2,4 @@
 
 $sql = $builder->getCompiledSelect();
 echo $sql;
-
 // Prints string: SELECT * FROM mytable

user_guide_src/source/database/query_builder/008.php

@@ -2,5 +2,4 @@
 
 $builder->select('title, content, date');
 $query = $builder->get();
-
 // Executes: SELECT title, content, date FROM mytable

user_guide_src/source/database/query_builder/016.php

@@ -3,5 +3,4 @@
 $subquery = $db->table('users');
 $builder  = $db->table('jobs')->fromSubquery($subquery, 'alias');
 $query = $builder->get();
-
 // Produces: SELECT * FROM `jobs`, (SELECT * FROM `users`) AS `alias`

user_guide_src/source/database/query_builder/017.php

@@ -3,5 +3,4 @@
 $subquery = $db->table('users')->select('id, name');
 $builder  = $db->newQuery()->fromSubquery($subquery, 't');
 $query = $builder->get();
-
 // Produces: SELECT * FROM (SELECT `id`, `name` FROM users) AS `t`

user_guide_src/source/database/query_builder/027.php

@@ -1,11 +1,9 @@
 <?php
 
 // With closure
-
 $builder->where('advance_amount <', function (BaseBuilder $builder) {
     return $builder->select('MAX(advance_amount)', false)->from('orders')->where('id >', 2);
 });
-
 // Produces: WHERE "advance_amount" < (SELECT MAX(advance_amount) FROM "orders" WHERE "id" > 2)
 
 // With builder directly

user_guide_src/source/database/query_builder/032.php

@@ -4,7 +4,6 @@
 $builder->orWhereIn('id', function (BaseBuilder $builder) {
     return $builder->select('job_id')->from('users_jobs')->where('user_id', 3);
 });
-
 // Produces: OR "id" IN (SELECT "job_id" FROM "users_jobs" WHERE "user_id" = 3)
 
 // With builder directly

user_guide_src/source/database/query_builder/034.php

@@ -4,7 +4,6 @@
 $builder->whereNotIn('id', function (BaseBuilder $builder) {
     return $builder->select('job_id')->from('users_jobs')->where('user_id', 3);
 });
-
 // Produces: WHERE "id" NOT IN (SELECT "job_id" FROM "users_jobs" WHERE "user_id" = 3)
 
 // With builder directly

user_guide_src/source/database/query_builder/036.php

@@ -4,7 +4,6 @@
 $builder->orWhereNotIn('id', function (BaseBuilder $builder) {
     return $builder->select('job_id')->from('users_jobs')->where('user_id', 3);
 });
-
 // Produces: OR "id" NOT IN (SELECT "job_id" FROM "users_jobs" WHERE "user_id" = 3)
 
 // With builder directly

user_guide_src/source/database/query_builder/053.php

@@ -4,7 +4,6 @@
 $builder->orHavingIn('id', function (BaseBuilder $builder) {
     return $builder->select('user_id')->from('users_jobs')->where('group_id', 3);
 });
-
 // Produces: OR "id" IN (SELECT "user_id" FROM "users_jobs" WHERE "group_id" = 3)
 
 // With builder directly

user_guide_src/source/database/query_builder/055.php

@@ -4,7 +4,6 @@
 $builder->havingNotIn('id', function (BaseBuilder $builder) {
     return $builder->select('user_id')->from('users_jobs')->where('group_id', 3);
 });
-
 // Produces: HAVING "id" NOT IN (SELECT "user_id" FROM "users_jobs" WHERE "group_id" = 3)
 
 // With builder directly

user_guide_src/source/database/query_builder/057.php

@@ -4,7 +4,6 @@
 $builder->orHavingNotIn('id', function (BaseBuilder $builder) {
     return $builder->select('user_id')->from('users_jobs')->where('group_id', 3);
 });
-
 // Produces: OR "id" NOT IN (SELECT "user_id" FROM "users_jobs" WHERE "group_id" = 3)
 
 // With builder directly

user_guide_src/source/database/query_builder/078.php

@@ -8,5 +8,4 @@ $data = [
 
 $sql = $builder->set($data)->getCompiledInsert();
 echo $sql;
-
 // Produces string: INSERT INTO mytable (`title`, `name`, `date`) VALUES ('My title', 'My name', 'My date')

user_guide_src/source/database/query_builder/079.php

@@ -1,9 +1,7 @@
 <?php
 
 echo $builder->set('title', 'My Title')->getCompiledInsert(false);
-
 // Produces string: INSERT INTO mytable (`title`) VALUES ('My Title')
 
 echo $builder->set('content', 'My Content')->getCompiledInsert();
-
 // Produces string: INSERT INTO mytable (`title`, `content`) VALUES ('My Title', 'My Content')

user_guide_src/source/database/query_builder/081.php

@@ -7,5 +7,4 @@ $data = [
 ];
 
 $builder->replace($data);
-
 // Executes: REPLACE INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date')

user_guide_src/source/database/query_builder/098.php

@@ -3,5 +3,4 @@
 $subquery = $db->table('countries')->select('name')->where('id', 1);
 $builder  = $db->table('users')->select('name')->selectSubquery($subquery, 'country');
 $query = $builder->get();
-
 // Produces: SELECT `name`, (SELECT `name` FROM `countries` WHERE `id` = 1) AS `country` FROM `users`

user_guide_src/source/extending/core_classes/002.php

@@ -14,5 +14,6 @@ class Services extends BaseService
 
         return new \App\Libraries\RouteCollection(static::locator(), config('Modules'));
     }
+
     // ...
 }

user_guide_src/source/general/configuration/008.php

@@ -7,5 +7,6 @@ class MyConfig extends BaseConfig
     public static $registrars = [
         SupportingPackageRegistrar::class,
     ];
+
     // ...
 }

user_guide_src/source/general/logging/002.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class Logger extends BaseConfig
 {
     public $threshold = 5;
+
     // ...
 }

user_guide_src/source/general/logging/003.php

@@ -8,5 +8,6 @@ class Logger extends BaseConfig
 {
     // Log only debug and info type messages
     public $threshold = [5, 8];
+
     // ...
 }

user_guide_src/source/general/logging/004.php

@@ -12,5 +12,6 @@ class Logger extends BaseConfig
             'handles' => ['critical', 'alert', 'emergency', 'debug', 'error', 'info', 'notice', 'warning'],
         ],
     ];
+
     // ...
 }

user_guide_src/source/general/managing_apps/001.php

@@ -5,5 +5,6 @@ namespace Config;
 class Paths
 {
     public $appDirectory = '/path/to/your/app';
+
     // ...
 }

user_guide_src/source/incoming/filters/003.php

@@ -9,5 +9,6 @@ class Filters extends BaseConfig
     public $aliases = [
         'csrf' => \CodeIgniter\Filters\CSRF::class,
     ];
+
     // ...
 }

user_guide_src/source/incoming/filters/004.php

@@ -12,5 +12,6 @@ class Filters extends BaseConfig
             \App\Filters\ApiAuth::class,
         ],
     ];
+
     // ...
 }

user_guide_src/source/incoming/filters/005.php

@@ -12,5 +12,6 @@ class Filters extends BaseConfig
         ],
         'after' => [],
     ];
+
     // ...
 }

user_guide_src/source/incoming/filters/006.php

@@ -12,5 +12,6 @@ class Filters extends BaseConfig
         ],
         'after' => [],
     ];
+
     // ...
 }

user_guide_src/source/incoming/filters/007.php

@@ -12,5 +12,6 @@ class Filters extends BaseConfig
         ],
         'after' => [],
     ];
+
     // ...
 }

user_guide_src/source/incoming/filters/008.php

@@ -10,5 +10,6 @@ class Filters extends BaseConfig
         'post' => ['foo', 'bar'],
         'get'  => ['baz'],
     ];
+
     // ...
 }

user_guide_src/source/incoming/filters/009.php

@@ -10,5 +10,6 @@ class Filters extends BaseConfig
         'foo' => ['before' => ['admin/*'], 'after' => ['users/*']],
         'bar' => ['before' => ['api/*', 'admin/*']],
     ];
+
     // ...
 }

user_guide_src/source/incoming/filters/011.php

@@ -10,5 +10,6 @@ class Filters extends BaseConfig
         // ...
         'secureheaders' => \App\Filters\SecureHeaders::class,
     ];
+
     // ...
 }

user_guide_src/source/libraries/caching/013.php

@@ -7,11 +7,13 @@ use CodeIgniter\Config\BaseConfig;
 class Cache extends BaseConfig
 {
     // ...
+
     public $memcached = [
         'host'   => '127.0.0.1',
         'port'   => 11211,
         'weight' => 1,
         'raw'    => false,
     ];
+
     // ...
 }

user_guide_src/source/libraries/caching/014.php

@@ -15,5 +15,6 @@ class Cache extends BaseConfig
         'timeout'  => 0,
         'database' => 0,
     ];
+
     // ...
 }

user_guide_src/source/libraries/curlrequest/001.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class CURLRequest extends BaseConfig
 {
     public $shareOptions = false;
+
     // ...
 }

user_guide_src/source/libraries/encryption/008.php

@@ -8,7 +8,6 @@ class Encryption extends BaseConfig
 {
     // In Encryption, you may use
     public $key = 'hex2bin:<your-hex-encoded-key>';
-
     // or
     public $key = 'base64:<your-base64-encoded-key>';
     // ...

user_guide_src/source/libraries/honeypot/001.php

@@ -16,5 +16,6 @@ class Filters extends BaseConfig
             'honeypot',
         ],
     ];
+
     // ...
 }

user_guide_src/source/libraries/pagination/010.php

@@ -10,5 +10,6 @@ class Pager extends BaseConfig
         'default_full'   => 'CodeIgniter\Pager\Views\default_full',
         'default_simple' => 'CodeIgniter\Pager\Views\default_simple',
     ];
+
     // ...
 }

user_guide_src/source/libraries/pagination/011.php

@@ -11,5 +11,6 @@ class Pager extends BaseConfig
         'default_simple' => 'CodeIgniter\Pager\Views\default_simple',
         'front_full'     => 'App\Views\Pagers\foundation_full',
     ];
+
     // ...
 }

user_guide_src/source/libraries/security/002.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class Security extends BaseConfig
 {
     public $csrfProtection = 'session';
+
     // ...
 }

user_guide_src/source/libraries/security/003.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class Security extends BaseConfig
 {
     public $tokenRandomize = true;
+
     // ...
 }

user_guide_src/source/libraries/security/004.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class Security extends BaseConfig
 {
     public $regenerate = true;
+
     // ...
 }

user_guide_src/source/libraries/security/006.php

@@ -12,5 +12,6 @@ class Filters extends BaseConfig
             'csrf',
         ],
     ];
+
     // ...
 }

user_guide_src/source/libraries/security/007.php

@@ -11,5 +11,6 @@ class Filters extends BaseConfig
             'csrf' => ['except' => ['api/record/save']],
         ],
     ];
+
     // ...
 }

user_guide_src/source/libraries/security/008.php

@@ -11,5 +11,6 @@ class Filters extends BaseConfig
             'csrf' => ['except' => ['api/record/[0-9]+']],
         ],
     ];
+
     // ...
 }

user_guide_src/source/libraries/security/009.php

@@ -10,5 +10,6 @@ class Filters extends BaseConfig
         'get'  => ['csrf'],
         'post' => ['csrf'],
     ];
+
     // ...
 }

user_guide_src/source/libraries/sessions/010.php

@@ -1,7 +1,5 @@
 <?php
 
 $userData = $_SESSION;
-
 // or:
-
 $userData = $session->get();

user_guide_src/source/libraries/sessions/017.php

@@ -1,9 +1,7 @@
 <?php
 
 unset($_SESSION['some_name']);
-
 // or multiple values:
-
 unset(
     $_SESSION['some_name'],
     $_SESSION['another_name']

user_guide_src/source/libraries/sessions/038.php

@@ -1,7 +1,5 @@
 <?php
 
 session_destroy();
-
 // or
-
 $session->destroy();

user_guide_src/source/libraries/sessions/044.php

@@ -9,5 +9,6 @@ class App extends BaseConfig
     // localhost will be given higher priority (5) here,
     // compared to 192.0.2.1 with a weight of 1.
     public $sessionSavePath = 'localhost:11211:5,192.0.2.1:11211:1';
+
     // ...
 }

user_guide_src/source/libraries/throttler/003.php

@@ -10,5 +10,6 @@ class Filters extends BaseConfig
         // ...
         'throttle' => \App\Filters\Throttle::class,
     ];
+
     // ...
 }

user_guide_src/source/libraries/throttler/004.php

@@ -9,5 +9,6 @@ class Filters extends BaseConfig
     public $methods = [
         'post' => ['throttle'],
     ];
+
     // ...
 }

user_guide_src/source/libraries/validation/003.php

@@ -10,5 +10,6 @@ class Validation
         \CodeIgniter\Validation\StrictRules\FormatRules::class,
         \CodeIgniter\Validation\StrictRules\Rules::class,
     ];
+
     // ...
 }

user_guide_src/source/libraries/validation/013.php

@@ -10,5 +10,6 @@ class Validation
         'pass_confirm' => 'required|matches[password]',
         'email'        => 'required|valid_email',
     ];
+
     // ...
 }

user_guide_src/source/libraries/validation/015.php

@@ -10,6 +10,7 @@ class Validation
         'pass_confirm' => 'required|matches[password]',
         'email'        => 'required|valid_email',
     ];
+
     public $signup_errors = [
         'username' => [
             'required' => 'You must choose a username.',
@@ -18,5 +19,6 @@ class Validation
             'valid_email' => 'Please check the Email field. It does not appear to be valid.',
         ],
     ];
+
     // ...
 }

user_guide_src/source/libraries/validation/031.php

@@ -9,5 +9,6 @@ class Validation
         'single'  => 'CodeIgniter\Validation\Views\single',
         'my_list' => '_errors_list',
     ];
+
     // ...
 }

user_guide_src/source/libraries/validation/032.php

@@ -15,5 +15,6 @@ class Validation
         FileRules::class,
         CreditCardRules::class,
     ];
+
     // ...
 }

user_guide_src/source/outgoing/api_responses/003.php

@@ -10,5 +10,6 @@ class Format extends BaseConfig
         'application/json',
         'application/xml',
     ];
+
     // ...
 }

user_guide_src/source/outgoing/api_responses/004.php

@@ -10,5 +10,6 @@ class Format extends BaseConfig
         'application/json' => \CodeIgniter\Format\JSONFormatter::class,
         'application/xml'  => \CodeIgniter\Format\XMLFormatter::class,
     ];
+
     // ...
 }

user_guide_src/source/outgoing/localization/001.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class App extends BaseConfig
 {
     public $defaultLocale = 'en';
+
     // ...
 }

user_guide_src/source/outgoing/localization/002.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class App extends BaseConfig
 {
     public $negotiateLocale = true;
+
     // ...
 }

user_guide_src/source/outgoing/localization/003.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class App extends BaseConfig
 {
     public $supportedLocales = ['en', 'es', 'fr-FR'];
+
     // ...
 }

user_guide_src/source/outgoing/response/011.php

@@ -7,5 +7,6 @@ use CodeIgniter\Config\BaseConfig;
 class App extends BaseConfig
 {
     public $CSPEnabled = true;
+
     // ...
 }

user_guide_src/source/outgoing/view_decorators/002.php

@@ -9,5 +9,6 @@ class View extends BaseView
     public array $decorators = [
         'App\Views\Decorators\MyDecorator',
     ];
+
     // ...
 }

user_guide_src/source/outgoing/view_parser/005.php

@@ -4,5 +4,4 @@ $template = '<head><title>{blog_title}</title></head>';
 $data     = ['blog_title' => 'My ramblings'];
 
 echo $parser->setData($data)->renderString($template);
-
 // Result: <head><title>My ramblings</title></head>

user_guide_src/source/outgoing/view_parser/012.php

@@ -10,5 +10,6 @@ class View extends BaseView
         'abs'        => '\CodeIgniter\View\Filters::abs',
         'capitalize' => '\CodeIgniter\View\Filters::capitalize',
     ];
+
     // ...
 }

user_guide_src/source/outgoing/view_parser/013.php

@@ -9,5 +9,6 @@ class View extends BaseView
     public $filters = [
         'str_repeat' => '\str_repeat',
     ];
+
     // ...
 }

user_guide_src/source/outgoing/view_parser/014.php

@@ -9,5 +9,6 @@ class View extends BaseView
     public $plugins = [
         'foo' => '\Some\Class::methodName',
     ];
+
     // ...
 }

user_guide_src/source/outgoing/view_parser/015.php

@@ -16,5 +16,6 @@ class View extends BaseView
 
         parent::__construct();
     }
+
     // ...
 }

user_guide_src/source/outgoing/view_parser/017.php

@@ -9,6 +9,7 @@ class View extends BaseView
     public $plugins = [
         'foo' => ['\Some\Class::methodName'],
     ];
+
     // ...
 }
 

user_guide_src/source/outgoing/view_parser/018.php

@@ -8,5 +8,4 @@ $data = [
 ];
 echo $parser->setData($data)
             ->renderString($template);
-
 // Result: Hello, John Doe

user_guide_src/source/outgoing/view_parser/019.php

@@ -8,5 +8,4 @@ $data = [
 ];
 echo $parser->setData($data)
             ->renderString($template);
-
 // Result: Hello, John {initials} Doe

user_guide_src/source/outgoing/view_parser/020.php

@@ -12,5 +12,4 @@ $data = [
 ];
 echo $parser->setData($data)
             ->renderString($template);
-
 // Result: Hello, John Doe (Mr{degree} {/degrees})

user_guide_src/source/testing/controllers/012.php

@@ -15,5 +15,6 @@ final class FilterTestCase extends CIUnitTestCase
 
         $this->assertHasFilters('unfiltered/route', 'before');
     }
+
     // ...
 }

user_guide_src/source/testing/overview/007.php

@@ -7,6 +7,7 @@ trait AuthTrait
         $user = $this->createFakeUser();
         $this->logInUser($user);
     }
+
     // ...
 }
 

user_guide_src/source/tutorial/create_news_items/001.php

@@ -9,5 +9,6 @@ class Filters extends BaseConfig
     public $methods = [
         'post' => ['csrf'],
     ];
+
     // ...
 }