Expected `beforeSave()` return value to let save go through?

[mehov]

In some cases, a beforeSave() callback may want to let the save continue without changing the entity.

Documentation at https://book.cakephp.org/5/en/orm/table-objects.html#beforesave does not say what value to return early to accomplish that.

In my case if (something) {return;} works, but I'm not sure if that's the best/recommended way to do it. It could well be, as https://api.cakephp.org/5.0/class-Cake.ORM.Behavior.Translate.ShadowTableStrategy.html#beforeSave() says it's "Returns: void" by default.

Do you think it may be a good idea to explicitly clarify that in the Book for beforeSave() and maybe others?

[mehov]

Please also consider explicitly stating that if you modify an entity you don't have to return it, return; is enough

[markstory]

I think giving some more detail on how to return early from the before callbacks makes sense. Any interest in getting a pull request started?

[mehov]

Sure!

return early from the before callbacks

I'm looking at https://book.cakephp.org/5/en/orm/table-objects.html#event-list and there's many others

Should I do all? Or some of them? Only before*?

I'm guessing "return; continues business as usual" is true for all of them?

[mehov]

Todo:

• Model.initialize
• Model.beforeMarshal
• Model.afterMarshal
• Model.beforeFind
• Model.buildValidator
• Model.buildRules
• Model.beforeRules
• Model.afterRules
• Model.beforeSave
• Model.afterSave
• Model.afterSaveCommit
• Model.beforeDelete
• Model.afterDelete
• Model.afterDeleteCommit

(I hope it allows you to choose too?)