KTC-189

"Deleting a fieldset does not remove all instances of itself and existing field and document type associations" Fixed. On deleting the fieldset it checks for any document type associations and removes them. KTS-2487 "Deleting an assigned fieldset causes a fatal error" Fixed. Removing the document type associations fixes the error on viewing the document. Committed by: Megan Watson Reviewed by: Jonathan Byrne git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@7599 c91229c3-7414-0410-bfa2-8a42b809f60b

KTC-189
"Deleting a fieldset does not remove all instances of itself and existing field and document type associations" Fixed. On deleting the fieldset it checks for any document type associations and removes them. KTS-2487 "Deleting an assigned fieldset causes a fatal error" Fixed. Removing the document type associations fixes the error on viewing the document. Committed by: Megan Watson Reviewed by: Jonathan Byrne git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@7599 c91229c3-7414-0410-bfa2-8a42b809f60b
megan_w
1 parent d6027be1
Showing 1 changed file with 89 additions and 79 deletions
plugins/ktcore/admin/documentFieldsv2.php
@@ -6,32 +6,32 @@
  * KnowledgeTree Open Source Edition
  * Document Management Made Simple
  * Copyright (C) 2004 - 2007 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): ______________________________________
  *
  */
@@ -49,7 +49,7 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
     function predispatch() {
         $this->aBreadcrumbs[] = array('url' => $_SERVER['PHP_SELF'], 'name' => _kt('Document Field Management'));
         $this->persistParams(array('fFieldsetId'));
-        
+
         $this->oFieldset = KTFieldset::get(KTUtil::arrayGet($_REQUEST, 'fFieldsetId'));
         if (PEAR::isError($this->oFieldset)) {
             $this->oFieldset = null;
@@ -63,7 +63,7 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
     function do_main () {
         $oTemplate =& $this->oValidator->validateTemplate('ktcore/metadata/admin/list');
-        
+
         $oTemplate->setData(array(
 		    'context' => $this,
             'fieldsets' => KTFieldset::getList('disabled != true'),
@@ -80,10 +80,10 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
             'cancel_action' => 'main',
             'fail_action' => 'newfieldset',
             'action' => 'create',
-            'context' => $this,            
+            'context' => $this,
         ));
-        
-        
+
+
         // construct the widget set.
         // we use a slight variation here, because "type" is only present in certain circumstances.
         $widgets = array(
@@ -98,16 +98,16 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
                 'name' => 'description',
                 'required' => true,
                 'description' => _kt("In order to ensure that the data that users enter is useful, it is essential that you provide a good example."),
-            )),            
+            )),
         );
         if ($this->bHaveConditional) {
-        
+
             // FIXME get this from some external source.
             $type_vocab = array(
                 'normal' => _kt("Normal"),
-                'conditional' => _kt("Conditional"),                
+                'conditional' => _kt("Conditional"),
             );
-        
+
             $widgets[] = array('ktcore.widgets.selection', array(
                 'label' => _kt("Fieldset Type"),
                 'use_simple' => false,
@@ -119,20 +119,20 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
                 'vocab' => $type_vocab,
             ));
         }
-        
+
         $widgets[] = array('ktcore.widgets.boolean',array(
                 'label' => _kt("Generic"),
                 'name' => 'generic',
                 'description' => _kt("A generic fieldset is one that is available for every document by default. These fieldsets will be available for users to edit and add for every document in the document management system."),
             ));
-            
+
         $oForm->setWidgets($widgets);
-        
+
         // similarly, we construct validators here.
         $validators = array(
             array('ktcore.validators.string', array(
                 'test' => 'name',
-                'output' => 'name', 
+                'output' => 'name',
             )),
             array('ktcore.validators.string', array(
                 'test' => 'description',
@@ -143,65 +143,65 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
                 'output' => 'generic',
             )),
         );
-        
+
         if ($this->bHaveConditional) {
             $validators[] = array('ktcore.validators.string', array(
                 'test' => 'fieldset_type',
                 'output' => 'fieldset_type',
             ));
         }
-        
+
         $oForm->setValidators($validators);
-        
+
         return $oForm;
     }
     function do_newfieldset() {
         $this->oPage->setBreadcrumbDetails(_kt("Create New Fieldset"));
         $oForm = $this->form_create();
-        
+
         return $oForm->render();
     }
