You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

489 line
19KB

  1. <?php
  2. /**
  3. * Copyright distrib (2018)
  4. *
  5. * contact@opendistrib.net
  6. *
  7. * Ce logiciel est un programme informatique servant à aider les producteurs
  8. * à distribuer leur production en circuits courts.
  9. *
  10. * Ce logiciel est régi par la licence CeCILL soumise au droit français et
  11. * respectant les principes de diffusion des logiciels libres. Vous pouvez
  12. * utiliser, modifier et/ou redistribuer ce programme sous les conditions
  13. * de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
  14. * sur le site "http://www.cecill.info".
  15. *
  16. * En contrepartie de l'accessibilité au code source et des droits de copie,
  17. * de modification et de redistribution accordés par cette licence, il n'est
  18. * offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons,
  19. * seule une responsabilité restreinte pèse sur l'auteur du programme, le
  20. * titulaire des droits patrimoniaux et les concédants successifs.
  21. *
  22. * A cet égard l'attention de l'utilisateur est attirée sur les risques
  23. * associés au chargement, à l'utilisation, à la modification et/ou au
  24. * développement et à la reproduction du logiciel par l'utilisateur étant
  25. * donné sa spécificité de logiciel libre, qui peut le rendre complexe à
  26. * manipuler et qui le réserve donc à des développeurs et des professionnels
  27. * avertis possédant des connaissances informatiques approfondies. Les
  28. * utilisateurs sont donc invités à charger et tester l'adéquation du
  29. * logiciel à leurs besoins dans des conditions permettant d'assurer la
  30. * sécurité de leurs systèmes et ou de leurs données et, plus généralement,
  31. * à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
  32. *
  33. * Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
  34. * pris connaissance de la licence CeCILL, et que vous en avez accepté les
  35. * termes.
  36. */
  37. namespace common\models;
  38. use common\helpers\Debug;
  39. use common\helpers\GlobalParam;
  40. use common\helpers\Price;
  41. use Yii;
  42. use common\components\ActiveRecordCommon;
  43. /**
  44. * This is the model class for table "product".
  45. *
  46. * @property integer $id
  47. * @property string $name
  48. * @property string $description
  49. * @property integer $active
  50. * @property string $photo
  51. * @property double $price
  52. * @property double $pweight
  53. * @property string $recipe
  54. * @property string $unit
  55. * @property double $step
  56. */
  57. class Product extends ActiveRecordCommon
  58. {
  59. public $total = 0;
  60. public $apply_distributions = true;
  61. public $price_with_tax = 0 ;
  62. public $wording_unit = '' ;
  63. public $pointsSale;
  64. public static $unitsArray = [
  65. 'piece' => [
  66. 'unit' => 'piece',
  67. 'wording_unit' => 'la pièce',
  68. 'wording' => 'pièce(s)',
  69. 'wording_short' => 'p.',
  70. 'coefficient' => 1
  71. ],
  72. 'g' => [
  73. 'unit' => 'g',
  74. 'wording_unit' => 'le g',
  75. 'wording' => 'g',
  76. 'wording_short' => 'g',
  77. 'coefficient' => 1000
  78. ],
  79. 'kg' => [
  80. 'unit' => 'kg',
  81. 'wording_unit' => 'le kg',
  82. 'wording' => 'kg',
  83. 'wording_short' => 'kg',
  84. 'coefficient' => 1
  85. ],
  86. 'mL' => [
  87. 'unit' => 'mL',
  88. 'wording_unit' => 'le mL',
  89. 'wording' => 'mL',
  90. 'wording_short' => 'mL',
  91. 'coefficient' => 1000
  92. ],
  93. 'L' => [
  94. 'unit' => 'L',
  95. 'wording_unit' => 'le litre',
  96. 'wording' => 'L',
  97. 'wording_short' => 'L',
  98. 'coefficient' => 1
  99. ],
  100. ];
  101. /**
  102. * @inheritdoc
  103. */
  104. public static function tableName()
  105. {
  106. return 'product';
  107. }
  108. /**
  109. * @inheritdoc
  110. */
  111. public function rules()
  112. {
  113. return [
  114. [['name', 'id_producer'], 'required'],
  115. [['active', 'order', 'id_producer', 'id_tax_rate', 'id_product_category'], 'integer'],
  116. [['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday', 'unavailable', 'apply_distributions', 'available_on_points_sale'], 'boolean'],
  117. [['price', 'weight', 'step', 'quantity_max', 'quantity_max_monday', 'quantity_max_tuesday', 'quantity_max_wednesday', 'quantity_max_thursday', 'quantity_max_friday', 'quantity_max_saturday', 'quantity_max_sunday'], 'number'],
  118. [['photo'], 'file'],
  119. [['name', 'reference', 'description', 'photo', 'unit'], 'string', 'max' => 255],
  120. [['recipe'], 'string', 'max' => 1000],
  121. ['step', 'required', 'message' => 'Champs obligatoire', 'when' => function ($model) {
  122. if ($model->unit != 'piece') {
  123. return true;
  124. }
  125. return false;
  126. }],
  127. [['price_with_tax', 'wording_unit', 'pointsSale'], 'safe']
  128. ];
  129. }
  130. /**
  131. * @inheritdoc
  132. */
  133. public function attributeLabels()
  134. {
  135. return [
  136. 'id' => 'ID',
  137. 'name' => 'Nom',
  138. 'reference' => 'Référence',
  139. 'description' => 'Description',
  140. 'active' => 'Actif',
  141. 'photo' => 'Photo',
  142. 'price' => 'Prix (€) TTC',
  143. 'weight' => 'Poids',
  144. 'recipe' => 'Recette',
  145. 'monday' => 'Lundi',
  146. 'tuesday' => 'Mardi',
  147. 'wednesday' => 'Mercredi',
  148. 'thursday' => 'Jeudi',
  149. 'friday' => 'Vendredi',
  150. 'saturday' => 'Samedi',
  151. 'sunday' => 'Dimanche',
  152. 'order' => 'Ordre',
  153. 'quantity_max' => 'Quantité max par défaut',
  154. 'quantity_max_monday' => 'Quantité max : lundi',
  155. 'quantity_max_tuesday' => 'Quantité max : mardi',
  156. 'quantity_max_wednesday' => 'Quantité max : mercredi',
  157. 'quantity_max_thursday' => 'Quantité max : jeudi',
  158. 'quantity_max_friday' => 'Quantité max : vendredi',
  159. 'quantity_max_saturday' => 'Quantité max : samedi',
  160. 'quantity_max_sunday' => 'Quantité max : dimanche',
  161. 'unavailable' => 'Épuisé',
  162. 'apply_distributions' => 'Appliquer ces modifications dans les distributions futures',
  163. 'unit' => 'Unité',
  164. 'step' => 'Pas',
  165. 'id_tax_rate' => 'TVA',
  166. 'id_product_category' => 'Catégorie',
  167. 'available_on_points_sale' => 'Par défaut'
  168. ];
  169. }
  170. public function afterFind() {
  171. if ($this->taxRate == null) {
  172. $producer = Producer::searchOne(['id' => GlobalParam::getCurrentProducerId()]) ;
  173. if($producer) {
  174. $this->populateRelation('taxRate', $producer->taxRate);
  175. }
  176. }
  177. $this->wording_unit = Product::strUnit($this->unit) ;
  178. $this->price_with_tax = $this->getPriceWithTax() ;
  179. parent::afterFind();
  180. }
  181. public function getProductDistribution()
  182. {
  183. return $this->hasMany(ProductDistribution::className(), ['id_product' => 'id']);
  184. }
  185. public function getProductSubscription()
  186. {
  187. return $this->hasMany(ProductSubscription::className(), ['id_product' => 'id']);
  188. }
  189. public function getTaxRate()
  190. {
  191. return $this->hasOne(TaxRate::className(), ['id' => 'id_tax_rate']);
  192. }
  193. public function getProductPrice()
  194. {
  195. return $this->hasMany(ProductPrice::className(), ['id_product' => 'id']);
  196. }
  197. public function getProductCategory()
  198. {
  199. return $this->hasOne(ProductCategory::className(), ['id' => 'id_product_category']) ;
  200. }
  201. public function getProductPointSale()
  202. {
  203. return $this->hasMany(ProductPointSale::className(), ['id_product' => 'id']) ;
  204. }
  205. /**
  206. * Retourne les options de base nécessaires à la fonction de recherche.
  207. *
  208. * @return array
  209. */
  210. public static function defaultOptionsSearch()
  211. {
  212. return [
  213. 'with' => ['taxRate', 'productPointSale'],
  214. 'join_with' => [],
  215. 'orderby' => 'order ASC',
  216. 'attribute_id_producer' => 'product.id_producer'
  217. ];
  218. }
  219. public function isAvailableOnPointSale($pointSale)
  220. {
  221. // disponible par défaut
  222. if($this->available_on_points_sale) {
  223. foreach($this->productPointSale as $productPointSale) {
  224. if($pointSale->id == $productPointSale->id_point_sale
  225. //&& $productPointSale->id_product == $this->id
  226. && !$productPointSale->available) {
  227. return false;
  228. }
  229. }
  230. return true;
  231. }
  232. // indisponible par défaut
  233. else {
  234. foreach($this->productPointSale as $productPointSale) {
  235. if($pointSale->id == $productPointSale->id_point_sale
  236. //&& $productPointSale->id_product == $this->id
  237. && $productPointSale->available) {
  238. return true;
  239. }
  240. }
  241. return false;
  242. }
  243. }
  244. /**
  245. * Retourne la description du produit.
  246. *
  247. * @return string
  248. */
  249. public function getDescription()
  250. {
  251. $description = $this->description;
  252. if (isset($this->weight) && is_numeric($this->weight) && $this->weight > 0) {
  253. if ($this->weight >= 1000) {
  254. $description .= ' (' . ($this->weight / 1000) . 'kg)';
  255. } else {
  256. $description .= ' (' . $this->weight . 'g)';
  257. }
  258. }
  259. return $description;
  260. }
  261. /**
  262. * Retourne le libellé (admin) du produit.
  263. * @return type
  264. */
  265. public function getStrWordingAdmin()
  266. {
  267. return $this->name;
  268. }
  269. /**
  270. * Enregistre le produit.
  271. *
  272. * @param boolean $runValidation
  273. * @param array $attributeNames
  274. * @return boolean
  275. */
  276. public function save($runValidation = true, $attributeNames = NULL)
  277. {
  278. $this->id_producer = GlobalParam::getCurrentProducerId();
  279. return parent::save($runValidation, $attributeNames);
  280. }
  281. /**
  282. * Retourne les produits d'une production donnée.
  283. *
  284. * @param integer $idDistribution
  285. * @return array
  286. */
  287. public static function searchByDistribution($idDistribution)
  288. {
  289. return Product::find()
  290. ->leftJoin('product_distribution', 'product.id = product_distribution.id_product')
  291. ->where([
  292. 'id_producer' => GlobalParam::getCurrentProducerId(),
  293. 'product_distribution.id_distribution' => $idDistribution
  294. ])
  295. ->orderBy('product_distribution.active DESC, product.order ASC')
  296. ->all();
  297. }
  298. /**
  299. * Retourne le nombre de produits du producteur courant.
  300. *
  301. * @return integer
  302. */
  303. public static function count()
  304. {
  305. return self::searchCount();
  306. }
  307. /**
  308. * Retourne le produit "Don".
  309. *
  310. * @return Product
  311. */
  312. public static function getProductGift()
  313. {
  314. $productGift = Product::find()
  315. ->where([
  316. 'product.id_producer' => 0
  317. ])
  318. ->andFilterWhere(['like', 'product.name', 'Don'])
  319. ->one();
  320. return $productGift;
  321. }
  322. /**
  323. * Retourne le libellé d'une unité.
  324. *
  325. * @param $format wording_unit, wording, short
  326. * @param $unitInDb Unité stockée en base de données (ex: si g > kg, si mL > L)
  327. * @return $string Libellé de l'unité
  328. */
  329. public static function strUnit($unit, $format = 'wording_short', $unitInDb = false)
  330. {
  331. $strUnit = '';
  332. if ($unitInDb) {
  333. if ($unit == 'g') {
  334. $unit = 'kg';
  335. }
  336. if ($unit == 'mL') {
  337. $unit = 'L';
  338. }
  339. }
  340. if (isset(self::$unitsArray[$unit]) && isset(self::$unitsArray[$unit][$format])) {
  341. $strUnit = self::$unitsArray[$unit][$format];
  342. }
  343. return $strUnit;
  344. }
  345. public function getPrice($params = [])
  346. {
  347. $specificPrices = $this->productPrice ;
  348. $user = isset($params['user']) ? $params['user'] : false ;
  349. $userProducer = isset($params['user_producer']) ? $params['user_producer'] : false ;
  350. $pointSale = isset($params['point_sale']) ? $params['point_sale'] : false ;
  351. if($specificPrices && ($user || $pointSale)) {
  352. $specificPricesArray = [
  353. 'user' => false,
  354. 'pointsale' => false,
  355. 'user_pointsale' => false,
  356. 'usergroup' => false,
  357. ] ;
  358. foreach($specificPrices as $specificPrice) {
  359. if($user
  360. && $specificPrice->id_user
  361. && !$specificPrice->id_point_sale
  362. && !$specificPrice->id_user_group
  363. && $specificPrice->id_user == $user->id) {
  364. $specificPricesArray['user'] = $specificPrice->price ;
  365. }
  366. if($user
  367. && $specificPrice->id_user_group
  368. && !$specificPrice->id_point_sale
  369. && !$specificPrice->id_user
  370. && $user->belongsToUserGroup($specificPrice->id_user_group)) {
  371. $specificPricesArray['usergroup'] = $specificPrice->price ;
  372. }
  373. if($pointSale
  374. && $specificPrice->id_point_sale
  375. && !$specificPrice->id_user
  376. && !$specificPrice->id_user_group
  377. && $specificPrice->id_point_sale == $pointSale->id) {
  378. $specificPricesArray['pointsale'] = $specificPrice->price ;
  379. }
  380. if($pointSale && $user
  381. && $specificPrice->id_point_sale
  382. && $specificPrice->id_user
  383. && $specificPrice->id_point_sale == $pointSale->id
  384. && $specificPrice->id_user == $user->id) {
  385. $specificPricesArray['user_pointsale'] = $specificPrice->price ;
  386. }
  387. }
  388. if($specificPricesArray['user_pointsale']) {
  389. return $specificPricesArray['user_pointsale'] ;
  390. }
  391. elseif($specificPricesArray['user']) {
  392. return $specificPricesArray['user'] ;
  393. }
  394. elseif($specificPricesArray['usergroup']) {
  395. return $specificPricesArray['usergroup'] ;
  396. }
  397. elseif($specificPricesArray['pointsale']) {
  398. return $specificPricesArray['pointsale'] ;
  399. }
  400. }
  401. if($userProducer && $userProducer->product_price_percent) {
  402. return $this->price * (1 + $userProducer->product_price_percent / 100) ;
  403. }
  404. if($pointSale && $pointSale->product_price_percent) {
  405. return $this->price * (1 + $pointSale->product_price_percent / 100) ;
  406. }
  407. return $this->price ;
  408. }
  409. /**
  410. * Retourne le prix du produit avec taxe
  411. */
  412. public function getPriceWithTax($params = [])
  413. {
  414. $taxRateValue = $this->taxRate ? $this->taxRate->value : 0 ;
  415. return Price::getPriceWithTax($this->getPrice($params), $taxRateValue);
  416. }
  417. public function getTheTaxRate()
  418. {
  419. if($this->id_tax_rate) {
  420. return $this->id_tax_rate ;
  421. }
  422. else {
  423. return GlobalParam::getCurrentProducer()->taxRate->id;
  424. }
  425. }
  426. public function getNameExport()
  427. {
  428. $producer = GlobalParam::getCurrentProducer() ;
  429. if($producer->option_export_display_product_reference && $this->reference && strlen($this->reference) > 0) {
  430. return $this->reference ;
  431. }
  432. return $this->name ;
  433. }
  434. }