KTS-3161

"Allow the user to change the ordering of the browse columns" Fixed. Added the logic to change the order. Committed by: Megan Watson Reviewed by: Jonathan Byrne git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8334 c91229c3-7414-0410-bfa2-8a42b809f60b

KTS-3161
"Allow the user to change the ordering of the browse columns" Fixed. Added the logic to change the order. Committed by: Megan Watson Reviewed by: Jonathan Byrne git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8334 c91229c3-7414-0410-bfa2-8a42b809f60b
megan_w
1 parent 21d7958e
Showing 3 changed files with 290 additions and 89 deletions
lib/browse/columnentry.inc.php
plugins/ktcore/admin/manageViews.php
templates/ktcore/misc/columns/edit_view.smarty
@@ -6,46 +6,46 @@
  * KnowledgeTree Open Source Edition
  * Document Management Made Simple
  * Copyright (C) 2004 - 2008 The Jam Warehouse Software (Pty) Limited
- * 
+ *
  * This program is free software; you can redistribute it and/or modify it under
  * the terms of the GNU General Public License version 3 as published by the
  * Free Software Foundation.
- * 
+ *
  * This program is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  * details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- * 
+ *
  * You can contact The Jam Warehouse Software (Pty) Limited, Unit 1, Tramber Place,
  * Blake Street, Observatory, 7925 South Africa. or email info@knowledgetree.com.
- * 
+ *
  * The interactive user interfaces in modified source and object code versions
  * of this program must display Appropriate Legal Notices, as required under
  * Section 5 of the GNU General Public License version 3.
- * 
+ *
  * In accordance with Section 7(b) of the GNU General Public License version 3,
  * these Appropriate Legal Notices must retain the display of the "Powered by
- * KnowledgeTree" logo and retain the original copyright notice. If the display of the 
+ * KnowledgeTree" logo and retain the original copyright notice. If the display of the
  * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
- * must display the words "Powered by KnowledgeTree" and retain the original 
- * copyright notice. 
+ * must display the words "Powered by KnowledgeTree" and retain the original
+ * copyright notice.
  * Contributor( s): ______________________________________
  *
  */
