shop:onGetOrderFieldOptions event
The shop:onGetOrderFieldOptions event allows to populate drop-down, radio- or checkbox list fields, which you added with the shop:onExtendOrderForm event, with custom options. Usually you do not need to use this event for fields which represent data relations. But if you want a standard field (corresponding an integer-typed database column, for example), to be rendered as a drop-down list, you should handle this event in your module.
The event handler should accept 2 parameters - the field name and a current field value. If the current field value is -1, the handler should return an array containing a list of options. If the current field value is not -1, the handler should return a string, corresponding the value.
Event handler example:
public function subscribeEvents()
{
Backend::$events->addEvent('shop:onExtendOrderModel', $this, 'extend_order_model');
Backend::$events->addEvent('shop:onExtendOrderForm', $this, 'extend_order_form');
Backend::$events->addEvent('shop:onGetOrderFieldOptions', $this, 'get_order_options');
}
public function extend_order_model($order, $context)
{
$order->define_column('x_gender', 'Gender');
}
public function extend_order_form($order, $context)
{
$order->add_form_field('x_gender')->tab('Billing Information');
}
public function get_order_options($field_name, $current_value)
{
if ($field_name == 'x_gender')
{
$options = array('male'=>'Male', 'female'=>'Female', 'unisex'=>'Unisex');
if ($current_value == -1)
return $options;
if (array_key_exists($current_value, $options))
return $options[$current_value];
}
}Next: shop:onGetProductFieldOptions event
Previous: shop:onExtendProductForm event
Return to Handling LemonStand events
