Add a README.
[project/inline_entity_form.git] / README
1 Provides a widget for inline management (creation, modification, removal) of referenced entities.
2 The primary use case is the parent -> children one (product display -> products, order -> line items, etc.),
3 where the child entities are never managed outside the parent form.
4
5 Supports commerce_product_reference, commerce_line_item_reference and entityreference fields.
6 Requires integration code to be provided for each entity type that can be referenced.
7 Supports the commerce_product (including Commerce AutoSKU integraton) and
8 commerce_line_item entity types out of the box.
9
10 Getting started
11 ---------------
12 Edit the reference field for which you want to use this module
13 (for example, the Product field on a product display node, or the Line Items
14 one on commerce_order) and select the "Inline entity form" widget.
15
16 For optimum UX, the field only have one allowed bundle selected, if possible
17 (this is the "Product types that can be referenced" setting on product reference
18 fields). The field should be required.
19
20 The widget is currently optimized for cardinality 1 (in which case the inline
21 entity form is shown without any action buttons) and cardinality unlimited
22 (in which case a table of entities is shown, along with an add form with its
23 own action buttons). The cardinality of a field is set in the "Number of values"
24 dropdown.
25
26 Integrating with Inline Entity Form
27 -----------------------------------
28 An entity type can add support for this module by declaring the
29 inline entity form controller class in its entity info:
30
31 $entity_info['commerce_line_item']['inline entity form'] = array(
32   'controller' => 'CommerceLineItemInlineEntityFormController',
33 );
34
35 The controller needs to extend EntityInlineEntityFormController and at least
36 override entityForm() to provide a function entity form.