\Dewdrop\Fields\Helper\EditControlControl

Render the actual control needed to edit a specific field. You don't have to worry about rendering the label or error messages, just the actual control (e.g. the text input).

Helpers do this by enabling your to set custom callbacks for a field. In cases where a custom callback has not been assigned, helpers may attempt to automatically create a callback, using information in the field (e.g. the type of a database-related field).

For all helpers, you can assign custom callbacks globally or on a per-instance basis. Here's an example of defining a custom callback globally for a field:

$field->assignHelperCallback(
    'NameOfHelperToCustomize',
    function ($helper) {
        // Any custom logic you'd like to perform for this field.
    }
);

In the above example, "NameOfHelperToCustomize" is the name of the helper as defined in the helper's $name class property. This string is case insensitive.

To defined a custom callback on a per-instance basis for a helper, you can do the following:

$helper->assign(
    'my_model:field_id',
    function ($helper) {
        // Any custom logic you'd like to perform for this field.
    }
);

If you'd like to decorate an existing callback with additional logic, that's possible using the getFieldAssignment() method:

$field->assignHelperCallback(
    'NameOfHelperToCustomize',
    function ($helper) {
        return '' . call_user_func($helper->getFieldAssignment($field), $helper) . '';
    }
);

When a per-instance callback is assigned, that overrides any global or fallback callbacks. So, you can have an application-wide default (e.g. in a model) behavior for a field that is superseded in specific cases by adding a per-instance callback assignment for the field (e.g. in a view script).

Summary

Methods
Properties
Constants
matchesName()
assign()
getFieldAssignment()
hasValidName()
detectCallableForField()
__construct()
getView()
render()
No public properties found
No constants found
wrapCallable()
$name
N/A
No private methods found
$assignments
$view
$detector
N/A

Properties

$name

$name : string

The name for this helper, used when you want to define a global custom callback for a given field

Type

string

$assignments

$assignments : array

Any per-instance callback assignments for this helper. This array will have field IDs as the keys and callables as the values.

Type

array

$view

$view : \Dewdrop\View\View

The view in which this control will be rendered. Can be used to access view helpers, etc.

Type

\Dewdrop\View\View

$detector

$detector : \Dewdrop\Fields\EditHelperDetector

An EditHelperDetector object that can be used to provide reasonable defaults for database fields.

Type

\Dewdrop\Fields\EditHelperDetector

Methods

matchesName()

matchesName(string  $name) : boolean

Check to see if the supplied input matches this helper's name (case-insensitive).

Parameters

string $name

Returns

boolean

assign()

assign(mixed  $assignments, callable  $callable = null) : \Dewdrop\Fields\Helper\HelperAbstract

Assign one more custom per-instance callbacks for this helper. If the $arguments param is an array, this method expects that the keys will be field IDs and the values will be callables, assigning custom callbacks for multiple fields in one call. If, however, $assignments is a string or a FieldInterface object, a single custom callback assignment will be made.

Parameters

mixed $assignments
callable $callable

Returns

\Dewdrop\Fields\Helper\HelperAbstract

getFieldAssignment()

getFieldAssignment(\Dewdrop\Fields\FieldInterface  $field) : callable

Get the callback that will be used for the given FieldInterface object.

Parameters

\Dewdrop\Fields\FieldInterface $field

Throws

\Dewdrop\Fields\Exception\HelperCallableNotAvailableForField

Returns

callable

hasValidName()

hasValidName() : boolean

Ensure the helper has a valid $name value. If not, throw an exception.

All helpers must have a name defined so that global custom callbacks can be added to fields.

Throws

\Dewdrop\Fields\Exception\HelperMustHaveName

Returns

boolean

detectCallableForField()

detectCallableForField(\Dewdrop\Fields\FieldInterface  $field) : boolean|callable|mixed

Detect a reasonable default behavior for DB fields using an EditHelperDetector.

If no callback candidate is found, just return false from this method, which will be detected by getFieldAssignment(), causing execution to halt.

Parameters

\Dewdrop\Fields\FieldInterface $field

Returns

boolean|callable|mixed

getView()

getView() : \Dewdrop\View\View

Get the View this helper will render into.

Returns

\Dewdrop\View\View

render()

render(\Dewdrop\Fields\FieldInterface  $field,   $fieldPosition) : mixed

Render the control for the supplied field. The field's position in the form is provided (as a zero-indexed integer) so that you can alter the control's HTML depending upon where it falls in the list of fields. This can be useful, for example, if you want to automatically focus the first field on a form.

Parameters

\Dewdrop\Fields\FieldInterface $field
$fieldPosition

Returns

mixed

wrapCallable()

wrapCallable(callable  $callable, \Dewdrop\Fields\FieldInterface  $field = null) : callable

Wrap a field's callback to ensure that a reference to the helper is always supplied as the first argument to the callback.

Parameters

callable $callable
\Dewdrop\Fields\FieldInterface $field

Returns

callable