Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add method chaining style specification #16

Merged
merged 2 commits into from
Jul 18, 2022

Conversation

vjik
Copy link
Contributor

@vjik vjik commented May 23, 2022

PR is inspired by yiisoft/docs#155

Placing methods in a chain of methods on separate lines is more readable in most cases. In rare cases, this is not the case, so SHOULD.

$someInstance
->create()
->prepare()
->run();
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placing ; on a separated line is handy as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xepozz I don't like the single ; in a new line.
I saw some people doing it, but because they were adding new lines right after that.

$someInstance
    ->create()
    ->prepare()
    ->run()
;
$anotherInstance->run()

My suggestion is to leave a blank space:

$someInstance
    ->create()
    ->prepare()
    ->run();

$anotherInstance->run()

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just a little handy to comment/move/remove lines when you have ; not at the end of the chain, but I think it's unnecessary to have it as a recommendation :)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in my opinion it is best to admit both versions :)

@samdark samdark added enhancement New feature or request optional labels May 24, 2022
@KorvinSzanto
Copy link
Contributor

I think we should change the "SHOULD" to be "MAY" and I agree that we should allow the parenthesis to be placed on the next line but maybe we can deal with that addition separately.

spec.md Outdated Show resolved Hide resolved
@samdark
Copy link
Member

samdark commented Jul 17, 2022

Replaced SHOULD with MAY.

@KorvinSzanto KorvinSzanto merged commit d210290 into php-fig:master Jul 18, 2022
@vjik vjik deleted the chain-calls branch August 31, 2022 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request optional
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants