style: update coding style with php-cs-fixer 3.46.0 by kenjis · Pull Request #8400 · codeigniter4/CodeIgniter4

kenjis · 2024-01-05T08:19:09Z

Description

update coding style

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2024-01-05T08:58:30Z

 try {
    // ...
-} catch (\Exception $e) {
+} catch (Exception $e) {


Is it better to set leading_backslash_in_global_namespace to true for User Guide?
See https://cs.symfony.com/doc/rules/import/fully_qualified_strict_types.html

If we do so, the leading \ will not be removed, and if it is not in the current sample code it will be added.

leading backlash has no effect when in global namespace, right? so adding it is superfluous.

It has no effect in PHP syntax, but actually most code will be written in some namespace like App\Controllers,
So when there is no leading backslash, if a user copies and pastes the sample code, the code will not work unless they import the class.

Is it better that sample code should work as it is as possible when a dev copies and pastes?

In such cases, it may be better to add namespaces for those files.

IMO the code copied from the user guide should work out of the box. Less experienced users may not know they have to import the class. If there is a way to automatically add an import to our code examples then that would be fine. Otherwise, I would leave it as it is.

the code copied from the user guide should work out of the box.

I agree with this.

import_symbols option imports symbols when the classname in the code is namespaced (containing \).
But Exception in the above sample is not imported.

kenjis · 2024-01-06T01:24:12Z

 }

-$object = new Myclass();
+$object = new \Myclass();


Where should we put this Myclass?

Libraries?

Thanks. Done

kenjis · 2024-01-06T01:25:42Z


 // Call on an instance method
-$user = new User();
+$user = new \User();


Where should we put thisUser?

Libraries?

kenjis · 2024-01-06T01:41:29Z

 final class AuthenticationFeatureTest extends CIUnitTestCase
 {
-    use AuthTrait;
+    use \AuthTrait;


Where should we put this trait?

The code copied from the user guide should work out of the box as possible.

kenjis commented Jan 5, 2024

View reviewed changes

kenjis force-pushed the style-cs-fixer-3.46.0 branch from 2474290 to eb88fd4 Compare January 6, 2024 00:51

kenjis commented Jan 6, 2024

View reviewed changes

kenjis force-pushed the style-cs-fixer-3.46.0 branch from b0451da to abb734c Compare January 7, 2024 01:15

kenjis requested review from michalsn and paulbalandan January 7, 2024 01:43

kenjis added 17 commits January 7, 2024 10:49

docs: remove redundant @return

f6a59e6

test: update coding style with php-cs-fixer

0643f57

docs: update coding style with php-cs-fixer

be3397b

docs: add namespace to sample code in testing

73f5d46

chore: change coding style for User Guide sample code

44d0bb6

The code copied from the user guide should work out of the box as possible.

docs: update coding style with php-cs-fixer

f7ce5cd

docs: add type to class property in sample code

123f378

docs: fix incorrect global classname in sample code

5fc0849

docs: fix incorrect global classname in sample code

37a4a52

docs: add namespace App\Libraries to sample code

20996a8

docs: add namespace to sample class

4dd42c2

docs: fix namespace for UserModel

3a06211

docs: add namespace App\Libraries to sample code

3d78f16

docs: fix namespaces for sample classes

4bbc13c

docs: improve $builder->insert() description

192c5b2

docs: split sample code file

702261d

docs: improve sample for insert(), update(), upsert()

73cb246

kenjis force-pushed the style-cs-fixer-3.46.0 branch from c972f1e to 73cb246 Compare January 7, 2024 01:49

paulbalandan approved these changes Jan 7, 2024

View reviewed changes

michalsn approved these changes Jan 7, 2024

View reviewed changes

kenjis merged commit c0d134a into codeigniter4:develop Jan 7, 2024

kenjis deleted the style-cs-fixer-3.46.0 branch January 7, 2024 11:07

Conversation

kenjis commented Jan 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kenjis commented Jan 5, 2024 •

edited

Loading