WEB-INF/lib/ttConfigHelper.class.php

   1 <?php
   2 // +----------------------------------------------------------------------+
   3 // | Anuko Time Tracker
   4 // +----------------------------------------------------------------------+
   5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
   6 // +----------------------------------------------------------------------+
   7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
   8 // | by anyone for any purpose, and freely redistributed alone or in
   9 // | combination with other software, provided that the license is obeyed.
  10 // |
  11 // | There are only two ways to violate the license:
  12 // |
  13 // | 1. To redistribute this code in source form, with the copyright
  14 // |    notice or license removed or altered. (Distributing in compiled
  15 // |    forms without embedded copyright notices is permitted).
  16 // |
  17 // | 2. To redistribute modified versions of this code in *any* form
  18 // |    that bears insufficient indications that the modifications are
  19 // |    not the work of the original author(s).
  20 // |
  21 // | This license applies to this document only, not any other software
  22 // | that it may be combined with.
  23 // |
  24 // +----------------------------------------------------------------------+
  25 // | Contributors:
  26 // | https://www.anuko.com/time_tracker/credits.htm
  27 // +----------------------------------------------------------------------+
  28
  29 // Class ttConfigHelper is a helper class to handle comma-separated lists of config data.
  30 // For example, in tt_groups table we have a field called "config", that may store something like:
  31 //
  32 // allow_overlap,uncompleted_indicators,minutes_in_unit:15,future_entries
  33 //   Above, some values are simply defined by their presence such as allow_overlap.
  34 //   Other values have associated values after colon such as minutes_in_work_unit (15).
  35 class ttConfigHelper {
  36   var $config = null; // Source config string.
  37   var $config_array = null;  // Array of config values.
  38
  39   // Constructor.
  40   function __construct($config) {
  41     $this->config = $config;
  42     $this->config_array = explode(',', $this->config);
  43   }
  44
  45   // getDefinedValue determines if a value identified by name is defined.
  46   function getDefinedValue($name) {
  47     return in_array($name, $this->config_array);
  48   }
  49
  50   // setDefinedValue either sets or deletes a defined value identified by name.
  51   function setDefinedValue($name, $set = true) {
  52     if ($set) {
  53       // Setting part.
  54       if (!$this->getDefinedValue($name)) {
  55         $this->config_array[] = $name;
  56         $this->config = implode(',', $this->config_array);
  57         return;
  58       }
  59     } else {
  60       // Deleting part.
  61       foreach ($this->config_array as $key => $value) {
  62         if ($value === $name) {
  63           unset($this->config_array[$key]);
  64           $this->config = implode(',', $this->config_array);
  65           return;
  66         }
  67       }
  68     }
  69   }
  70
  71   // The getIntValue parses an integer value from the source config string.
  72   function getIntValue($name) {
  73     $name_with_colon = $name.':';
  74     $len = strlen($name_with_colon);
  75
  76     foreach ($this->config_array as $unparsed_value) {
  77       if (substr($unparsed_value, 0, $len) === $name_with_colon) {
  78         // Found value.
  79         $unparsed_len = strlen($unparsed_value);
  80         $int_value = (int) substr($unparsed_value, -($unparsed_len - $len));
  81         return $int_value;
  82       }
  83
  84     }
  85     return false;
  86   }
  87
  88   // The setIntValue sets an integer value into config array.
  89   function setIntValue($name, $value) {
  90     // Try to find and replace an already existing value.
  91     $name_with_colon = $name.':';
  92     $len = strlen($name_with_colon);
  93
  94     foreach ($this->config_array as $key => $unparsed_value) {
  95       if (substr($unparsed_value, 0, $len) === $name_with_colon) {
  96         // Found an already existing value.
  97         if ($value !== null) {
  98           // Replace value.
  99           $this->config_array[$key] = $name.':'.$value;
 100         } else {
 101           // Remove value if our new value is NULL.
 102           unset($this->config_array[$key]);
 103         }
 104         $this->config = implode(',', $this->config_array);
 105         return;
 106       }
 107     }
 108     // If we get here, the value was not found, so add it.
 109     $this->config_array[] = $name.':'.$value;
 110     $this->config = implode(',', $this->config_array);
 111     return;
 112   }
 113
 114   // The getConfig returns the config string.
 115   function getConfig() {
 116     return $this->config;
 117   }
 118 }