AOOSModel.php

   1 <?php
   2 require_once("AOOSException.php");
   3 require_once("AOOSModule.php");
   4
   5 /**
   6  * AOOSModel
   7  * A table-like model for containing data
   8  * @author Sebastian Skejø
   9  */
  10
  11 class AOOSModel extends AOOSModule
  12 {
  13     private $_rows = 0;
  14     private $_data = array();
  15     private $_model = array();
  16     private $_updated = false;
  17     private $_columnIndex = array();
  18     private $_escape = true;
  19     private $_quote = false;
  20     private $_equal = "{'}";
  21     private $_seperator = "]'[";
  22
  23     public function __toString() {
  24         $string = nl2br(str_replace(" ", "&nbsp;", print_r($this->data(), true)));
  25 /*        foreach ($this->data() as $row) {
  26             $string .= print_r($row, true);
  27             $string .= "<br />";
  28 }
  29  */
  30         return $string;
  31     }
  32
  33     private function _fixRange(&$start, &$end, $count)
  34     {
  35         if ($start === null) { $start = 0; }
  36         if ($end === null) { $end = $count-1; }
  37
  38         if (!is_int($start) || !is_int($end))
  39         {
  40             throw new AOOSException($this->core(), $this->tr("not_int"), "", true, 1);
  41             return false;
  42         }
  43
  44         if ($start >= $count || $end >= $count)
  45         {
  46             throw new AOOSException($this->core(), $this->tr("row_out_of_bounds"), "", true, 1);
  47             return false;
  48         }
  49
  50         if ($start > $end && !($end < 0))
  51         {
  52             throw new AOOSException($this->core(), $this->tr("start_bigger_than_end"), "", true, 1);
  53             return false;
  54         }
  55
  56         // If start is > 0 we count from the end
  57         if ($start < 0)
  58         {
  59             $start = $count + $start;
  60         }
  61         // Same goes for end
  62         if ($end < 0)
  63         {
  64             $end = $count + $end;
  65         }
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Adds a row before $row.
  72      * @param int $row The row which the new row should be inserted before. If given -1 it will be inserted at the end of the model.
  73      * @return bool
  74      */
  75     public function addRow($row = -1)
  76     {
  77         if ($row > count($this->_data) || $row < -1)
  78         {
  79             throw new AOOSException($this->core(), $this->tr("row_out_of_bounds"), "", true, 1);
  80             return false;
  81         }
  82
  83         if ($row == -1 || count($this->_data) == 0)
  84         {
  85             $this->_data[] = null;
  86         }
  87         else
  88         {
  89             $tmp = $this->_data;
  90             $this->_data[$row] = null;
  91
  92             $count = count($this->_data);
  93             while ($row < $count)
  94             {
  95                 $val = $tmp[$row];
  96                 $row++;
  97                 $this->_data[$row] = $val;
  98             }
  99         }
 100         $this->_updated = false;
 101         $this->_rows++;
 102         return true;
 103     }
 104
 105     /**
 106      * Removes a row from the model.
 107      * @param int $row The row to remove. Given -1 the last row is removed.
 108      * @return bol
 109      */
 110     public function removeRow($row = -1)
 111     {
 112         if ($row < -1 || $row >= count($this->_data))
 113         {
 114             throw new AOOSException($this->core(), $this->tr("row_out_of_bounds"), "", true, 2);
 115             return false;
 116         }
 117
 118         if ($row == -1)
 119         {
 120             $row = count($this->_data) - 1;
 121         }
 122         $tmp = $this->_data;
 123         $this->_data = array();
 124
 125         // Reinsert rows before $row
 126         for ($i = 0; $i < $row; $i++)
 127         {
 128             $this->_data[] = $tmp[$i];
 129         }
 130
 131         $row++;
 132
 133         // Reinsert rows after $row
 134         for ($c = count($tmp); $row < $c; $row++)
 135         {
 136             $this->_data[] = $tmp[$row];
 137         }
 138
 139         $this->_updated = false;
 140         $this->_rows--;
 141         return true;
 142     }
 143
 144     /**
 145      * Sets the data of a specified row and column.
 146      * @param int $row The row in which the column is selected from
 147      * @param int|string $col The column in which the data should be added
 148      * @param $data The data that should be added.
 149      * @return bool
 150      */
 151     public function setData($data, $row = -1, $col = -1)
 152     {
 153         if ($row >= count($this->_data))
 154         {
 155             throw new AOOSException($this->core(), $this->tr("row_out_of_bounds"), "", true, 1);
 156             return false;
 157         }
 158         if ($row == -1)
 159         {
 160             $row = $this->rows() -1;
 161         }
 162
 163         if (is_string($col))
 164         {
 165             $i = 0;
 166             foreach ($this->_columnIndex as $index)
 167             {
 168                 if ($index == $col)
 169                 {
 170                     $col = $i;
 171                     break;
 172                 }
 173                 $i++;
 174             }
 175         }
 176         if ($col >= count($this->_data[$row]) || $col == -1)
 177         {
 178             $col = count($this->_data[$row]);
 179         }
 180
 181         $this->_data[$row][$col] = $data;
 182         $this->_updated = false;
 183         return true;
 184     }
 185
 186     /**
 187      * Sets column index
 188      * @param int $col Column
 189      * @param string $index Column index
 190      * @return bool
 191      */
 192     public function setColumnIndex()
 193     {
 194         $count = func_num_args();
 195         $arg1 = func_get_arg(0);
 196         switch ($count)
 197         {
 198         case (2):
 199             $arg2 = func_get_arg(1);
 200             $this->_setColumnIndexSingle($arg1, $arg2);
 201             break;
 202         case(1):
 203             $this->_setColumnIndexArray($arg1);
 204             break;
 205         }
 206         $this->_updated = false;
 207     }
 208
 209     private function _setColumnIndexSingle($col, $index)
 210     {
 211         if (!is_int($col))
 212         {
 213             throw new AOOSException($this->core(), $this->tr("not_integer"), "", true, 1);
 214             return false;
 215         }
 216         if (!is_string($index))
 217         {
 218             throw new AOOSException($this->core(), $this->tr("not_string"), "", true, 1);
 219             return false;
 220         }
 221         $this->_columnIndex[$col] = $index;
 222     }
 223
 224     private function _setColumnIndexArray($index)
 225     {
 226         if (!is_array($index))
 227         {
 228             throw new AOOSException($this->core(), $this->tr("not_array"), "", true, 1);
 229             return false;
 230         }
 231
 232         $c = 0;
 233         foreach ($index as $i)
 234         {
 235             $this->_columnIndex[$c] = $i;
 236             $c++;
 237         }
 238     }
 239
 240     /**
 241      * Returns everything in the model
 242      * @return data|false
 243      */
 244     public function data()
 245     {
 246         $data       = array();
 247         $rowIndex   = 0;
 248
 249         if ($this->_updated) // If the model is updated we don't need to iterate through the data
 250         {
 251             return $this->_model;
 252         }
 253
 254         foreach ($this->_data as $row)
 255         {
 256             $index = 0;
 257             foreach ($this->_columnIndex as $colIndex)
 258             {
 259                 if ($index >= count($row))
 260                 {
 261                     $row[$index] = "";
 262                 }
 263
 264                 $col = $row[$index];
 265                 if ($this->escape())
 266                 {
 267                     $col = mysql_real_escape_string($col);
 268                 }
 269
 270                 if ($this->quote())
 271                 {
 272                     $col = "\"".$col."\"";
 273                 }
 274
 275                 $data[$rowIndex][$colIndex] = $col;
 276                 $index++;
 277             }
 278             $rowIndex++;
 279         }
 280         $this->_updated = true;
 281         $this->_model = $data;
 282         return $this->_model;
 283     }
 284
 285     /**
 286      * Returns a given column
 287      * @param string $index The column index
 288      * @param bool $single If set to true, a string with the first value in the column is returned instead of an array
 289      * @param int $start "From row"
 290      * @param int $end "To row". Inclusive.
 291      * @return array|string
 292      */
 293     public function getColumn($index, $single = false, $start = null, $end = null)
 294     {
 295         $data = $this->data();
 296         $count = count($data);
 297         $column = array();
 298
 299         if (!in_array($index, $this->_columnIndex))
 300         {
 301             throw new AOOSException($this->core(), $this->tr("not_in_column_index"), "", true, 1);
 302             return false;
 303         }
 304
 305         $this->_fixRange($start, $end, $count);
 306
 307         for ($i = $start; $i <= $end; $i++)
 308         {
 309             $column[] = $data[$i][$index];
 310         }
 311
 312         if ($single) {
 313             $column = array_pop($column);
 314         }
 315
 316         return $column;
 317     }
 318
 319     public function getColumns($fields, $start = null, $end = null)
 320     {
 321         $cols = array();
 322         foreach ($fields as $index)
 323         {
 324             $cols[] = $this->getColumn($index, $start, $end);
 325         }
 326         return $cols;
 327     }
 328
 329     /**
 330      * Returns rows
 331      * @param int $start "From row"
 332      * @param int $end "To row". Inclusive.
 333      * @param int $cutoff If set to true the $end row will be adjusted to fit within the number of rows if the given $end is bigger.
 334      * @return array
 335      */
 336     public function getRows($start = null, $end = null, $cutoff = false)
 337     {
 338         $data = $this->data();
 339         $count = count($data);
 340         $rows = array();
 341
 342         if ($this->rows() == 0)
 343         {
 344             throw new AOOSException($this->core(), $this->tr("model_empty"), "", true, 2);
 345             return false;
 346         }
 347
 348         if ($cutoff && $end > $this->rows())
 349         {
 350             $end = $this->rows();
 351         }
 352
 353         $this->_fixRange($start, $end, $count);
 354
 355         for ($i = $start; $i <= $end; $i++)
 356         {
 357             $rows[] = $data[$i];
 358         }
 359
 360         return $rows;
 361     }
 362
 363     /**
 364      * Returns a single row
 365      * @param int $id Row id
 366      * @return array
 367      */
 368     public function getRow($id)
 369     {
 370         $tmp = $this->getRows($id, $id);
 371         return $tmp[0];
 372     }
 373
 374
 375     /**
 376      * Returns the column index
 377      * @return array
 378      */
 379     public function columnIndex()
 380     {
 381         return $this->_columnIndex;
 382     }
 383
 384     /**
 385      * Returns the row count
 386      * @return int
 387      */
 388     public function rows()
 389     {
 390         return $this->_rows;
 391     }
 392
 393     /**
 394      * Returns the column count
 395      * @return int
 396      */
 397     public function columns()
 398     {
 399         return count($this->_columnIndex);
 400     }
 401
 402     /**
 403      * Is the given value in the given column?
 404      * @param string $col Column id
 405      * @param value $val Value
 406      * @return bool
 407      */
 408     public function inColumn($col, $val)
 409     {
 410         $c = $this->getColumn($col);
 411         if (!in_array($val, $c))
 412         {
 413             return false;
 414         }
 415         return true;
 416     }
 417
 418     /**
 419      * Is the given value a column index?
 420      * @param string $name
 421      * @return bool
 422      */
 423     public function inColumnIndex($name)
 424     {
 425         if (!in_array($name, $this->columnIndex()))
 426         {
 427             return false;
 428         }
 429         return true;
 430     }
 431
 432     /**
 433      * Appends given values to the end of the model. The number of keys is the number of values added.
 434      * @param array $values Values to append.
 435      * @param auto|null $key If "auto" is given the column ids we be determined automatically. If not the function expects the array to be a hash which keys is used as column indexes(default).
 436      * @return bool
 437      */
 438     public function append($values, $key = null)
 439     {
 440         $keys = array();
 441         $c = 0;
 442
 443         if (!is_array($values))
 444         {
 445             throw new AOOSException($this->core(), $this->tr("not_array"));
 446             return false;
 447         }
 448
 449         if ($key == "auto")
 450         {
 451             $keys = $this->columnIndex();
 452         }
 453         else
 454         {
 455             $keys = array_keys($values);
 456             $values = array_values($values);
 457         }
 458
 459         $this->addRow();
 460         $c = count($keys);
 461         for ($i=0; $i<$c; $i++)
 462         {
 463             $this->setData($values[$i], -1, $keys[$i]);
 464         }
 465         return true;
 466     }
 467
 468     /**
 469      * Returns the row index in which the given field has the given value. Returns false if none is found
 470      * @param string $name Field name
 471      * @param string $value Field value
 472      * @return int|false
 473      */
 474     public function getRowFromValue($name, $value)
 475     {
 476         if (!$this->inColumnIndex($name))
 477         {
 478             throw new AOOSException($this->core(), $this->tr("not_in_column_index"), "", true, 2);
 479             return false;
 480         }
 481
 482         $c = $this->getColumn($name);
 483         $r = null;
 484         for($i = 0; $i < count($c); $i++)
 485         {
 486             if ($c[$i] == $value)
 487             {
 488                 $r = $i;
 489             }
 490         }
 491
 492         if ($r === null)
 493         {
 494             throw new AOOSException($this->core(), $this->tr("value_not_in_row"), $this->tr("given_value").":". $value, true, 2);
 495             return false;
 496         }
 497
 498         return $r;
 499     }
 500
 501     /**
 502      * Returns a given field. Calls getColum.
 503      * @param int $row The row
 504      * @param string $column Column index
 505      * @return value|false
 506      */
 507     public function getField($row, $column)
 508     {
 509         return $this->getColumn($column, $row, $row);
 510     }
 511
 512     /**
 513      * When set to true all data is escaped. Escaping is done in the data() call, which means *all* data is escaped, not only newly added data.
 514      * Default is true.
 515      * @param bool $state Should data be escaped or not?
 516      * @return bool
 517      */
 518     public function setEscape($state)
 519     {
 520         if (!is_bool($state))
 521         {
 522             throw new AOOSException($this->core(), $this->tr("not_bool"));
 523             return false;
 524         }
 525         $this->_escape = $state;
 526         $this->_updated = false;
 527         return true;
 528     }
 529
 530     /**
 531      * Is data being escaped?
 532      * @return bool
 533      */
 534     public function escape()
 535     {
 536         return $this->_escape;
 537     }
 538
 539     /**
 540      * When set to true all data have quotes around it. Like setEscape(), quotes are added during the data() call. This means that all data, and not only newly added data, is quoted.
 541      * Default is false.
 542      * @param bool $state Should data have quotes or not?
 543      * @return bool
 544      */
 545     public function setQuote($state)
 546     {
 547         if (!is_bool($state))
 548         {
 549             throw new AOOSException($this->core(), $this->tr("not_bool"));
 550             return false;
 551         }
 552         $this->_quote = $state;
 553         $this->_updated = false;
 554         return true;
 555     }
 556
 557     /**
 558      * Is data being quoted?
 559      * @return bool
 560      */
 561     public function quote()
 562     {
 563         return $this->_quote;
 564     }
 565
 566     /**
 567      * Sort using mergesort
 568      * @param string $name The column the data should be sorted by.
 569      * @param ASC|DESC $order Should data be sorting in ascending or descending order?
 570      * @return bool
 571      */
 572     public function sort($name, $order)
 573     {
 574         return true;
 575     }
 576
 577     /**
 578      * Merges the selected data to a string
 579      * @param ROW|COL $type Should data be selected from row or column?
 580      * @param id $id Identifier.
 581      */
 582     public function merge($type, $id)
 583     {
 584         switch ($type)
 585         {
 586         case("ROW"):
 587             $data = $this->getRow($id);
 588             break;
 589         case("COL"):
 590             $data = $this->getColumn($id);
 591             break;
 592         default:
 593             throw new AOOSException($this->core(), $this->tr("not_ROW_or_COL"), "", true, 1);
 594             return false;
 595         }
 596
 597         $pairs = array();
 598         foreach ($data as $key => $value)
 599         {
 600             $pairs[] = $key.$this->_equal.$value;
 601         }
 602         $string = implode($pairs, $this->_seperator);
 603         return $string;
 604     }
 605
 606     /**
 607      * Splits the given string and appends it to the current model
 608      * $param string $string The string to be splittet
 609      */
 610     public function split($string)
 611     {
 612         $f = array();
 613         $a = explode($this->_seperator, $string);
 614         foreach($a as $col)
 615         {
 616             $s = explode($this->_equal, $col);
 617             $f[$s[0]] = $s[1];
 618         }
 619         $colindex = $this->columnIndex();
 620         foreach(array_keys($f) as $index) {
 621             $colindex[] = $index;
 622         }
 623         $this->setColumnIndex($colindex);
 624         $this->append($f);
 625     }
 626 }
 627
 628 ?>