includes/ui/simple_crud_class.inc

   1 <?php
   2 /**********************************************************************
   3     Copyright (C) FrontAccounting, LLC.
   4         Released under the terms of the GNU General Public License, GPL,
   5         as published by the Free Software Foundation, either version 3
   6         of the License, or (at your option) any later version.
   7     This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
  11 ***********************************************************************/
  12 //
  13 //      Template for simple table editors
  14 //
  15 class simple_crud {
  16         var $name;
  17         var $Mode;
  18         var $selected_id;
  19         var $_none = ''; // selector value when no item is selected
  20         var $pre_handlers; // control buttons and related methods called before view display
  21         var $views;
  22         var $data;
  23         var $fields;
  24         var $tool_buttons;
  25         var $options;
  26         var $dec;
  27         //
  28         //
  29         function simple_crud($name, $fields = null)
  30         {
  31                 $this->name = $name;
  32                 $this->pre_handlers = array(
  33                         'Edit' => '_edit',
  34                         'Delete' => '_delete',
  35                         'NEW' => '_edit',
  36                         'ADD' => '_add',
  37                         'UPDATE' => '_update',
  38                         'RESET' => '_cancel',
  39                         'CLONE' => '_cloning'
  40                         );
  41                 $this->views = array(
  42                         '' => 'list_view',                      // default view
  43                         'Edit' => 'editor_view',
  44                         'Delete' => 'list_view',
  45                         'NEW' => 'editor_view',
  46                         'ADD' => 'editor_view',
  47                         'UPDATE' => 'editor_view',
  48                         'RESET' => 'list_view',
  49                         'CLONE' => 'editor_view'
  50                         );
  51                 $this->tool_buttons['Edit'] =
  52                         array(_('Edit'), _('Edit document line'), ICON_EDIT, '');
  53                 $this->tool_buttons['Delete'] =
  54                         array(_('Delete'), _('Remove line from document'), ICON_DELETE, '');
  55                 $this->tool_buttons['UPDATE'] =
  56                         array(_('Update'), _('Confirm changes'), ICON_UPDATE, '');
  57                 $this->tool_buttons['RESET'] =
  58                         array(_('Cancel'), _('Cancel changes'), ICON_CANCEL, '');
  59
  60                 $this->fields = $fields;
  61                 $this->selected_id = $this->_none;
  62         }
  63         /*
  64                 Input/output formatters - convert values between php/user domains.
  65         */
  66         function _format_input($value, $fmt)
  67         {
  68                 switch($fmt) {
  69                         case 'stock':
  70                                 $this->dec = get_qty_dec($value);
  71                                 return $value;
  72                         case 'price':
  73                         case 'qty':
  74                         case 'number':
  75                                     return user_numeric($value);
  76                         case 'percent':
  77                                         return user_numeric($value)/100;
  78                         case 'text':
  79                         case 'date':
  80                         default:
  81                                 return $value;
  82                 }
  83         }
  84
  85         function _format_output($value, $fmt)
  86         {
  87                 switch($fmt) {
  88                         case 'price':
  89                                 return price_format($value);
  90                         case 'qty':
  91                                 return number_format2($value, $this->dec);
  92                         case 'number':
  93                                 return number_format2($value);
  94                         case 'percent':
  95                                 return percent_format($value*100);
  96                         case 'stock':
  97                                 $this->dec = get_qty_dec($value); // retrieve dec for use in later qty fields
  98                         case 'text':
  99                         case 'date':
 100                         default:
 101                                 return $value;
 102                 }
 103         }
 104
 105         function _check_mode()
 106         {
 107                 global $Ajax;
 108
 109                 $sel_name = $this->name.'_id';
 110
 111                 // list controls lookup
 112                 foreach (array_keys($this->pre_handlers) as $m) {
 113                         if (isset($_POST[$this->name.$m])) {
 114                                 unset($_POST['_focus']); // focus on first form entry
 115                                 $Ajax->activate($this->name.'_div');
 116                                 $val = @key($_POST[$this->name.$m]);
 117                                 $this->selected_id = $val!==null ? @quoted_printable_decode($val) : $this->_none;
 118                                 return $m;
 119                         }
 120                 }
 121                 return get_post($this->name.'Mode', '');
 122         }
 123
 124         //
 125         //      Set record for edition
 126         //
 127         function _edit($mode)
 128         {
 129                 if ($this->Mode != $mode) {
 130                         if ($this->selected_id != $this->_none) {
 131                                 $this->data = $this->db_read();
 132                         }
 133                         $this->set_posts($this->data);
 134                 }
 135                 $this->Mode = $mode;
 136         }
 137         //
 138         //      Update record after edition
 139         //
 140         function _update()
 141         {
 142                 $this->get_posts();
 143                 if ($this->update_check()) {
 144                         if ($this->db_update())
 145                                 $this->selected_id = $this->_none;
 146                                 $this->Mode = '';
 147                 }
 148         }
 149         //
 150         //      Add new record
 151         //
 152         function _add()
 153         {
 154                 $this->get_posts();
 155                 if ($this->insert_check()) {
 156                         $this->db_insert();
 157                         $this->_cancel();
 158                 }
 159         }
 160         //
 161         //      Delete selected  record
 162         //
 163         function _delete()
 164         {
 165                 if ($this->delete_check())
 166                         $this->db_delete();
 167                 $this->_cancel();
 168         }
 169         //
 170         //      Return to listing view
 171         //
 172         function _cancel()
 173         {
 174                 $this->selected_id = $this->_none;
 175                 $this->db_cancel();
 176                 $this->Mode = '';
 177         }
 178         //
 179         // Clone record for new edition
 180         //
 181         function _cloning()
 182         {
 183                 $this->Mode = '';
 184                 $this->_edit('Edit');
 185                 $this->selected_id = $this->_none;
 186         }
 187         /*
 188                 Generate form controls
 189         */
 190         function _bottom_controls()
 191         {
 192                 $clone = $this->selected_id != $this->_none;
 193
 194                 $title=false;
 195                 $async='both';
 196                 $base=$this->name;
 197
 198                 $cancel = $async;
 199
 200                 if ($async === 'both') {
 201                         $async = 'default'; $cancel = 'cancel';
 202                 }
 203                 else if ($async === 'default')
 204                         $cancel = true;
 205                 else if ($async === 'cancel')
 206                         $async = true;
 207                 echo "<center>";
 208
 209                 if ($this->Mode == '' || $this->Mode == 'RESET')
 210                         submit("{$base}NEW", _("Add new"), true, $title, $async);
 211                 else {
 212                         if ($this->Mode == 'NEW' || $this->selected_id==$this->_none)
 213
 214                                 submit("{$base}ADD", _("Add"), true, $title, $async);
 215                         else {
 216                                 submit("{$base}UPDATE[{$this->selected_id}]", _("Update"), true, _('Submit changes'), $async);
 217                                 if ($clone)
 218                                         submit("{$base}CLONE[{$this->selected_id}]", _("Clone"), true, _('Edit new record with current data'), $async);
 219                         }
 220                         submit("{$base}RESET", _("Cancel"), true, _('Cancel edition'), $cancel);
 221                 }
 222                 echo "</center>";
 223         }
 224         //===========================================================================
 225         // Public functions
 226         //
 227
 228         function tool_button($name, $selected_id=null, $params='')
 229         {
 230                 $b = $this->tool_buttons[$name];
 231
 232                 return "<td align='center' $params>"
 233                         .button( "{$this->name}$name"
 234                                 .($selected_id === null || $selected_id === $this->_none ? '': "[$selected_id]"),
 235                                 $b[0], $b[1], $b[2], $b[3])."</td>";
 236         }
 237
 238         function set_posts()
 239         {
 240                 foreach($this->fields as $name => $fmt) {
 241                         if (is_int($name)) {
 242                                 $name = $fmt;
 243                                 $fmt = array();
 244                         }
 245                         $post = isset($fmt['post']) ? $fmt['post'] : $name;
 246                         $fld = isset($fmt['fld']) ? $fmt['fld'] : $name;
 247
 248                         $value = $this->selected_id == $this->_none ? @$fmt['dflt'] :
 249                                 (is_array($this->data) ? $this->data[$fld]: $this->data->$fld);
 250
 251                         $_POST[$post] = $this->_format_output($value, @$fmt['fmt']);
 252                 }
 253         }
 254         //--------------------------
 255         //
 256         //      Get editor POST variables.
 257         //
 258         function get_posts() {
 259                 foreach ($this->fields as $name => $fmt) {
 260                         if (is_int($name)) {
 261                                 $name = $fmt;
 262                                 $fmt = array();
 263                         }
 264                         $post = isset($fmt['post']) ? $fmt['post'] : $name;
 265                         $fld = isset($fmt['fld']) ? $fmt['fld'] : $name;
 266
 267                         $value = $this->_format_input($_POST[$post], @$fmt['fmt']);
 268
 269                         if (is_array($this->data))
 270                                 $this->data[$fld] = $value;
 271                         else
 272                                 $this->data->$fld = $value;
 273                 }
 274         }
 275         //      Main function - display current CRUD editor content
 276         //
 277         function show()
 278         {
 279                 if (!isset($_POST[$this->name.'Mode']))
 280                         $this->set_posts();
 281
 282                 $Mode = $this->_check_mode(true);
 283                 div_start($this->name.'_div');
 284
 285                 if (array_key_exists($Mode, $this->pre_handlers)) {
 286                         $fun = $this->pre_handlers[$Mode];
 287                         $this->$fun($Mode);
 288                 }
 289
 290                 if (isset($this->views[$this->Mode]))
 291                         $this->{$this->views[$this->Mode]}();
 292                 else
 293                         $this->{$this->views['']}(); // default view
 294
 295                 $this->_bottom_controls();
 296                 hidden($this->name.'Mode', $this->Mode.'['.$this->selected_id.']');
 297                 div_end();
 298         }
 299
 300         //===========================================================================
 301         //      Database functions placeholders
 302
 303         //
 304         //      Read record from db for edition
 305         //
 306         function db_read() {
 307                 display_notification(__FUNCTION__. ' is not defined...');
 308                 return array();
 309         }
 310         //
 311         //      Update record in db after edition
 312         //
 313         function db_update()
 314         {
 315                 $this->db_insert();
 316         }
 317         //
 318         //      Delete record
 319         //
 320         function db_delete() {
 321                 display_notification(__FUNCTION__. ' is not defined...');
 322         }
 323         //
 324         //      Insert record
 325         //
 326         function db_insert()
 327         {
 328                 display_notification(__FUNCTION__. ' is not defined...');
 329         }
 330         //
 331         //      Cancel edition
 332         //      Optional things like focus set.
 333         //
 334         function db_cancel()
 335         {
 336         }
 337
 338
 339         function delete_check() {
 340                 display_notification(__FUNCTION__. ' is not defined...');
 341                 return true;
 342         }
 343
 344         function insert_check() {
 345                 return true;
 346         }
 347
 348         function update_check()
 349         {
 350                 return $this->insert_check();
 351         }
 352
 353         //
 354         //      Show database content in pager/table
 355         //
 356         function list_view() {
 357                 display_notification(__FUNCTION__. ' is not defined...');
 358         }
 359
 360         //
 361         //      Show record editor screen content
 362         //
 363         function editor_view() {
 364                 display_notification(__FUNCTION__. ' is not defined...');
 365         }
 366 };
 367
 368 ?>