Changeset 16519

Timestamp:

06/01/08 17:17:10 (3 months ago)

Author:

adrenalin

Message:

Chooser widget can store order information now. Documented Chooser
widget JavaScript? files for other people to get Jerry's ideas open
faster.

Files:

• trunk/midcom/midcom.helper.datamanager2/documentation/CHANGES (modified) (1 diff)
• trunk/midcom/midcom.helper.datamanager2/static/chooser/jquery.chooser_widget.css (modified) (1 diff)
• trunk/midcom/midcom.helper.datamanager2/static/chooser/jquery.chooser_widget.js (modified) (7 diffs)
• trunk/midcom/midcom.helper.datamanager2/type/mnrelation.php (modified) (7 diffs)
• trunk/midcom/midcom.helper.datamanager2/type/select.php (modified) (2 diffs)
• trunk/midcom/midcom.helper.datamanager2/widget/chooser.php (modified) (4 diffs)

trunk/midcom/midcom.helper.datamanager2/documentation/CHANGES

@@ -8 +8 @@
-  which might even break existing functionality.
-- All items marked with "+" represent completely new features.
+
+2008-06-01 adrenalin
+  + Chooser widget can store order information now
+  - Documented Chooser widget JavaScript files
-
-2008-05-28 adrenalin

trunk/midcom/midcom.helper.datamanager2/static/chooser/jquery.chooser_widget.css

@@ -187 +187 @@
-ul.chooser_widget_results.ui-sortable .chooser_widget_results_item_dragger
-{
+    background : url('../../stock-icons/16x16/topic-score.png') center center no-repeat;
-    width: 20px;
-    height: 22px;
-    margin-left: -20px;
-    float: left;
-mov
+n-resiz
-}
-

trunk/midcom/midcom.helper.datamanager2/static/chooser/jquery.chooser_widget.js

