Weight ignored for fields in Extra information pane

It took a while before I had time to take a closer look at this issue. I can confirm the weight of fields in the Extra information pane is completely ignored in both checkout and in the admin section. Previously the fields were ordered by weight when loaded from the database (in 6.x-2.0-alpha1), but with the redesign this piece of code get lost.
I've committed a fix for this issue. The fix cares that order by weight is back again in the database query. It also reorders the fields with uasort() in case the fields are not loaded all at once (this probably can only happen in modules that extend Extra Fields Pane).

Thanks for reporting the bug! The fix will appear in the dev version from December 29, 2011 or later.

I can not reproduce your problem. Can you try it again with the latest dev? The development release has been updated.

The custom order fields are now ordered by weight when shown, which did not happen in 6.x-2.0-beta1 (this is the bug I've fixed in dev). They won't be ordered in their "natural order" again. You will have adjust the weight of each field to get them displayed in the order you want (reorder them by dragging the rows on the custom order fields pane and then hit the "Save" button). Do you still encounter problems when you adjust the weights?

From beta1 to latest dev
Replace the old uc_extra_fields_pane folder (beta1) with the new one (6.x-2.x-dev). In this case there were no changes in the schema, so you don't need to run update.php.

I've installed your SQL, but I can't still reproduce your problem. With me, the fields are order by weight on the custom order fields page, the checkout page and the order administration page. I've attached some images so you know the way how I see your fields. One screenshot is from phpMyAdmin; I've ordered the rows by weight there also. What do you mean with "But the display is still off"?

Can you explain your problem in more detail? I may have gotten it wrong.

I'm puzzled here. I've no idea how Extra Fields Pane causes this behavior. It could be a conflict with an other module you've installed (other modules are free to alter forms), although this issue seems to be very rare.

To be sure you have the latest version of Extra Fields Pane installed, check the available updates page: admin/reports/updates. It should list Extra Fields Checkout Pane 6.x-2.x-dev from 2011-Dec-30 (it can also be 2011-Dec-29, the 2011-Dec-30 date may be a local date here). I once had an issue with a module that kept being the old version although I replaced the module folder with the latest version. I discovered I had accidentally the module folder two times installed and Drupal picks the first one it finds. Drupal first checks the module folder for the specific site, for example "sites/default/modules" or "sites/www.example.com/modules", then it checks "sites/all/modules" and if it still didn't found the module, it checks the modules folder at the root of the Drupal site, which should only contain the modules from Drupal core.

You can empty the caches, but I doubt it is a caching problem. Extra Fields Pane doesn't cache the fields' order. It only does some caching that is valid for one request only: it makes sure fields are not unnecessary loaded from the database twice during one request. Read http://drupal.org/node/42055 to learn ways to clear caches. You can also empty (truncate) all tables in the database that start with "cache" (or "drupal_cache" in your installation) to clear all caches.

The sorting happens in the file UCXF_FieldList.class.php. For the custom order fields admin page the method UCXF_FieldList::getAllCustomFields() is called. This method calls UCXF_FieldList::loadAll() which loads all fields from the uc_extra_fields_pane table (because most of the times all extra fields are needed). After that, it builds up an array that only contain custom order fields. Finally, before the fields are returned, it sorts the array by the field's weight property, using the PHP function uasort(). This function needs a callback function to do the comparison. The callback function that is used is UCXF_FieldList::sort() which contains similar code as the Drupal core function element_sort(). The difference is that element_sort() only works with arrays that have a property called "#weight" and UCXF_FieldList::sort() only works with UCXF_Field instances that have a property called "weight".

I hope you can help with debug this, as I can't reproduce the problem yet. I've tested the module with PHP 5.2.9 and PHP 5.3.2.

Below you can find the code in UCXF_FieldList.class.php which deals with sorting the fields.

UCXF_FieldList::getAllCustomFields()

/**
 * Get all available custom order fields
 * @access public
 * @static
 * @return array
 */
public static function getAllCustomFields() {
  self::loadAll();
  $fields = array();
  foreach (self::$fields as $field) {
    if (!$field->in_pane('extra_delivery') && !$field->in_pane('extra_billing')) {
      $fields[$field->db_name] = $field;
    }
  }
  uasort($fields, 'UCXF_FieldList::sort');
  return $fields;
}

UCXF_FieldList::sort

/**
 * Sort fields by weight
 *
 * This function is used as callback function by uasort().
 *
 * This function is similar to element_sort().
 *
 * @param UCXF_Field $a
 *   Instance of UCXF_Field
 * @param UCXF_Field $b
 *   Instance of UCXF_Field
 *
 * @access public
 * @static
 * @return int
 */
public static function sort(UCXF_Field $a, UCXF_Field $b) {
  $a_weight = (isset($a->weight)) ? $a->weight : 0;
  $b_weight = (isset($b->weight)) ? $b->weight : 0;
  if ($a_weight == $b_weight) {
    return 0;
  }
  return ($a_weight < $b_weight) ? -1 : 1;
}

Thanks for tracking down the cause of the error! :)

You are right it looks like the uasort() is not necessary, but it is there to be sure the fields are in the right order when retrieved. A custom module is able to use the Extra Field Pane API to load a single field. If Extra Fields Pane retrieves the custom order fields later in the same request, the single field will be on the top of the list. The uasort() prevents that fields are displayed in the wrong order. I know it's a very uncommon situation.

I've tested your proposal change (posted in #13) and it has not any side effects on my installation. I will check in this change soon (I don't have time to do it today). Thank you again!

The fix proposed in #13 has been committed.