www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/inline_entity_form/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 Existing entities can also be referenced.
   5
   6 Supports commerce_product_reference, commerce_line_item_reference and entityreference fields.
   7 Requires integration code to be provided for each entity type that can be referenced.
   8 Supports the commerce_product (including Commerce AutoSKU integraton),
   9 commerce_line_item, node, taxonomy_term entity types out of the box.
  10
  11 Getting started
  12 ---------------
  13 Edit the reference field for which you want to use this module
  14 (for example, the Product field on a product display node, or the Line Items
  15 one on commerce_order) and select one of the "Inline entity form" widgets.
  16
  17 Widgets
  18 -------
  19 Two widgets are provided:
  20 - "Inline entity form - Single value" - Shows the inline form in a fieldset
  21 on the parent entity form. No additional action buttons are added.
  22 This widget assumes that it is operating on a single-value required reference
  23 field with one selected bundle.
  24
  25 - "Inline entity form - Multiple values" - Shows an advanced widget
  26 for inline management of entities.
  27 Has optimal UX when there's only one bundle selected (this is the
  28 "Product types that can be referenced" setting on product reference fields).
  29
  30 Integrating with Inline Entity Form
  31 -----------------------------------
  32 An entity type can add support for this module by declaring the
  33 inline entity form controller class in its entity info:
  34
  35 $entity_info['commerce_line_item']['inline_form'] = array(
  36   'controller' => 'CommerceLineItemInlineEntityFormController',
  37 );
  38
  39 The controller needs to extend EntityInlineEntityFormController and at least
  40 override entityForm() to provide a functioning entity form.