@@ -671 +671 @@
-            {
-                var jq_elem = jQuery(target(event)).addClass(CLASSES.HOVER);
+                jQuery(target(event)).find('div.chooser_widget_results_item_dragger').fadeIn('slow');
-            })
-            .mouseout( function(event)
-            {
-                jQuery(target(event)).removeClass(CLASSES.HOVER);
+                jQuery(target(event)).find('div.chooser_widget_results_item_dragger').fadeOut('fast');
-            });
-        
@@ -709 +711 @@
-            .prependTo(li_elem);
-        
-
-
-
+
+
+
+
+
+
+
-        
-        li_elem.appendTo(list);
@@ -1020 +1026 @@
-        .attr({id: options.widget_id + '_result_item_dragger_' + item.id})
-        .addClass('chooser_widget_results_item_dragger')
+        .fadeOut(0)
-        .appendTo(item_parts);
-
@@ -1028 +1035 @@
-        .appendTo(item_parts);
-
- 
+
-    {
-        var value = null;
@@ -1041 +1048 @@
-        
-        item_content = jQuery('<div>')
-
-
-
-
-
-
-
-
-
-
-
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
-    });
-
@@ -1100 +1107 @@
-}
-
-
+
+
+
-jQuery.fn.create_sortable = function()
-{
-Create the sortable list, if there are more than one item in the list
+If there is less than two items in the list, sortable shouldn't be created
-    if (jQuery(this).find('li').size() <= 1)
-    {
@@ -1114 +1123 @@
-    }
-    
-
+
+
+
+
+
-    jQuery(this).sortable(
-    {

trunk/midcom/midcom.helper.datamanager2/type/mnrelation.php

@@ -81 +81 @@
- *   are available at the site of import. This flag is not set by default. Note, that
- *   this does not affect import, which is only available with keys, not values.
+ * - <i>boolean sortable:</i> Switch for determining if the order selected by the widget
+ *   should be stored to the metadata object
+ * - <i>string sortable_sort_order:</i> Direction that metadata.score should go. If this
+ *   is set to `ASC`, lower scores will be displayed first. If this is set to `DESC`, higher
+ *   scores will be displayed first. `DESC` is default, since then new member objects will
+ *   be left at the end of the line rather than appearing first. This field is not case
+ *   sensitive and string can be extended e.g. to `ascend`.
- *
- * (These list is complete, including all allowed options from the base type. Base type
@@ -162 +169 @@
-     */
-    var $_membership_objects = null;
+    
+    /**
+     * Should the sorting feature be enabled. This will affect the way chooser widget will act
+     * and how the results will be presented. If the sorting feature is enabled, 
+     *
+     * @access public
+     * @var boolean
+     */
+    var $sortable = false;
+    
+    /**
+     * Sort order. Which direction should metadata.score force the results. This should be either
+     * `ASC` or `DESC`
+     *
+     * @access public
+     * @var string
+     */
+    var $sortable_sort_order = 'DESC';
+    
+    /**
+     * Sorted order, which is returned by the widget.
+     * 
+     * @access public
+     * @var Array
+     */
+    var $sorted_order = array();
-
-    /**
@@ -240 +273 @@
-        $qb = $_MIDCOM->dbfactory->new_query_builder($this->mapping_class_name);
-        $qb->add_constraint($this->master_fieldname, '=', $this->_get_master_foreign_key());
+        
+        if (   $this->sortable
+            && preg_match('/^(ASC|DESC)/i', $this->sortable_sort_order, $regs))
+        {
+            $order = strtoupper($regs[1]);
+            $qb->add_order('metadata.score', $order);
+        }
+        
-        if ($this->member_limit_like)
-        {
@@ -313 +354 @@
-            $existing_members[$key] = $index;
-        }
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        $new_membership_objects = Array();
-        foreach ($this->selection as $key)
@@ -330 +389 @@
-            if (array_key_exists($key, $existing_members))
-            {
+                // Update the existing member
+                if ($this->sortable)
+                {
+                    $index = $existing_members[$key];
+                    
+                    if ($direction === 'asc')
+                    {
+                        $this->_membership_objects[$index]->metadata->score = $i;
+                    }
+                    else
+                    {
+                        $this->_membership_objects[$index]->metadata->score = $count - $i;
+                    }
+                    
+                    if (!$this->_membership_objects[$index]->update())
+                    {
+                        debug_add("Failed to update the member record for key {$key}. Couldn't store the order information", MIDCOM_LOG_ERROR);
+                        debug_add('Last Midgard error was ' . mgd_errstr(), MIDCOM_LOG_ERROR);
+                        debug_print_r('Tried to update this object', $this->_membership_objects[$index]);
+                    }
+                    
+                    $i++;
+                }
+                
-                $index = $existing_members[$key];
-                $new_membership_objects[] = $this->_membership_objects[$index];
@@ -340 +423 @@
-                $member->{$this->master_fieldname} = $this->_get_master_foreign_key();
-                $member->{$this->member_fieldname} = $key;
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                {
-                    debug_add("Failed to create a new member record for key {$key}, skipping it. " .
@@ -356 +455 @@
-        foreach ($this->_membership_objects as $member)
-        {
- 
+
-            {
-                debug_add("Failed to delete a no longer needed member record #{$member->id}, ignoring silently. " .

trunk/midcom/midcom.helper.datamanager2/type/select.php

@@ -40 +40 @@
- * - <i>string multiple_storagemode:</i> Controls how multiple options are stored in
- *   a single field. See below "multiselect storagemodes". Defaults to "serialized".
+ * - <i>boolean sortable:</i> Switch for determining if the order selected by the widget
+ *   should be stored to the metadata object
- *
- * Keys should be alphanumeric only.
@@ -206 +208 @@
-
-    /**
+     * Should the sorting feature be enabled. This will affect the way chooser widget will act
+     * and how the results will be presented. If the sorting feature is enabled, 
+     *
+     * @access public
+     * @var boolean
+     */
+    var $sortable = false;
+    
+    /**
-     * Initialize the class, if necessary, create a callback instance, otherwise
-     * validate that an option array is present.

trunk/midcom/midcom.helper.datamanager2/widget/chooser.php

@@ -308 +308 @@
-     * @var boolean    True if the sorting should be enabled
-     */
-false
+null
-
-    /**
@@ -325 +325 @@
-            debug_pop();
-            return false;
+        }
+        
+        // Determine the sortability from the type configuration
+        if (   is_null($this->sortable)
+            && isset($this->_type->sortable))
+        {
+            $this->sortable = $this->_type->sortable;
-        }
-
@@ -1536 +1543 @@
-            return;
-        }
+        
-        $real_results =& $results["{$this->_element_id}_selections"];
-        if (is_array($real_results))
@@ -1553 +1561 @@
-        {
-            $this->_type->selection[] = $real_results;
+        }
+        
+        if (   $this->sortable
+            && isset($results[$this->_element_id])
+            && isset($results[$this->_element_id]['sortable']))
+        {
+            $this->_type->sorted_order = array();
+            
+            foreach ($results[$this->_element_id]['sortable'] as $i => $id)
+            {
+                $this->_type->sorted_order[$id] = $i;
+            }
-        }
-