Overview
The FormsDataBinder class manages a tree of bound targets (typically models) that form components can access to retrieve default values. It maintains a stack of bindings that components can push to and pop from.
Namespace: Javaabu\Forms
Class Definition
Properties
Private Properties
Tree of bound targets maintained as a stack.
Methods
bind
public function bind($target): void
The target to bind (typically an Eloquent model, array, or object).
void
Example:
$binder = app(FormsDataBinder::class);
$binder->bind($user);
get
Retrieves the latest (most recently) bound target from the stack.
Returns: mixed - The last bound target, or null if stack is empty
Example:
$binder = app(FormsDataBinder::class);
$currentModel = $binder->get();
pop
public function pop(): void
void
Example:
$binder = app(FormsDataBinder::class);
$binder->pop();
Usage with Blade Directives
The FormsDataBinder is typically used through Blade directives rather than directly:
@model Directive
Binds a model to the form:
@model($user)
<x-forms::text name="first_name" />
<x-forms::text name="last_name" />
<x-forms::email name="email" />
@endmodel
@model directive compiles to:
<?php app(\Javaabu\Forms\FormsDataBinder::class)->bind($user); ?>
@endmodel Directive
Removes the bound model:
The @endmodel directive compiles to:
<?php app(\Javaabu\Forms\FormsDataBinder::class)->pop(); ?>
Usage Example
@model($user)
<x-forms::form method="PUT" :action="route('users.update', $user)">
<x-forms::text name="name" />
<x-forms::email name="email" />
<x-forms::submit>Update User</x-forms::submit>
</x-forms::form>
@endmodel
Nested Model Binding
@model($user)
<x-forms::text name="name" />
@model($user->profile)
<x-forms::text name="bio" />
<x-forms::text name="website" />
@endmodel
<x-forms::submit>Save</x-forms::submit>
@endmodel
Programmatic Usage
use Javaabu\Forms\FormsDataBinder;
$binder = app(FormsDataBinder::class);
// Bind a model
$binder->bind($user);
// Get the current bound model
$model = $binder->get();
// Bind nested model
$binder->bind($user->profile);
// Get nested model
$profile = $binder->get(); // Returns $user->profile
// Pop nested model
$binder->pop();
// Get returns parent model again
$model = $binder->get(); // Returns $user
// Pop parent model
$binder->pop();
How It Works
The FormsDataBinder maintains a stack-based system:
- Binding: When you use
@model($user), the user model is pushed onto the stack
- Accessing: Form components call
get() to retrieve the current model
- Unbinding: When you use
@endmodel, the model is popped from the stack
This allows for nested model binding where inner components access the most recently bound model.
Service Registration
The FormsDataBinder is registered as a singleton in the service container by the FormsServiceProvider:
$this->app->singleton(FormsDataBinder::class, fn () => new FormsDataBinder());