Added code to insert user custom fields after user creation.
[timetracker.git] / plugins / CustomFields.class.php
index d9762b5..0ab33c7 100644 (file)
 class CustomFields {
 
   // Definitions of custom field types.
+  const ENTITY_TIME = 1;    // Field is associated with time entries.
+  const ENTITY_USER = 2;    // Field is associated with users.
+  const ENTITY_PROJECT = 3; // Field is associated with projects.
 
-  const TYPE_TEXT = 1;     // A text field.
-  const TYPE_DROPDOWN = 2; // A dropdown field with pre-defined values.
+  const TYPE_TEXT = 1;      // A text field.
+  const TYPE_DROPDOWN = 2;  // A dropdown field with pre-defined values.
 
+  // TODO: replace $fields with entity-specific arrays: timeFields, userFields, etc.
   var $fields = array();  // Array of custom fields for group.
-  var $options = array(); // Array of options for a dropdown custom field.
+
+  // Refactoring ongoing...
+  var $timeFields = null;
+  var $userFields = null;
+  var $projectFields = null;
 
   // Constructor.
   function __construct() {
@@ -45,25 +53,18 @@ class CustomFields {
     $org_id = $user->org_id;
 
     // Get fields.
-    $sql = "select id, type, label, required from tt_custom_fields".
+    $sql = "select id, entity_type, type, label, required from tt_custom_fields".
       " where group_id = $group_id and org_id = $org_id and status = 1 and type > 0";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
         $this->fields[] = array('id'=>$val['id'],'type'=>$val['type'],'label'=>$val['label'],'required'=>$val['required'],'value'=>'');
-      }
-    }
-
-    // If we have a dropdown obtain options for it.
-    if ((count($this->fields) > 0) && ($this->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)) {
-
-      $sql = "select id, value from tt_custom_field_options".
-        " where field_id = ".$this->fields[0]['id']." and group_id = $group_id and org_id = $org_id and status = 1 order by value";
-      $res = $mdb2->query($sql);
-      if (!is_a($res, 'PEAR_Error')) {
-        while ($val = $res->fetchRow()) {
-          $this->options[$val['id']] = $val['value'];
-        }
+        if (CustomFields::ENTITY_TIME == $val['entity_type'])
+          $this->timeFields[] = $val;
+        else if (CustomFields::ENTITY_USER == $val['entity_type'])
+          $this->userFields[] = $val;
+        else if (CustomFields::ENTITY_PROJECT == $val['entity_type'])
+          $this->projectFields[] = $val;
       }
     }
   }
@@ -246,12 +247,12 @@ class CustomFields {
     $org_id = $user->org_id;
 
     $fields = array();
-    $sql = "select id, type, label from tt_custom_fields".
+    $sql = "select id, entity_type, type, label from tt_custom_fields".
       " where group_id = $group_id and org_id = $org_id and status = 1 and type > 0";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
-        $fields[] = array('id'=>$val['id'],'type'=>$val['type'],'label'=>$val['label']);
+        $fields[] = $val;
       }
       return $fields;
     }
@@ -266,7 +267,7 @@ class CustomFields {
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    $sql = "select label, type, required from tt_custom_fields".
+    $sql = "select label, entity_type, type, required from tt_custom_fields".
       " where id = $id and group_id = $group_id and org_id = $org_id";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
@@ -298,15 +299,15 @@ class CustomFields {
   }
 
   // The insertField inserts a custom field for group.
-  static function insertField($field_name, $field_type, $required) {
+  static function insertField($field_name, $entity_type, $field_type, $required) {
     global $user;
     $mdb2 = getConnection();
 
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    $sql = "insert into tt_custom_fields (group_id, org_id, type, label, required, status)".
-      " values($group_id, $org_id, $field_type, ".$mdb2->quote($field_name).", $required, 1)";
+    $sql = "insert into tt_custom_fields (group_id, org_id, entity_type, type, label, required, status)".
+      " values($group_id, $org_id, $entity_type, $field_type, ".$mdb2->quote($field_name).", $required, 1)";
     $affected = $mdb2->exec($sql);
     return (!is_a($affected, 'PEAR_Error'));
   }
@@ -353,4 +354,55 @@ class CustomFields {
     $affected = $mdb2->exec($sql);
     return (!is_a($affected, 'PEAR_Error'));
   }
+
+  // insertEntityFields - inserts entity custom fields into tt_entity_custom_fields.
+  function insertEntityFields($entity_type, $entity_id, $entityFields) {
+    foreach ($entityFields as $entityField) {
+      if (!$this->insertEntityField($entity_type, $entity_id, $entityField))
+        return false;
+    }
+    return true;
+  }
+
+  // insertEntityField - inserts a single entity custom field into tt_entity_custom_fields.
+  function insertEntityField($entity_type, $entity_id, $entityField) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $created = 'now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$user->id;
+
+    $field_id = (int) $entityField['field_id'];
+
+    $option_id = $entityField['type'] == CustomFields::TYPE_DROPDOWN ? (int) $entityField['value'] : null;
+    $value = $entityField['type'] == CustomFields::TYPE_TEXT ? $entityField['value'] : null;
+
+    // TODO: add a jon to protect from bogus option_ids in post.
+    $sql = "insert into tt_entity_custom_fields".
+      " (group_id, org_id, entity_type, entity_id, field_id, option_id, value, created, created_ip, created_by)".
+      " values($group_id, $org_id, $entity_type, $entity_id, $field_id, ".$mdb2->quote($option_id).", ".$mdb2->quote($value).", $created)";
+    $affected = $mdb2->exec($sql);
+    return (!is_a($affected, 'PEAR_Error'));
+  }
+
+  // deleteEntityFields - deletes entity custom fields (permanently).
+  // Note: deleting, rather than marking fields deleted is on purpose
+  // because we want to keep the table small after multiple entity edits.
+  function deleteEntityFields($entity_type, $entity_id) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$user->id;
+
+    $sql = "delete from  tt_entity_custom_fields".
+      " where entity_type = $entity_type and entity_id = $entity_id".
+      " and group_id = $group_id and org_id = $org_id";
+    $affected = $mdb2->exec($sql);
+    return (!is_a($affected, 'PEAR_Error'));
+  }
 }