commonobjectline.class.php 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <?php
  2. /* Copyright (C) 2006-2008 Laurent Destailleur <eldy@users.sourceforge.net>
  3. * Copyright (C) 2012 Cedric Salvador <csalvador@gpcsolutions.fr>
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 3 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  17. */
  18. /**
  19. * \file htdocs/core/class/commonobjectline.class.php
  20. * \ingroup core
  21. * \brief File of the superclass of classes of lines of business objects (invoice, contract, proposal, orders, etc. ...)
  22. */
  23. /**
  24. * Parent class for class inheritance lines of business objects
  25. * This class is useless for the moment so no inherit are done on it
  26. *
  27. * TODO For the moment we use the extends on CommonObject until PHP min is 5.4 so we can use Traits.
  28. */
  29. abstract class CommonObjectLine extends CommonObject
  30. {
  31. /**
  32. * Id of the line
  33. * @var int
  34. */
  35. public $id;
  36. /**
  37. * Id of the line
  38. * @var int
  39. * @deprecated Try to use id property as possible (even if field into database is still rowid)
  40. * @see $id
  41. */
  42. public $rowid;
  43. /**
  44. * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
  45. */
  46. public $picto = 'line';
  47. /**
  48. * Product/service unit code ('km', 'm', 'p', ...)
  49. * @var string
  50. */
  51. public $fk_unit;
  52. public $date_debut_prevue;
  53. public $date_debut_reel;
  54. public $date_fin_prevue;
  55. public $date_fin_reel;
  56. public $weight;
  57. public $weight_units;
  58. public $width;
  59. public $width_units;
  60. public $height;
  61. public $height_units;
  62. public $length;
  63. public $length_units;
  64. public $surface;
  65. public $surface_units;
  66. public $volume;
  67. public $volume_units;
  68. /**
  69. * Constructor
  70. *
  71. * @param DoliDB $db Database handler
  72. */
  73. public function __construct($db)
  74. {
  75. $this->db = $db;
  76. }
  77. /**
  78. * Returns the label, short_label or code found in units dictionary from ->fk_unit.
  79. * A langs->trans() must be called on result to get translated value.
  80. *
  81. * @param string $type Label type ('long', 'short' or 'code'). This can be a translation key.
  82. * @return string|int <0 if KO, label if OK (Example: 'long', 'short' or 'unitCODE')
  83. */
  84. public function getLabelOfUnit($type = 'long')
  85. {
  86. global $langs;
  87. if (empty($this->fk_unit)) {
  88. return '';
  89. }
  90. $langs->load('products');
  91. $label_type = 'label';
  92. $label_type = 'label';
  93. if ($type == 'short') {
  94. $label_type = 'short_label';
  95. } elseif ($type == 'code') {
  96. $label_type = 'code';
  97. }
  98. $sql = "SELECT ".$label_type.", code from ".$this->db->prefix()."c_units where rowid = ".((int) $this->fk_unit);
  99. $resql = $this->db->query($sql);
  100. if ($resql && $this->db->num_rows($resql) > 0) {
  101. $res = $this->db->fetch_array($resql);
  102. if ($label_type == 'code') {
  103. $label = 'unit'.$res['code'];
  104. } else {
  105. $label = $res[$label_type];
  106. }
  107. $this->db->free($resql);
  108. return $label;
  109. } else {
  110. $this->error = $this->db->lasterror();
  111. dol_syslog(get_class($this)."::getLabelOfUnit Error ".$this->error, LOG_ERR);
  112. return -1;
  113. }
  114. }
  115. /**
  116. * Empty function to prevent errors on call of this function must be overload if usefull
  117. *
  118. * @param string $sortorder Sort Order
  119. * @param string $sortfield Sort field
  120. * @param int $limit offset limit
  121. * @param int $offset offset limit
  122. * @param array $filter filter array
  123. * @param string $filtermode filter mode (AND or OR)
  124. * @return int <0 if KO, >0 if OK
  125. */
  126. public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
  127. {
  128. return 0;
  129. }
  130. }