- 
+
 class KTColumnEntry extends KTEntity {
-	
+
 	/** role object primary key */
 	var $sViewNamespace;
 	var $sColumnNamespace;
-    var $iPosition; 
+    var $iPosition;
     var $sConfigArray;
     var $bRequired;
-	
+
 	var $_aFieldToSelect = array(
 	    'iId' => 'id',
 		'sColumnNamespace' => 'column_namespace',
@@ -54,24 +54,24 @@ class KTColumnEntry extends KTEntity {
 		'sConfigArray' => 'config_array',
 		'bRequired' => 'required'
 	);
-	
+
     var $_bUsePearError = true;
-	function getColumnNamespace() { return $this->sColumnNamespace; }	
+	function getColumnNamespace() { return $this->sColumnNamespace; }
 	function setColumnNamespace($sNewValue) { $this->sColumnNamespace = $sNewValue; }
-	function getViewNamespace() { return $this->sViewNamespace; }	
+	function getViewNamespace() { return $this->sViewNamespace; }
 	function setViewNamespace($sNewValue) { $this->sViewNamespace = $sNewValue; }
-	function getPosition() { return $this->iPosition; }	
+	function getPosition() { return $this->iPosition; }
 	function setPosition($iNewValue) { $this->iPosition = $iNewValue; }
-	function getConfigArray() { return unserialize($this->sConfigArray); }	
+	function getConfigArray() { return unserialize($this->sConfigArray); }
 	function setConfigArray($aNewValue) { $this->sConfigArray = serialize($aNewValue); }
-	function getRequired() { return $this->bRequired; }	
+	function getRequired() { return $this->bRequired; }
 	function setRequired($bNewValue) { $this->bRequired = $bNewValue; }
-	
+
     function _fieldValues () { return array(
 		'column_namespace' => $this->sColumnNamespace,
-		'view_namespace' => $this->sViewNamespace,		
+		'view_namespace' => $this->sViewNamespace,
 		'config_array' => $this->sConfigArray,
 		'position' => $this->iPosition,
 		'required' => $this->bRequired,
@@ -81,22 +81,172 @@ class KTColumnEntry extends KTEntity {
     function _table () { return KTUtil::getTableName('column_entries'); }
     function get($iEntryId) { return KTEntityUtil::get('KTColumnEntry', $iEntryId); }
 	function & getList($sWhereClause = null) { return KTEntityUtil::getList2('KTColumnEntry', $sWhereClause); }
-	function & createFromArray($aOptions) { 
-        // transparently convert the options.	
-	
+	function & createFromArray($aOptions) {
+        // transparently convert the options.
+
 	    $aOptions['configarray'] = serialize(KTUtil::arrayGet($aOptions, 'config', array()));
 	    unset($aOptions['config']);
-	
-	    return KTEntityUtil::createFromArray('KTColumnEntry', $aOptions); 
-	} 
-	
+
+	    return KTEntityUtil::createFromArray('KTColumnEntry', $aOptions);
+	}
+
 	function & getByView($sViewNamespace, $aOptions = null) {
 	    if (is_null($aOptions)) { $aOptions = array(); }
         $aOptions['multi'] = true;
+        $aOptions['orderby'] = 'position';
         $aSelect = array('view_namespace' => $sViewNamespace);
-	    
+
     	return KTEntityUtil::getByDict('KTColumnEntry', $aSelect, $aOptions);
 	}
+	/**
+	 * Get the postion of the last entry
+	 */
+	function getNextEntryPosition($sViewNamespace){
+	    $sql = "SELECT position FROM column_entries
+	       WHERE view_namespace = ?
+	       ORDER BY position DESC LIMIT 1";
+	    $aParams = array($sViewNamespace);
+
+	    $result = DBUtil::getResultArray(array($sql, $aParams));
+
+	    if(PEAR::isError($result) || empty($result)){
+	        return 1000;
+	    }
+	    return $result[0]['position'] + 1;
+	}
+
+    /**
+     * Reset the order of the columns
+     *
+     */
+    function reorderColumns($sViewNamespace) {
+        // Get the columns in the order they'll appear - first by position then by id
+        $sql = "SELECT id, position FROM column_entries
+	       WHERE view_namespace = ?
+	       ORDER BY position, id ASC";
+	    $aParams = array($sViewNamespace);
+
+	    $result = DBUtil::getResultArray(array($sql, $aParams));
+
+	    if(PEAR::isError($result) || empty($result)){
+	        return false;
+	    }
+
+	    // Set all positions to be unique and in order
+	    foreach($result as $key => $column){
+	        $position = $column['position'];
+
+	        // If the column position is correct in the order, continue
+	        if($position == $key){
+	            continue;
+	        }
+
+	        // Reset the position
+	        $aFields = array();
+	        $aFields['position'] = $key;
+
+	        $res = DBUtil::autoUpdate('column_entries', $aFields, $column['id']);
+	    }
+	    return true;
+    }
+
+	/**
+	 * Get the next postion up / down
+	 */
+	function getNextPosition($sViewNamespace, $iId, $position, $dir = 'up') {
+	    switch($dir){
+	        case 'down':
+	            $comp = '>';
+	            $order = 'ASC';
+	            break;
+	        default:
+	            $comp = '<';
+	            $order = 'DESC';
+	    }
+
+	    // Get the column above / below to swop position
+	    $sql = "SELECT id, position FROM column_entries
+	       WHERE view_namespace = ? AND (position {$comp} ? OR (position = ? AND id {$comp} ?))
+	       ORDER BY position {$order} LIMIT 1";
+	    $aParams = array($sViewNamespace, $position, $position, $iId);
+
+	    $result = DBUtil::getOneResult(array($sql, $aParams));
+
+	    if(PEAR::isError($result) || empty($result)){
+	        return false;
+	    }
+	    return $result;
+	}
+
+	/**
+	 * Get the updated position of the column
+	 *
+	 * @param int $iId
+	 * @return int
+	 */
+	function getNewPosition($iId){
+	    // Get the new position
+	    $sql = "SELECT id, position FROM column_entries
+    	       WHERE id = ?";
+	    $aParams = array($iId);
+	    $result = DBUtil::getOneResult(array($sql, $aParams));
+
+	    if(PEAR::isError($result) || empty($result)){
+	        return false;
+	    }
+	    return $result['position'];
+	}
+
+	/**
+	 * Update the position of a column
+	 */
+	function updatePosition($iId, $position) {
+	    $aFields = array('position' => $position);
+	    DBUtil::autoUpdate('column_entries', $aFields, $iId);
+	}
+
+	/**
+	 * Move the display position of the column up / down
+	 */
+	function movePosition($sViewNamespace, $iId, $dir = 'up') {
+	    $position = $this->getPosition();
+
+	    // Get the column to swop position with
+	    $next = $this->getNextPosition($sViewNamespace, $iId, $position, $dir);
+	    if($next === false){
+	        return false;
+	    }
+
+	    // Get position of the next column up / down
+	    $newPos = $next['position'];
+	    $iNextId = $next['id'];
+
+	    if($newPos == $position){
+	        // 2 columns have the same position - reorder them
+	        $res = $this->reorderColumns($sViewNamespace);
+	        if($res === false){
+	            return false;
+	        }
+
+    	    $position = $this->getNewPosition($iId);
+    	    if($position === false){
+	            return false;
+	        }
+
+    	    // Get the column to swop with
+    	    $next = $this->getNextPosition($sViewNamespace, $iId, $position, $dir);
+    	    if($next === false){
+    	        return false;
+    	    }
+    	    $newPos = $next['position'];
+    	    $iNextId = $next['id'];
+	    }
+
+	    // update the columns
+	    $this->updatePosition($iId, $newPos);
+	    $this->updatePosition($iNextId, $position);
+	    return true;
+	}
 }
 ?>
 \ No newline at end of file
 <?php
 /**
  * $Id$
- *    
+ *
  * KnowledgeTree Open Source Edition
  * Document Management Made Simple
  * Copyright (C) 2004 - 2008 The Jam Warehouse Software (Pty) Limited
- * 
+ *
  * This program is free software; you can redistribute it and/or modify it under
  * the terms of the GNU General Public License version 3 as published by the
  * Free Software Foundation.
- * 
+ *
  * This program is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  * details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- * 
+ *
  * You can contact The Jam Warehouse Software (Pty) Limited, Unit 1, Tramber Place,
  * Blake Street, Observatory, 7925 South Africa. or email info@knowledgetree.com.
- * 
+ *
  * The interactive user interfaces in modified source and object code versions
  * of this program must display Appropriate Legal Notices, as required under
  * Section 5 of the GNU General Public License version 3.
- * 
+ *
  * In accordance with Section 7(b) of the GNU General Public License version 3,
  * these Appropriate Legal Notices must retain the display of the "Powered by
- * KnowledgeTree" logo and retain the original copyright notice. If the display of the 
+ * KnowledgeTree" logo and retain the original copyright notice. If the display of the
  * logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
- * must display the words "Powered by KnowledgeTree" and retain the original 
- * copyright notice. 
+ * must display the words "Powered by KnowledgeTree" and retain the original
+ * copyright notice.
  * Contributor( s): ______________________________________
  */
@@ -38,42 +38,42 @@ require_once(KT_LIB_DIR . &#39;/templating/templating.inc.php&#39;);
 require_once(KT_LIB_DIR . '/widgets/reorderdisplay.inc.php');
 require_once(KT_LIB_DIR . '/dispatcher.inc.php');
 require_once(KT_LIB_DIR . '/browse/columnregistry.inc.php');
- 
+
 class ManageViewDispatcher extends KTAdminDispatcher {
     function check() {
-    
+
         $this->aBreadcrumbs[] = array('url' => $_SERVER['PHP_SELF'], 'name' => _kt('Manage Views'));
         return parent::check();
     }
     function do_main() {
         $oTemplating =& KTTemplating::getSingleton();
-        $oTemplate = $oTemplating->loadTemplate('ktcore/misc/columns/select_view');          
-        
-        $oColumnRegistry =& KTColumnRegistry::getSingleton();        
-        
+        $oTemplate = $oTemplating->loadTemplate('ktcore/misc/columns/select_view');
+
+        $oColumnRegistry =& KTColumnRegistry::getSingleton();
+
         $aViews = $oColumnRegistry->getViews();
-        $aTemplateData = array( 
-              'context' => $this, 
+        $aTemplateData = array(
+              'context' => $this,
               'views' => $aViews,
         );
         return $oTemplate->render($aTemplateData);
     }
-    function do_editView() {    
+    function do_editView() {
         $oTemplating =& KTTemplating::getSingleton();
-        $oTemplate = $oTemplating->loadTemplate('ktcore/misc/columns/edit_view');          
-        
-        $oColumnRegistry =& KTColumnRegistry::getSingleton();        
+        $oTemplate = $oTemplating->loadTemplate('ktcore/misc/columns/edit_view');
+
+        $oColumnRegistry =& KTColumnRegistry::getSingleton();
         $aColumns = $oColumnRegistry->getColumnsForView($_REQUEST['viewNS']);
         //var_dump($aColumns); exit(0);
         $aAllColumns = $oColumnRegistry->getColumns();
-        $view_name = $oColumnRegistry->getViewName($_REQUEST['viewNS']);
+        $view_name = $oColumnRegistry->getViewName(($_REQUEST['viewNS']));
         $this->oPage->setTitle($view_name);
-        $this->oPage->setBreadcrumbDetails($view_name);        
+        $this->oPage->setBreadcrumbDetails($view_name);
         $aOptions = array();
         $vocab = array();
@@ -83,59 +83,98 @@ class ManageViewDispatcher extends KTAdminDispatcher {
         $aOptions['vocab'] = $vocab;
         $add_field = new KTLookupWidget(_kt("Columns"), _kt("Select a column to add to the view.  Please note that while you can add multiple copies of a column, they will all behave as a single column"), 'column_ns', null, $this->oPage, true, null, $aErrors = null, $aOptions);
-        $aTemplateData = array( 
+        $aTemplateData = array(
               'context' => $this,
               'current_columns' => $aColumns,
               'all_columns' => $aAllColumns,
               'view' => $_REQUEST['viewNS'],
               'add_field' => $add_field,
         );
-        return $oTemplate->render($aTemplateData);     
-    } 
-    
-    function do_deleteEntry() { 
-        $entry_id = KTUtil::arrayGet($_REQUEST, 'entry_id'); 
-        $view = KTUtil::arrayGet($_REQUEST, 'viewNS');         
-        
-        // none of these conditions can be reached "normally".        
-        
+        return $oTemplate->render($aTemplateData);
+    }
+
+    function do_deleteEntry() {
+        $entry_id = KTUtil::arrayGet($_REQUEST, 'entry_id');
+        $view = KTUtil::arrayGet($_REQUEST, 'viewNS');
+
+        // none of these conditions can be reached "normally".
+
         $oEntry = KTColumnEntry::get($entry_id);
         if (PEAR::isError($oEntry)) {
             $this->errorRedirectToMain(_kt("Unable to locate the entry"));
         }
-        
+
         if ($oEntry->getRequired()) {
             $this->errorRedirectToMain(_kt("That column is required"));
         }
-        
+
         if ($oEntry->getViewNamespace() != $view) {
             $this->errorRedirectToMain(_kt("That column is not for the specified view"));
         }
-        
+
         $res = $oEntry->delete();
-        
+
         if (PEAR::isError($res)) {
             $this->errorRedirectToMain(sprintf(_kt("Failed to remove that column: %s"), $res->getMessage()));
-        }        
-        
+        }
+
         $this->successRedirectTo("editView", _kt("Deleted Entry"), sprintf("viewNS=%s", $view));
-    }     
-    
+    }
+
     function do_addEntry() {
-        $column_ns = KTUtil::arrayGet($_REQUEST, 'column_ns'); 
-        $view = KTUtil::arrayGet($_REQUEST, 'viewNS');      
+        $column_ns = KTUtil::arrayGet($_REQUEST, 'column_ns');
+        $view = KTUtil::arrayGet($_REQUEST, 'viewNS');
-        $this->startTransaction();        
-        
+        $this->startTransaction();
+
+        $position = KTColumnEntry::getNextEntryPosition($view);
         $oEntry = KTColumnEntry::createFromArray(array(
     		'ColumnNamespace' => $column_ns,
     		'ViewNamespace' => $view,
-    		'Position' => 1000,             // start it at the bottom
+    		'Position' => $position,             // start it at the bottom
     		'config' => array(),            // stub, for now.
     		'Required' => 0
-        ));       
+        ));
+
+        $this->successRedirectTo("editView", _kt("Added Entry"), sprintf("viewNS=%s", $view));
+    }
+
+    function do_orderUp(){
+        $entryId = $_REQUEST['entry_id'];
+        $view = $_REQUEST['viewNS'];
+
+        $oEntry = KTColumnEntry::get($entryId);
+        if (PEAR::isError($oEntry)) {
+            $this->errorRedirectTo('editView', _kt('Unable to locate the column entry'), "viewNS={$view}");
+            exit();
+        }
+
+        $res = $oEntry->movePosition($view, $entryId, 'up');
+        if (PEAR::isError($res)) {
+            $this->errorRedirectTo('editView', $res->getMessage(), "viewNS={$view}");
+            exit();
+        }
+
+        $this->redirectTo('editView', "viewNS={$view}");
+    }
+
+    function do_orderDown(){
+        $entryId = $_REQUEST['entry_id'];
+        $view = $_REQUEST['viewNS'];
+
+        $oEntry = KTColumnEntry::get($entryId);
+        if (PEAR::isError($oEntry)) {
+            $this->errorRedirectTo('editView', _kt('Unable to locate the column entry'), "viewNS={$view}");
+            exit();
+        }
+
+        $res = $oEntry->movePosition($view, $entryId, 'down');
+        if (PEAR::isError($res)) {
+            $this->errorRedirectTo('editView', $res->getMessage(), "viewNS={$view}");
+            exit();
+        }
-        $this->successRedirectTo("editView", _kt("Added Entry"), sprintf("viewNS=%s", $view));  
+        $this->redirectTo("editView", "viewNS={$view}");
     }
 }
 <h2>{i18n}Edit View{/i18n}</h2>
-<p class="descriptiveText">{i18n}The columns included in this view are displayed below.  To add additional columns into the 
+<p class="descriptiveText">{i18n}The columns included in this view are displayed below.  To add additional columns into the
 view, use the form below the list.  To remove items, click on the "delete" icon next to the column name.  Note that some columns may be required
-in a given view. Also, while you can 
+in a given view. Also, while you can
 have multiple copies of a given column in a specific view this is not recommended.{/i18n}</p>
 {if (!empty($current_columns))}
 <table class="kt_collection narrow" cellspacing="0">
     <thead>
         <tr>
-            <th>{i18n}Column{/i18n}</th>        
-            <th>{i18n}Delete{/i18n}</th>                     
+            <th>{i18n}Column{/i18n}</th>
+            <th>{i18n}Delete{/i18n}</th>
+            <th colspan="2">{i18n}Position{/i18n}</th>
         </tr>
     </thead>
     <tbody>
-    {foreach from=$current_columns item=oColumn}
+    {foreach name=cols from=$current_columns item=oColumn}
         <tr>
             <td>{$oColumn->getName()}</td>
             {if $oColumn->getRequiredInView()}
             <td>&mdash;</td>
-            {else}            
-            <td><a href="{addQS}action=deleteEntry&entry_id={$oColumn->getEntryId()}&viewNS={$view}{/addQS}" class="ktAction ktDelete">{i18n}Delete{/i18n}</a></td>            
+            {else}
+            <td><a href="{addQS}action=deleteEntry&entry_id={$oColumn->getEntryId()}&viewNS={$view}{/addQS}" class="ktAction ktDelete">{i18n}Delete{/i18n}</a></td>
             {/if}
-        </tr>    
+
+            <td>
+                {if !$smarty.foreach.cols.first}
+                    <a href="{addQS}action=orderUp&entry_id={$oColumn->getEntryId()}&viewNS={$view}{/addQS}" class="ktAction ktMoveUp">{i18n}Reorder up{/i18n}</a>
+                {/if}
+            </td>
+            <td>
+                {if !$smarty.foreach.cols.last}
+                    <a href="{addQS}action=orderDown&entry_id={$oColumn->getEntryId()}&viewNS={$view}{/addQS}" class="ktAction ktMoveDown">{i18n}Reorder down{/i18n}</a>
+                {/if}
+            </td>
+        </tr>
     {/foreach}
     </tbody>
 </table>
@@ -38,9 +50,9 @@ have multiple copies of a given column in a specific view this is not recommende
     {$add_field->render()}
     <div class="form_actions">
-        <input type="submit" value="{i18n}Add Column to View{/i18n}"/>    
+        <input type="submit" value="{i18n}Add Column to View{/i18n}"/>
         <input type="hidden" name="action" value="addEntry" />
-        <input type="hidden" name="viewNS" value="{$view}" />        
-    </div>    
+        <input type="hidden" name="viewNS" value="{$view}" />
+    </div>
 </fieldset>
 </form>
 \ No newline at end of file