interface ChildFieldManager (View source)

Interface that allows non-CompositeField implementations to surface their child fields for handling requests and getting/setting data.

Methods

public
bool
isManagedField(string $fieldName)

Returns true if this field manages a child field with the given name.

public
FormField|null
getManagedFieldByName(string $fieldName)

Returns a named field which is managed by this parent field.

public
iterable
getManagedFields()

Returns a flat iterable of all fields managed by this parent field.

Details

bool isManagedField(string $fieldName)

Returns true if this field manages a child field with the given name.

If this form field manages fields which may handle actions, and this is not a subclass of CompositeField, this allows FormRequestHandler to find child fields to handle requests.

If this method returns true the field must be accessible via getManagedFieldByName() and be returned in getManagedFields().

Parameters

string $fieldName

Return Value

bool

FormField|null getManagedFieldByName(string $fieldName)

Returns a named field which is managed by this parent field.

Parameters

string $fieldName

Return Value

FormField|null

iterable getManagedFields()

Returns a flat iterable of all fields managed by this parent field.

Return Value

iterable