• var: An array of the widget ID's created by the dynamic control. Used during rendering to iterate through the widgets.
• access: protected

• var: TRUE if all managed widgets should be output at the first occurence of the {WFDynamic id="XXX"} tag. False if the next occurence of the managed widgets should be output at each occurence of the tag.
• access: protected

• var: Tracks whether or not the widgetConfig has been updated based on other settings yet. WFDynamic subclasses may want to look at this var to determine whether to do any initial setup.
• access: protected

• var: The current iteration, used during rendering.
• access: protected

• var: Use unique names (HTML input name) for each widget? Or use the same for every widget (for instance, when using radios or checkboxes you may want to set this to true)
• access: protected

• var: The configuration array for the dynamic widget.
• access: protected

Constructor.

• $id
• $page

WFWidget::__construct()

Constructor.

• WFSelectionCheckbox::__construct()

Get the parent WFView for the WFDynamic.

The WFDynamic is basically used to dynamically add children to the parent of whatever it's under. So for things like WFRadioGroup and WFCheckboxGroup it's important that the parent "Group" widget gets directly assigned all objects created by WFDynamic.

• return: The parent WFView, or NULL if the WFDynamic does not have a parent.

Create the dynamic widgets.

Allows for creation of n widgets based on an WFArrayController. Various options allow you to set up nearly any type of widget that is repeated for all objects in an array. Great for managing selection, editing data from joins, etc.

Once the objects are instantiated, configured, and bound as appropriate, restoreState() will be called. You can be sure that when this function exits that your widgets are in the same state as statically instantiated widgets from the page.

This will be called AFTER the _PageDidLoad method... which is what we need to wait for before creating our widgets. WFPage makes this call.

Module code may need to call this function again, particularly if the content of they arrayController is changed by the current action.

• return: An array of 'widgetID' => widget for all newly created widgets.
• todo: Anything else wrong with calling more than once? This should be idempotent as well as re-callable with different data.

• WFSelectionCheckbox::createWidgets() : Create the dynamic widgets.

Get an array of all of the widgets managed by this WFDynamic instance.

• return: An array of WFWidget subclasses that were created by this WFDynamic.

• $blockContent

WFView::render()

Render the view into HTML.

• WFSelectionCheckbox::render() : Just before rendering, we want to update the checked status of all managed checkboxes to reflect the selection status of the arrayController.

• $ac

Set the WFView object to be used as the prototype for all instances created.

• object WFView $view: The WFView object to be used as the prototype.

• $useUniqueNames

Set the config that will be used for the dynamic creation of widgets. See createWidgets for documentation on the config array.

• throws: If the passed parameter is not a PHP array.

• array $config:

  The widgetConfig to use for creation of widgets. Format:

  1.   array(
  2.       // enter as many widget property names as you like.
  3.       'widgetPropName' => array(
  4.                               'custom' => array(
  5.                                               'iterate' => true / false,
  6.                                               'keyPath' => 'modelKeyPath' KeyPath of the object to use for this iteration.
  7.                                                                           Only used if 'iterate' == true, and then it's optional.
  8.                                                                           If 'iterate' == true, then uses the nth value from the 'value' array.
  9.                                                                           If 'iterate' == '#identifier#', then uses the identifierHashForObject() for the current object.
  10.                                                                           NOTE: if the array controller is in indexed mode, will use the index of the object.
  11.                                                                           If 'iterate' == false, then uses the 'value' for EVERY iteration.
  12.                                               'value' => mixed            Either an array or a primitive, depending on the setting of 'iterate'.
  13.                                               )
  14.                               // use this binding config (similar format as widget .config file)
  15.                               'bind' => array(
  16.                                               'instanceID' => 'outletName' or
  17.                                                               '#module#' (to use the module) or
  18.                                                               '#custom# (to use object specified in 'custom' above) or
  19.                                                               '#current#' (to use the object of the current iteration)
  20.                                               'controllerKey' => 'controllerKey',
  21.                                               'modelKeyPath' => 'modelKeyPath',
  22.                                               'options' => array() // bindings options
  23.                                               )
  24.                           )
  25.       )

  This format lets you arbitrarily configure any property of any type of widget.

  For each property, you can choose to use the same 'value' for EVERY widget, or you can use a different value for each widget, the nth item in 'value' for the nth instance.