Skip to content

Improve docs for checking for the correct Form widget instance #899

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.

Sign up for GitHub

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

Merged
LukeTowers merged 4 commits into from
May 2, 2023
Merged

Improve docs for checking for the correct Form widget instance #899

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
78664d1
Add a note about $formWidget->isNested in extendFields events
mjauvin Apr 29, 2023
d7e7265
add isNested test example
mjauvin May 1, 2023
5a4ae6f
Update modules/backend/widgets/Form.php
LukeTowers May 2, 2023
4cf9515
Update Form.php
LukeTowers May 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 24 additions & 18 deletions modules/backend/widgets/Form.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,8 +500,12 @@ protected function defineFormFields()
* Example usage:
*
* Event::listen('backend.form.extendFieldsBefore', function ((\Backend\Widgets\Form) $formWidget) {
* // You should always check to see if you're extending correct model/controller
* if (!$formWidget->model instanceof \Foo\Example\Models\Bar) {
* // Check that we're extending the correct Form widget instance
* if (
* !($formWidget->getController() instanceof \Winter\User\Controllers\Users)
* || !($formWidget->model instanceof \Winter\User\Models\User)
* || $formWidget->isNested
* ) {
* return;
* }
*
Expand All @@ -518,8 +522,12 @@ protected function defineFormFields()
* Or
*
* $formWidget->bindEvent('form.extendFieldsBefore', function () use ((\Backend\Widgets\Form $formWidget)) {
* // You should always check to see if you're extending correct model/controller
* if (!$formWidget->model instanceof \Foo\Example\Models\Bar) {
* // Check that we're extending the correct Form widget instance
* if (
* !($formWidget->getController() instanceof \Winter\User\Controllers\Users)
* || !($formWidget->model instanceof \Winter\User\Models\User)
* || $formWidget->isNested
* ) {
* return;
* }
*
Expand Down Expand Up @@ -573,13 +581,12 @@ protected function defineFormFields()
* Example usage:
*
* Event::listen('backend.form.extendFields', function ((\Backend\Widgets\Form) $formWidget) {
* // Only for the User controller
* if (!$formWidget->getController() instanceof \Winter\User\Controllers\Users) {
* return;
* }
*
* // Only for the User model
* if (!$formWidget->model instanceof \Winter\User\Models\User) {
* // Check that we're extending the correct Form widget instance
* if (
* !($formWidget->getController() instanceof \Winter\User\Controllers\Users)
* || !($formWidget->model instanceof \Winter\User\Models\User)
* || $formWidget->isNested
* ) {
* return;
* }
*
Expand All @@ -599,13 +606,12 @@ protected function defineFormFields()
* Or
*
* $formWidget->bindEvent('form.extendFields', function () use ((\Backend\Widgets\Form $formWidget)) {
* // Only for the User controller
* if (!$formWidget->getController() instanceof \Winter\User\Controllers\Users) {
* return;
* }
*
* // Only for the User model
* if (!$formWidget->model instanceof \Winter\User\Models\User) {
* // Check that we're extending the correct Form widget instance
* if (
* !($formWidget->getController() instanceof \Winter\User\Controllers\Users)
* || !($formWidget->model instanceof \Winter\User\Models\User)
* || $formWidget->isNested
* ) {
* return;
* }
*
Expand Down