// +----------------------------------------------------------------------+
// | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
// +----------------------------------------------------------------------+
+// | LIBERAL FREEWARE LICENSE: This source code document may be used
+// | by anyone for any purpose, and freely redistributed alone or in
+// | combination with other software, provided that the license is obeyed.
+// |
+// | There are only two ways to violate the license:
+// |
+// | 1. To redistribute this code in source form, with the copyright
+// | notice or license removed or altered. (Distributing in compiled
+// | forms without embedded copyright notices is permitted).
+// |
+// | 2. To redistribute modified versions of this code in *any* form
+// | that bears insufficient indications that the modifications are
+// | not the work of the original author(s).
+// |
+// | This license applies to this document only, not any other software
+// | that it may be combined with.
+// |
+// +----------------------------------------------------------------------+
+// | Contributors:
+// | https://www.anuko.com/time_tracker/credits.htm
+// +----------------------------------------------------------------------+
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.
+
+ // TODO: replace $fields with entity-specific arrays: timeFields, userFields, etc.
+ var $fields = array(); // Array of custom fields for group.
- const TYPE_TEXT = 1; // A text field.
- const TYPE_DROPDOWN = 2; // A dropdown field with pre-defined values.
+ // Refactoring ongoing...
+ var $timeFields = null;
+ var $userFields = null;
+ var $projectFields = null;
- var $fields = array(); // Array of custom fields for team.
- var $options = array(); // Array of options for a dropdown custom field.
-
// Constructor.
- function CustomFields($team_id) {
- $mdb2 = getConnection();
-
- // Get fields.
- $sql = "select id, type, label, required from tt_custom_fields where team_id = $team_id and status = 1 and type > 0";
+ function __construct() {
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ // Get 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']." 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;
}
}
}
-
+
function insert($log_id, $field_id, $option_id, $value) {
-
- $mdb2 = getConnection();
- $sql = "insert into tt_custom_field_log (log_id, field_id, option_id, value) values($log_id, $field_id, ".$mdb2->quote($option_id).", ".$mdb2->quote($value).")";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "insert into tt_custom_field_log (group_id, org_id, log_id, field_id, option_id, value)".
+ " values($group_id, $org_id, $log_id, $field_id, ".$mdb2->quote($option_id).", ".$mdb2->quote($value).")";
$affected = $mdb2->exec($sql);
return (!is_a($affected, 'PEAR_Error'));
}
function update($log_id, $field_id, $option_id, $value) {
- if (!$field_id)
- return true; // Nothing to update.
-
- // Remove older custom field values, if any.
- $res = $this->delete($log_id);
- if (!$res)
- return false;
-
- if (!$value && !$option_id)
- return true; // Do not insert NULL values.
-
+ if (!$field_id)
+ return true; // Nothing to update.
+
+ // Remove older custom field values, if any.
+ $res = $this->delete($log_id);
+ if (!$res)
+ return false;
+
+ if (!$value && !$option_id)
+ return true; // Do not insert NULL values.
+
return $this->insert($log_id, $field_id, $option_id, $value);
}
-
+
function delete($log_id) {
-
- $mdb2 = getConnection();
- $sql = "update tt_custom_field_log set status = NULL where log_id = $log_id";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "update tt_custom_field_log set status = null".
+ " where log_id = $log_id and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
return (!is_a($affected, 'PEAR_Error'));
}
-
+
function get($log_id) {
- $fields = array();
-
- $mdb2 = getConnection();
- $sql = "select id, field_id, option_id, value from tt_custom_field_log where log_id = $log_id and status = 1";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "select id, field_id, option_id, value from tt_custom_field_log".
+ " where log_id = $log_id and group_id = $group_id and org_id = $org_id and status = 1";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
+ $fields = array();
while ($val = $res->fetchRow()) {
- $fields[] = $val;
+ $fields[] = $val;
}
return $fields;
}
// insertOption adds a new option to a custom field.
static function insertOption($field_id, $option_name) {
-
- $mdb2 = getConnection();
-
- // Check if the option exists.
- $id = 0;
- $sql = "select id from tt_custom_field_options where field_id = $field_id and value = ".$mdb2->quote($option_name);
- $res = $mdb2->query($sql);
- if (is_a($res, 'PEAR_Error'))
- return false;
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ // Check if the option exists.
+ $id = 0;
+ $sql = "select id from tt_custom_field_options".
+ " where field_id = $field_id and group_id = $group_id and org_id = $org_id and value = ".$mdb2->quote($option_name);
+ $res = $mdb2->query($sql);
+ if (is_a($res, 'PEAR_Error'))
+ return false;
if ($val = $res->fetchRow()) $id = $val['id'];
-
+
// Insert option.
if (!$id) {
- $sql = "insert into tt_custom_field_options (field_id, value) values($field_id, ".$mdb2->quote($option_name).")";
+ $sql = "insert into tt_custom_field_options (group_id, org_id, field_id, value)".
+ " values($group_id, $org_id, $field_id, ".$mdb2->quote($option_name).")";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
- return false;
+ return false;
}
return true;
}
-
+
// updateOption updates option name.
static function updateOption($id, $option_name) {
-
+ global $user;
$mdb2 = getConnection();
-
- $sql = "update tt_custom_field_options set value = ".$mdb2->quote($option_name)." where id = $id";
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "update tt_custom_field_options set value = ".$mdb2->quote($option_name).
+ " where id = $id and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
return (!is_a($affected, 'PEAR_Error'));
}
-
+
// delete Option deletes an option and all custom field log entries that used it.
static function deleteOption($id) {
- global $user;
- $mdb2 = getConnection();
-
- $field_id = CustomFields::getFieldIdForOption($id);
-
- // First make sure that the field is ours.
- $sql = "select team_id from tt_custom_fields where id = $field_id";
- $res = $mdb2->query($sql);
- if (is_a($res, 'PEAR_Error'))
- return false;
- $val = $res->fetchRow();
- if ($user->team_id != $val['team_id'])
- return false;
-
- // Delete log entries with this option.
- $sql = "update tt_custom_field_log set status = NULL where field_id = $field_id and value = ".$mdb2->quote($id);
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $field_id = CustomFields::getFieldIdForOption($id);
+ if (!$field_id) return false;
+
+ // Delete log entries with this option. TODO: why? Research impact.
+ $sql = "update tt_custom_field_log set status = null".
+ " where field_id = $field_id and group_id = $group_id and org_id = $org_id and value = ".$mdb2->quote($id);
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
- return false;
-
- // Delete the option.
- $sql = "delete from tt_custom_field_options where id = $id";
- $affected = $mdb2->exec($sql);
+ return false;
+
+ // Delete the option.
+ $sql = "update tt_custom_field_options set status = null".
+ " where id = $id and group_id = $group_id and org_id = $org_id";
+ $affected = $mdb2->exec($sql);
return (!is_a($affected, 'PEAR_Error'));
}
-
+
// getOptions returns an array of options for a custom field.
static function getOptions($field_id) {
- global $user;
- $mdb2 = getConnection();
- $options = array();
-
- // First make sure that the field is ours.
- $sql = "select team_id from tt_custom_fields where id = $field_id";
- $res = $mdb2->query($sql);
- if (is_a($res, 'PEAR_Error'))
- return false;
- $val = $res->fetchRow();
- if ($user->team_id != $val['team_id'])
- return false;
-
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
// Get options.
- $sql = "select id, value from tt_custom_field_options where field_id = $field_id order by value";
+ $sql = "select id, value from tt_custom_field_options".
+ " where field_id = $field_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')) {
+ $options = array();
while ($val = $res->fetchRow()) {
$options[$val['id']] = $val['value'];
}
}
return false;
}
-
- // getOptiondName returns an option name for a custom field.
+
+ // getOptionName returns an option name for a custom field.
static function getOptionName($id) {
global $user;
- $mdb2 = getConnection();
-
- $field_id = CustomFields::getFieldIdForOption($id);
-
- // First make sure that the field is ours.
- $sql = "select team_id from tt_custom_fields where id = $field_id";
- $res = $mdb2->query($sql);
- if (is_a($res, 'PEAR_Error'))
- return false;
- $val = $res->fetchRow();
- if ($user->team_id != $val['team_id'])
- return false;
-
- // Get option name.
- $sql = "select value from tt_custom_field_options where id = $id";
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "select value from tt_custom_field_options".
+ " where id = $id and group_id = $group_id and org_id = $org_id and status = 1";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
$val = $res->fetchRow();
}
return false;
}
-
- // getFields returns an array of custom fields for team.
+
+ // getFields returns an array of custom fields for group.
static function getFields() {
- global $user;
- $mdb2 = getConnection();
-
- $fields = array();
- $sql = "select id, type, label from tt_custom_fields where team_id = $user->team_id and status = 1 and type > 0";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $fields = array();
+ $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;
}
// getField returns a custom field.
static function getField($id) {
- global $user;
- $mdb2 = getConnection();
-
- $sql = "select label, type, required from tt_custom_fields where id = $id and team_id = $user->team_id";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $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')) {
$val = $res->fetchRow();
}
return false;
}
-
+
// getFieldIdForOption returns field id from an associated option id.
static function getFieldIdForOption($option_id) {
- $mdb2 = getConnection();
-
- $sql = "select field_id from tt_custom_field_options where id = $option_id";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "select field_id from tt_custom_field_options".
+ " where id = $option_id and group_id = $group_id and org_id = $org_id";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
$val = $res->fetchRow();
}
return false;
}
-
- // The insertField inserts a custom field for team.
- static function insertField($field_name, $field_type, $required) {
-
- global $user;
-
- $mdb2 = getConnection();
-
- $sql = "insert into tt_custom_fields (team_id, type, label, required, status) values($user->team_id, $field_type, ".$mdb2->quote($field_name).", $required, 1)";
+
+ // The insertField inserts a custom field for group.
+ 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, 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'));
}
- // The updateField updates custom field for team.
+ // The updateField updates custom field for group.
static function updateField($id, $name, $type, $required) {
-
- global $user;
-
- $mdb2 = getConnection();
-
- $sql = "update tt_custom_fields set label = ".$mdb2->quote($name).", type = $type, required = $required where id = $id and team_id = $user->team_id";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ $sql = "update tt_custom_fields set label = ".$mdb2->quote($name).", type = $type, required = $required".
+ " where id = $id and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
return (!is_a($affected, 'PEAR_Error'));
}
-
- // The deleteField deletes a custom field, its options and log entries for team.
+
+ // The deleteField deletes a custom field, its options and log entries for group.
static function deleteField($field_id) {
-
- // Our overall intention is to keep the code simple and manageable.
- // If a users wishes to delete a field, we will delete all its options and log entries.
- // Otherwise we have to do conditional queries depending on field status (this complicates things).
-
- global $user;
- $mdb2 = getConnection();
-
- // First make sure that the field is ours so that we can safely delete it.
- $sql = "select team_id from tt_custom_fields where id = $field_id";
- $res = $mdb2->query($sql);
- if (is_a($res, 'PEAR_Error'))
- return false;
- $val = $res->fetchRow();
- if ($user->team_id != $val['team_id'])
- return false;
-
- // Mark log entries as deleted.
- $sql = "update tt_custom_field_log set status = NULL where field_id = $field_id";
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = $user->getGroup();
+ $org_id = $user->org_id;
+
+ // Mark log entries as deleted. TODO: why are we doing this? Research impact.
+ $sql = "update tt_custom_field_log set status = null".
+ " where field_id = $field_id and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
- return false;
+ return false;
- // Delete field options.
- $sql = "delete from tt_custom_field_options where field_id = $field_id";
+ // Mark field options as deleted.
+ $sql = "update tt_custom_field_options set status = null".
+ " where field_id = $field_id and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
- return false;
+ return false;
+
+ // Mark custom field as deleted.
+ $sql = "update tt_custom_fields set status = null".
+ " where id = $field_id and group_id = $group_id and org_id = $org_id";
+ $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;
- // Delete the field.
- $sql = "delete from tt_custom_fields where id = $field_id and team_id = $user->team_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'));
}
projects / timetracker.git / blobdiff