-    
+
     function do_create() {
         $oForm = $this->form_create();
         $res = $oForm->validate();
-        
+
         $data = $res['results'];
         $errors = $res['errors'];
         $extra_errors = array();
-        
+
         if (!empty($data['name'])) {
             $oFieldset = KTFieldset::getByName($data['name']);
             if (!PEAR::isError($oFieldset)) {
                 // means we're looking at an existing name
                 $extra_errors['name'] = _kt("There is already a fieldset with that name.");
-            }   
+            }
         }
-        
+
         $is_conditional = false;
         // FIXME this is inelegant.  get it from somewhere else.
         if ($this->bHaveConditional && ($data['fieldset_type'] == 'conditional')) {
             $is_conditional = true;
         }
-        
-        
+
+
         if (!empty($errors) || !empty($extra_errors)) {
             return $oForm->handleError(null, $extra_errors);
         }
-        
+
         // we also need a namespace.
         $temp_name = $data['name'];
         $namespace = KTUtil::nameToLocalNamespace('fieldsets', $temp_name);
         $oOldFieldset = KTFieldset::getByNamespace($namespace);
-        
+
         while (!PEAR::isError($oOldFieldset)) {
             $temp_name .= '_';
             $namespace = KTUtil::nameToLocalNamespace('fieldsets', $temp_name);
-            $oOldFieldset = KTFieldset::getByNamespace($namespace);    
+            $oOldFieldset = KTFieldset::getByNamespace($namespace);
         }
-        
-        // we now know its a non-conflicting one.        
+
+        // we now know its a non-conflicting one.
         // FIXME handle conditional fieldsets, which should be ... a different object.
         $oFieldset = KTFieldset::createFromArray(array(
             "name" => $data['name'],
@@ -212,29 +212,29 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
             "isGeneric" => $data['generic'],
             "isComplete" => false,
             "isComplex" => false,
-            "isSystem" => false,        
+            "isSystem" => false,
         ));
         if (PEAR::isError($oFieldset)) {
             return $oForm->handleError(sprintf(_kt("Failed to create fieldset: %s"), $oFieldset->getMessage()));
         }
-        
+
         $this->successRedirectTo('edit',_kt("Fieldset created."), sprintf('fFieldsetId=%d', $oFieldset->getId()));
-    }    
+    }
 	function getTypesForFieldset($oFieldset) {
 	    if ($oFieldset->getIsGeneric()) {
 		    return _kt('All types use this generic fieldset.');
 		}
-		
+
 	    $types = $oFieldset->getAssociatedTypes();
 		if (PEAR::isError($types)) {
 		    return _kt('Error retrieving list of types.');
 		}
-		if (empty($types)) { 
+		if (empty($types)) {
 		    return _kt('None');
 		}
 		$aNames = array();
-		foreach ($types as $oType) { 
+		foreach ($types as $oType) {
 		    if (!PEAR::isError($oType)) {
     		    $aNames[] = $oType->getName();
     		}
@@ -247,30 +247,30 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
         // here we engage in some major evil.
         // we check for the subevent var
         // and subdispatch if appropriate.
-        // 
+        //
         // saves a little code-duplication (actually, a lot of code-duplication)
-        
+
         // FIXME this is essentially a stub for the fieldset-delegation code.
         if ($this->oFieldset->getIsConditional()) {
             require_once('fieldsets/conditional.inc.php');
-            $oSubDispatcher = new ConditionalFieldsetManagementDispatcher;        
+            $oSubDispatcher = new ConditionalFieldsetManagementDispatcher;
         } else {
             require_once('fieldsets/basic.inc.php');
             $oSubDispatcher = new BasicFieldsetManagementDispatcher;
         }
-        
+
         $subevent_var = 'fieldset_action';
         $subevent = KTUtil::arrayGet($_REQUEST, $subevent_var);
         if (!empty($subevent)) {
             // do nothing, since this will handle everything
             $this_url = KTUtil::addQueryStringSelf($this->meldPersistQuery("","edit"));
-            $oSubDispatcher->redispatch($subevent_var, null, $this, $this_url);  
+            $oSubDispatcher->redispatch($subevent_var, null, $this, $this_url);
             exit(0);
         } else {
             // what we want is the "additional info" section
             $additional = $oSubDispatcher->describe_fieldset($this->oFieldset);
         }
-    
+
         $oTemplate =& $this->oValidator->validateTemplate('ktcore/metadata/admin/edit');
         $oTemplate->setData(array(
             'context' => $this,
@@ -279,9 +279,19 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
         ));
         return $oTemplate->render();
     }
-    
+
     function do_delete() {
         $this->startTransaction();
+
+        // check if fieldset is associated with a document type - remove association
+        $types = $this->oFieldset->getAssociatedTypes();
+        $sFieldSetId = $this->oFieldset->getId();
+        if(!PEAR::isError($types) AND !empty($types)){
+            foreach($types as $oType){
+                $res = KTMetadataUtil::removeSetsFromDocumentType($oType, $sFieldSetId);
+            }
+        }
+
         $res = $this->oFieldset->delete('true');
         $this->oValidator->notErrorFalse($res, array(
             'redirect_to' => array('main', ''),
@@ -289,7 +299,7 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
         ));
         $this->successRedirectToMain(_kt('Fieldset deleted'));
     }
-    
+
     function form_edit() {
         $oForm = new KTForm;
         $oForm->setOptions(array(
@@ -299,10 +309,10 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
             'cancel_action' => 'edit',
             'fail_action' => 'editfieldset',
             'action' => 'savefieldset',
-            'context' => $this,            
+            'context' => $this,
         ));
-        
-        
+
+
         // construct the widget set.
         // we use a slight variation here, because "type" is only present in certain circumstances.
         $widgets = array(
@@ -318,24 +328,24 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
                 'name' => 'description',
                 'required' => true,
                 'description' => _kt("In order to ensure that the data that users enter is useful, it is essential that you provide a good example."),
-                'value' => sanitizeForHTML($this->oFieldset->getDescription()),                
-            )),            
+                'value' => sanitizeForHTML($this->oFieldset->getDescription()),
+            )),
         );
