Skip to content

[Form] Form API cleanup #4375

Closed
Closed
@webmozart

Description

@webmozart

As one of the final steps before 2.1, I would like to clean up the Form API. Therefore, I would like to mark the following set of items as deprecated and remove them in 2.3. The replacements are listed below.

Rename "client format" to "view format" as known from MVC

<?php

// Before
$builder->appendClientTransformer()
$builder->prependClientTransformer()
$form->getClientData()
$form->getClientTransformers()

// After
$builder->addViewTransformer()
// no new equivalent for prepend
$form->getViewData()
$form->getConfig()->getViewTransformers()

Using the prepend method is a bad practice. It will be removed.

Rename "application format" to "model format" as known from MVC

<?php

// Before
$builder->appendNormTransformer()
$builder->prependNormTransformer()
$form->getNormTransformers()

// After
// no equivalent for append
$builder->addModelTransformer()
$form->getModelTransformers()

Using the append method is bad practice. It will be removed.

The accessor for the model format, (s|g)etData, and the "normalized format" and its accessor getNormData remain the same.

Merge PRE_BIND and BIND_CLIENT_DATA events

<?php

// Before
FormEvents::PRE_BIND
FormEvents::BIND_CLIENT_DATA

// After
FormEvents::PRE_BIND // (usable for both cases)

Rename BIND_NORM_DATA to BIND so we have PRE_BIND, BIND and POST_BIND

<?php

// Before
FormEvents::BIND_NORM_DATA

// After
FormEvents::BIND

Merge PRE_SET_DATA and SET_DATA events

<?php

// Before
FormEvents::PRE_SET_DATA
FormEvents::SET_DATA

// After
FormEvents::PRE_SET_DATA // (usable for both cases)

Doubts?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions