This is the API docs for LemonStand V1, which has been discontinued. LemonStand is now a cloud based platform, available at lemonstand.com.

LemonStand API

shop:onGetCategoryFieldOptions event

Triggered by Shop_Category
Author LemonStand eCommerce Inc.

Event handler signature

public mixed event_onGetCategoryFieldOptions(string $db_name, string $field_value)
$db_name string specifies the field name.
$field_value string specifies the field value.
{return} mixed returns a list of options or a specific option label.
Allows to populate drop-down, radio- or checkbox list fields, which have been added with shop:onExtendCategoryForm event. 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.
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 (label), corresponding the value.
public function subscribeEvents()
{
  Backend::$events->addEvent('shop:onExtendCategoryModel', $this, 'extend_category_model');
  Backend::$events->addEvent('shop:onExtendCategoryForm', $this, 'extend_category_form');
  Backend::$events->addEvent('shop:onGetCategoryFieldOptions', $this, 'get_category_field_options');
}

public function extend_category_model($category, $context)
{
  $category->define_column('x_color', 'Color');
}

public function extend_category_form($category, $context)
{
  $category->add_form_field('x_color')->tab('Product')->renderAs(frm_dropdown);
}

public function get_category_field_options($field_name, $current_key_value)
{
  if ($field_name == 'x_color')
  {
    $options = array(
      0 => 'Red',
      1 => 'Green',
      2 => 'Blue'
    );

    if ($current_key_value == -1)
      return $options;

    if (array_key_exists($current_key_value, $options))
      return $options[$current_key_value];
  }
}