-       
+
         $widgets[] = array('ktcore.widgets.boolean',array(
                 'label' => _kt("Generic"),
                 'name' => 'generic',
                 'description' => _kt("A generic fieldset is one that is available for every document by default. These fieldsets will be available for users to edit and add for every document in the document management system."),
-                'value' => $this->oFieldset->getIsGeneric(),                                
+                'value' => $this->oFieldset->getIsGeneric(),
             ));
-            
+
         $oForm->setWidgets($widgets);
-        
+
         // similarly, we construct validators here.
         $validators = array(
             array('ktcore.validators.string', array(
                 'test' => 'name',
-                'output' => 'name', 
+                'output' => 'name',
             )),
             array('ktcore.validators.string', array(
                 'test' => 'description',
@@ -346,22 +356,22 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
                 'output' => 'generic',
             )),
         );
-        
+
         $oForm->setValidators($validators);
-        
+
         return $oForm;
     }
-    
-    function do_editfieldset() {    
+
+    function do_editfieldset() {
         $oForm = $this->form_edit();
         $this->oPage->setBreadcrumbDetails(_kt('edit fieldset'));
         return $oForm->renderPage(_kt("Edit Fieldset"));
     }
-    
-    function do_savefieldset() {    
+
+    function do_savefieldset() {
         $oForm = $this->form_edit();
         $res = $oForm->validate();
-        
+
         $data = $res['results'];
         $errors = $res['errors'];
         $extra_errors = array();
@@ -371,18 +381,18 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
                 $extra_errors['name'][] = _kt("A fieldset with that name already exists.");
             }
         }
-        
+
         if (!empty($errors) || !empty($extra_errors)) {
             return $oForm->handleError(null, $extra_errors);
         }
-        
+
         $this->startTransaction();
-        
+
         $this->oFieldset->setName($data['name']);
-        $this->oFieldset->setDescription($data['description']);     
+        $this->oFieldset->setDescription($data['description']);
         $bGeneric = $data['generic'];
         if ($bGeneric != $this->oFieldset->getIsGeneric() && $bGeneric == true) {
-            // delink it from all doctypes.            
+            // delink it from all doctypes.
             $aTypes = $this->oFieldset->getAssociatedTypes();
             foreach ($aTypes as $oType) {
                 $res = KTMetadataUtil::removeSetsFromDocumentType($oType, $this->oFieldset->getId());
@@ -392,17 +402,17 @@ class KTDocumentFieldDispatcher extends KTAdminDispatcher {
                 }
             }
         }
-           
-        $this->oFieldset->setIsGeneric($data['generic']);                
-        
+
+        $this->oFieldset->setIsGeneric($data['generic']);
+
         $res = $this->oFieldset->update();
         if (PEAR::isError($res)) {
             $this->errorRedirectTo('edit', _kt('Could not save fieldset changes'));
             exit(0);
         }
-        
+
         return $this->successRedirectTo('edit', _kt("Fieldset details updated."));
-    }    
+    }
 }
 ?>