/**
* The $formDefinition argument should be an array containing the following keys:
*
* 'submit-url' which is the URL for form submission.
* 'module-name' which is the name of the module providing the purchase item.
* 'type' which is the type of the purchase item.
* 'id' which is the identifier of the purchase item, unique within items of the given module and type.
* 'labels' which is an array containing keys 'quantity-field', 'no-value-option', and 'value-format', which may
* contain tokens %label% and %value%.
*
* @param array $formDefinition
*
* @return \Sitegear\Form\FormInterface
*
* @throws \InvalidArgumentException
*/
public function buildForm($formDefinition)
{
$form = new Form($formDefinition['submit-url'], null, null, null, $this->getFormsModule()->registry()->getValues($this->getFormKey()), $this->getFormsModule()->registry()->getErrors($this->getFormKey()));
$module = $this->getFormsModule()->getEngine()->getModule($formDefinition['module-name']);
if (!$module instanceof PurchaseItemProviderModuleInterface) {
throw new \InvalidArgumentException(sprintf('The specified module "%s" is not a valid purchase item provider.', $formDefinition['module-name']));
}
// Add the hidden fields.
// TODO Make 'module-name', 'type' and 'id' a single hidden field with encoded value
$moduleField = new InputField($form, 'module', $formDefinition['module-name']);
$moduleField->setSetting('type', 'hidden');
$form->addField($moduleField);
$typeField = new InputField($form, 'type', $formDefinition['type']);
$typeField->setSetting('type', 'hidden');
$form->addField($typeField);
$idField = new InputField($form, 'id', $formDefinition['id']);
$idField->setSetting('type', 'hidden');
$form->addField($idField);
// Create the array of field names for references used by the single step of the form.
$fields = array('module' => false, 'type' => false, 'id' => false);
// Add a field to the form for every purchase item attribute.
foreach ($module->getPurchaseItemAttributeDefinitions($formDefinition['type'], $formDefinition['id']) as $attribute) {
$name = sprintf('attr_%s', $attribute['id']);
$constraints = array(new ConditionalConstraint(new NotBlank()));
// TODO Other field types - MultiInputField with radios and checkboxes
$attributeField = new SelectField($form, $name, null, $attribute['label'], null, $constraints);
$attributeField->setSetting('values', $this->buildAddTrolleyItemFormAttributeFieldValues($attribute, $formDefinition['labels']['no-value-option'], $formDefinition['labels']['value-format']));
$form->addField($attributeField);
$fields[$name] = true;
}
// Add the quantity field, which is a standard text field with a label.
$quantityField = new InputField($form, 'quantity', 1, $formDefinition['labels']['quantity-field']);
$quantityField->addConditionalConstraint(new ConditionalConstraint(new NotBlank()));
$quantityField->addConditionalConstraint(new ConditionalConstraint(new Range(array('min' => 1))));
$form->addField($quantityField);
$fields['quantity'] = true;
// Complete the form structure.
$step = new Step($form, 0);
$fieldset = new Fieldset($step);
foreach ($fields as $field => $wrapped) {
$fieldset->addFieldReference(new FieldReference($field, false, $wrapped));
}
$form->addStep($step->addFieldset($fieldset));
return $form;
}
/**
* Create a single fieldset, which exists within a given step.
*
* @param \Sitegear\Form\StepInterface $step
* @param array $fieldsetDefinition
*
* @return \Sitegear\Form\Fieldset
*/
public function buildFieldset(StepInterface $step, array $fieldsetDefinition)
{
LoggerRegistry::debug('FormBuilder::buildFieldset()');
$heading = isset($fieldsetDefinition['heading']) ? $fieldsetDefinition['heading'] : null;
$fieldset = new Fieldset($step, $heading);
foreach ($fieldsetDefinition['fields'] as $fieldDefinition) {
if (!is_array($fieldDefinition)) {
$fieldDefinition = array('field' => $fieldDefinition);
}
$fieldset->addFieldReference(new FieldReference($fieldDefinition['field'], isset($fieldDefinition['read-only']) && $fieldDefinition['read-only'], !isset($fieldDefinition['wrapped']) || $fieldDefinition['wrapped']));
}
return $fieldset;
}