WEB-INF/lib/ttWeekViewHelper.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 // ttWeekViewHelper class groups together functions used in week view.
  30 class ttWeekViewHelper {
  31
  32   // makeRowLabel - builds a human readable label for a row in week view,
  33   // which is a combination ot record properties.
  34   // Client - Project - Task - Custom field 1.
  35   // Note that billable property is not part of the label. Instead,
  36   // we identify such records with a different color in week view.
  37   static function makeRowLabel($record) {
  38     global $user;
  39     // Start with client.
  40     if ($user->isPluginEnabled('cl'))
  41       $label = $record['client'];
  42
  43     // Add project.
  44     if (!empty($label) && !empty($record['project'])) $label .= ' - ';
  45     $label .= $record['project'];
  46
  47     // Add task.
  48     if (!empty($label) && !empty($record['task'])) $label .= ' - ';
  49     $label .= $record['task'];
  50
  51     // Add custom field 1.
  52     if ($user->isPluginEnabled('cf')) {
  53       if (!empty($label) && !empty($record['cf_1_value'])) $label .= ' - ';
  54       $label .= $record['cf_1_value'];
  55     }
  56
  57     return $label;
  58   }
  59
  60   // parseFromWeekViewRow - obtains field value encoded in row identifier.
  61   // For example, for a row id like "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
  62   // requesting a client "cl" should return 546.
  63   static function parseFromWeekViewRow($row_id, $field_label) {
  64     // Find beginning of label.
  65     $pos = strpos($row_id, $field_label);
  66     if ($pos === false) return null; // Not found.
  67
  68     // Strip suffix from row id.
  69     $suffixPos = strrpos($row_id, '_');
  70     if ($suffixPos)
  71       $remaninder = substr($row_id, 0, $suffixPos);
  72
  73     // Find beginning of value.
  74     $posBegin = 1 + strpos($remaninder, ':', $pos);
  75     // Find end of value.
  76     $posEnd = strpos($remaninder, ',', $posBegin);
  77     if ($posEnd === false) $posEnd = strlen($remaninder);
  78     // Return value.
  79     return substr($remaninder, $posBegin, $posEnd - $posBegin);
  80   }
  81 }