forked from PrestaShop/PrestaShop
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ObjectModel.php
1578 lines (1370 loc) · 47.8 KB
/
ObjectModel.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
* 2007-2012 PrestaShop
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to [email protected] so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
* @author PrestaShop SA <[email protected]>
* @copyright 2007-2012 PrestaShop SA
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
abstract class ObjectModelCore
{
/**
* List of field types
*/
const TYPE_INT = 1;
const TYPE_BOOL = 2;
const TYPE_STRING = 3;
const TYPE_FLOAT = 4;
const TYPE_DATE = 5;
const TYPE_HTML = 6;
const TYPE_NOTHING = 7;
/**
* List of data to format
*/
const FORMAT_COMMON = 1;
const FORMAT_LANG = 2;
const FORMAT_SHOP = 3;
/**
* List of association types
*/
const HAS_ONE = 1;
const HAS_MANY = 2;
/** @var integer Object id */
public $id;
/** @var integer lang id */
protected $id_lang = null;
protected $id_shop = null;
public $id_shop_list = null;
protected $get_shop_from_context = true;
protected static $fieldsRequiredDatabase = null;
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['table'] property instead
*/
protected $table;
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['primary'] property instead
*/
protected $identifier;
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['fields'] property instead
*/
protected $fieldsRequired = array();
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['fields'] property instead
*/
protected $fieldsSize = array();
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['fields'] property instead
*/
protected $fieldsValidate = array();
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['fields'] property instead
*/
protected $fieldsRequiredLang = array();
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['fields'] property instead
*/
protected $fieldsSizeLang = array();
/**
* @deprecated 1.5.0 This property shouldn't be overloaded anymore in class, use static $definition['fields'] property instead
*/
protected $fieldsValidateLang = array();
/**
* @deprecated 1.5.0
*/
protected $tables = array();
/** @var array tables */
protected $webserviceParameters = array();
/** @var string path to image directory. Used for image deletion. */
protected $image_dir = null;
/** @var string file type of image files. Used for image deletion. */
protected $image_format = 'jpg';
/**
* @var array Contain object definition
* @since 1.5.0
*/
public static $definition = array();
/**
* @var array Contain current object definition
*/
protected $def;
/**
* @var array List of specific fields to update (all fields if null)
*/
protected $update_fields = null;
/**
* @var Db An instance of the db in order to avoid calling Db::getInstance() thousands of time
*/
protected static $db = false;
/**
* Returns object validation rules (fields validity)
*
* @param string $class Child class name for static use (optional)
* @return array Validation rules (fields validity)
*/
public static function getValidationRules($class = __CLASS__)
{
$object = new $class();
return array(
'required' => $object->fieldsRequired,
'size' => $object->fieldsSize,
'validate' => $object->fieldsValidate,
'requiredLang' => $object->fieldsRequiredLang,
'sizeLang' => $object->fieldsSizeLang,
'validateLang' => $object->fieldsValidateLang,
);
}
/**
* Build object
*
* @param int $id Existing object id in order to load object (optional)
* @param int $id_lang Required if object is multilingual (optional)
* @param int $id_shop ID shop for objects with multishop on langs
*/
public function __construct($id = null, $id_lang = null, $id_shop = null)
{
if (!ObjectModel::$db)
ObjectModel::$db = Db::getInstance();
$this->def = self::getDefinition($this);
$this->setDefinitionRetrocompatibility();
if ($id_lang !== null)
$this->id_lang = (Language::getLanguage($id_lang) !== false) ? $id_lang : Configuration::get('PS_LANG_DEFAULT');
if ($id_shop && $this->isMultishop())
{
$this->id_shop = (int)$id_shop;
$this->get_shop_from_context = false;
}
if ($this->isMultishop() && !$this->id_shop)
$this->id_shop = Context::getContext()->shop->id;
if (!Validate::isTableOrIdentifier($this->def['primary']) || !Validate::isTableOrIdentifier($this->def['table']))
throw new PrestaShopException('Identifier or table format not valid for class '.get_class($this));
if ($id)
{
// Load object from database if object id is present
$cache_id = 'objectmodel_'.$this->def['table'].'_'.(int)$id.'_'.(int)$id_shop.'_'.(int)$id_lang;
if (!Cache::isStored($cache_id))
{
$sql = new DbQuery();
$sql->from($this->def['table'], 'a');
$sql->where('a.'.$this->def['primary'].' = '.(int)$id);
// Get lang informations
if ($id_lang)
{
$sql->leftJoin($this->def['table'].'_lang', 'b', 'a.'.$this->def['primary'].' = b.'.$this->def['primary'].' AND b.id_lang = '.(int)$id_lang);
if ($this->id_shop && !empty($this->def['multilang_shop']))
$sql->where('b.id_shop = '.$this->id_shop);
}
// Get shop informations
if (Shop::isTableAssociated($this->def['table']))
$sql->leftJoin($this->def['table'].'_shop', 'c', 'a.'.$this->def['primary'].' = c.'.$this->def['primary'].' AND c.id_shop = '.(int)$this->id_shop);
if ($row = ObjectModel::$db->getRow($sql))
Cache::store($cache_id, $row);
}
$result = Cache::retrieve($cache_id);
if ($result)
{
$this->id = (int)$id;
foreach ($result as $key => $value)
if (array_key_exists($key, $this))
$this->{$key} = $value;
if (!$id_lang && isset($this->def['multilang']) && $this->def['multilang'])
{
$sql = 'SELECT * FROM `'.pSQL(_DB_PREFIX_.$this->def['table']).'_lang`
WHERE `'.$this->def['primary'].'` = '.(int)$id
.(($this->id_shop && $this->isLangMultishop()) ? ' AND `id_shop` = '.$this->id_shop : '');
$result = ObjectModel::$db->executeS($sql);
if ($result)
foreach ($result as $row)
foreach ($row as $key => $value)
{
if (array_key_exists($key, $this) && $key != $this->def['primary'])
{
if (!is_array($this->{$key}))
$this->{$key} = array();
$this->{$key}[$row['id_lang']] = $value;
}
}
}
}
}
if (!is_array(self::$fieldsRequiredDatabase))
{
$fields = $this->getfieldsRequiredDatabase(true);
if ($fields)
foreach ($fields as $row)
self::$fieldsRequiredDatabase[$row['object_name']][(int)$row['id_required_field']] = pSQL($row['field_name']);
else
self::$fieldsRequiredDatabase = array();
}
}
/**
* Prepare fields for ObjectModel class (add, update)
* All fields are verified (pSQL, intval...)
*
* @return array All object fields
*/
public function getFields()
{
$this->validateFields();
$fields = $this->formatFields(self::FORMAT_COMMON);
// For retro compatibility
if (Shop::isTableAssociated($this->def['table']))
$fields = array_merge($fields, $this->getFieldsShop());
// Ensure that we get something to insert
if (!$fields && isset($this->id) && Validate::isUnsignedId($this->id))
$fields[$this->def['primary']] = $this->id;
return $fields;
}
/**
* Prepare fields for multishop
* Fields are not validated here, we considere they are already validated in getFields() method, this
* not the best solution but this is the only one possible for retro compatibility.
*
* @since 1.5.0
* @return array All object fields
*/
public function getFieldsShop()
{
$fields = $this->formatFields(self::FORMAT_SHOP);
if (!$fields && isset($this->id) && Validate::isUnsignedId($this->id))
$fields[$this->def['primary']] = $this->id;
return $fields;
}
/**
* Prepare multilang fields
*
* @since 1.5.0
* @return array
*/
public function getFieldsLang()
{
// Retrocompatibility
if (method_exists($this, 'getTranslationsFieldsChild'))
return $this->getTranslationsFieldsChild();
$this->validateFieldsLang();
$is_lang_multishop = $this->isLangMultishop();
$fields = array();
if ($this->id_lang === null)
foreach (Language::getLanguages(false) as $language)
{
$fields[$language['id_lang']] = $this->formatFields(self::FORMAT_LANG, $language['id_lang']);
$fields[$language['id_lang']]['id_lang'] = $language['id_lang'];
if ($this->id_shop && $is_lang_multishop)
$fields[$language['id_lang']]['id_shop'] = (int)$this->id_shop;
}
else
{
$fields = array($this->id_lang => $this->formatFields(self::FORMAT_LANG, $this->id_lang));
$fields[$this->id_lang]['id_lang'] = $this->id_lang;
if ($this->id_shop && $is_lang_multishop)
$fields[$this->id_lang]['id_shop'] = (int)$this->id_shop;
}
return $fields;
}
/**
* @since 1.5.0
* @param int $type FORMAT_COMMON or FORMAT_LANG or FORMAT_SHOP
* @param int $id_lang If this parameter is given, only take lang fields
* @return array
*/
protected function formatFields($type, $id_lang = null)
{
$fields = array();
// Set primary key in fields
if (isset($this->id))
$fields[$this->def['primary']] = $this->id;
foreach ($this->def['fields'] as $field => $data)
{
// Only get fields we need for the type
// E.g. if only lang fields are filtered, ignore fields without lang => true
if (($type == self::FORMAT_LANG && empty($data['lang']))
|| ($type == self::FORMAT_SHOP && empty($data['shop']))
|| ($type == self::FORMAT_COMMON && (!empty($data['shop']) || !empty($data['lang']))))
continue;
if (is_array($this->update_fields))
if ((!empty($data['lang']) || !empty($data['shop'])) && (empty($this->update_fields[$field]) || ($type == self::FORMAT_LANG && empty($this->update_fields[$field][$id_lang]))))
continue;
// Get field value, if value is multilang and field is empty, use value from default lang
$value = $this->$field;
if ($type == self::FORMAT_LANG && $id_lang && is_array($value))
{
if (!empty($value[$id_lang]))
$value = $value[$id_lang];
else if (!empty($data['required']))
$value = $value[Configuration::get('PS_LANG_DEFAULT')];
else
$value = '';
}
// Format field value
$fields[$field] = ObjectModel::formatValue($value, $data['type']);
}
return $fields;
}
/**
* Format a data
*
* @param mixed $value
* @param int $type
*/
public static function formatValue($value, $type, $with_quotes = false)
{
switch ($type)
{
case self::TYPE_INT :
return (int)$value;
case self::TYPE_BOOL :
return (int)$value;
case self::TYPE_FLOAT :
return (float)$value;
case self::TYPE_DATE :
if (!$value)
return '0000-00-00';
if ($with_quotes)
return '\''.pSQL($value).'\'';
return pSQL($value);
case self::TYPE_HTML :
if ($with_quotes)
return '\''.pSQL($value, true).'\'';
return pSQL($value, true);
case self::TYPE_NOTHING :
return $value;
case self::TYPE_STRING :
default :
if ($with_quotes)
return '\''.pSQL($value).'\'';
return pSQL($value);
}
}
/**
* Save current object to database (add or update)
*
* @param bool $null_values
* @param bool $autodate
* @return boolean Insertion result
*/
public function save($null_values = false, $autodate = true)
{
return (int)$this->id > 0 ? $this->update($null_values) : $this->add($autodate, $null_values);
}
/**
* Add current object to database
*
* @param bool $null_values
* @param bool $autodate
* @return boolean Insertion result
*/
public function add($autodate = true, $null_values = false)
{
if (!ObjectModel::$db)
ObjectModel::$db = Db::getInstance();
// @hook actionObject*AddBefore
Hook::exec('actionObjectAddBefore', array('object' => $this));
Hook::exec('actionObject'.get_class($this).'AddBefore', array('object' => $this));
// Automatically fill dates
if ($autodate && property_exists($this, 'date_add'))
$this->date_add = date('Y-m-d H:i:s');
if ($autodate && property_exists($this, 'date_upd'))
$this->date_upd = date('Y-m-d H:i:s');
if (Shop::isTableAssociated($this->def['table']))
{
$id_shop_list = Shop::getContextListShopID();
if (count($this->id_shop_list) > 0)
$id_shop_list = $this->id_shop_list;
}
// Database insertion
if (isset($this->id) && !Tools::getValue('forceIDs'))
unset($this->id);
if (Shop::checkIdShopDefault($this->def['table']))
$this->id_shop_default = min($id_shop_list);
if (!$result = ObjectModel::$db->insert($this->def['table'], $this->getFields(), $null_values))
return false;
// Get object id in database
$this->id = ObjectModel::$db->Insert_ID();
// Database insertion for multishop fields related to the object
if (Shop::isTableAssociated($this->def['table']))
{
$fields = $this->getFieldsShop();
$fields[$this->def['primary']] = (int)$this->id;
foreach ($id_shop_list as $id_shop)
{
$fields['id_shop'] = (int)$id_shop;
$result &= ObjectModel::$db->insert($this->def['table'].'_shop', $fields, $null_values);
}
}
if (!$result)
return false;
// Database insertion for multilingual fields related to the object
if (!empty($this->def['multilang']))
{
$fields = $this->getFieldsLang();
if ($fields && is_array($fields))
{
$shops = Shop::getCompleteListOfShopsID();
$asso = Shop::getAssoTable($this->def['table'].'_lang');
foreach ($fields as $field)
{
foreach (array_keys($field) as $key)
if (!Validate::isTableOrIdentifier($key))
throw new PrestaShopException('key '.$key.' is not table or identifier, ');
$field[$this->def['primary']] = (int)$this->id;
if ($asso !== false && $asso['type'] == 'fk_shop')
{
foreach ($shops as $id_shop)
{
$field['id_shop'] = (int)$id_shop;
$result &= ObjectModel::$db->insert($this->def['table'].'_lang', $field);
}
}
else
$result &= ObjectModel::$db->insert($this->def['table'].'_lang', $field);
}
}
}
// @hook actionObject*AddAfter
Hook::exec('actionObjectAddAfter', array('object' => $this));
Hook::exec('actionObject'.get_class($this).'AddAfter', array('object' => $this));
return $result;
}
/**
* Duplicate current object to database
*
* @return new object
*/
public function duplicateObject()
{
$definition = ObjectModel::getDefinition($this);
$res = Db::getInstance()->getRow('
SELECT *
FROM `'._DB_PREFIX_.bqSQL($definition['table']).'`
WHERE `'.bqSQL($definition['primary']).'` = '.(int)$this->id
);
if (!$res)
return false;
unset($res[$definition['primary']]);
if (!Db::getInstance()->insert($definition['table'], $res))
return false;
$object_id = Db::getInstance()->Insert_ID();
if ($definition['multilang'])
{
$res = Db::getInstance()->executeS('
SELECT *
FROM `'._DB_PREFIX_.bqSQL($definition['table']).'_lang`
WHERE `'.bqSQL($definition['primary']).'` = '.(int)$this->id
);
if (!$res)
return false;
foreach ($res as $row)
{
$row[$definition['primary']] = (int)$object_id;
if (!Db::getInstance()->insert($definition['table'].'_lang', $row))
return false;
}
}
$object_duplicated = new $definition['classname']((int)$object_id);
$object_duplicated->duplicateShops((int)$this->id);
return $object_duplicated;
}
/**
* Update current object to database
*
* @param bool $null_values
* @return boolean Update result
*/
public function update($null_values = false)
{
if (!ObjectModel::$db)
ObjectModel::$db = Db::getInstance();
// @hook actionObject*UpdateBefore
Hook::exec('actionObjectUpdateBefore', array('object' => $this));
Hook::exec('actionObject'.get_class($this).'UpdateBefore', array('object' => $this));
$this->clearCache();
// Automatically fill dates
if (array_key_exists('date_upd', $this))
$this->date_upd = date('Y-m-d H:i:s');
$id_shop_list = Shop::getContextListShopID();
if (count($this->id_shop_list) > 0)
$id_shop_list = $this->id_shop_list;
if (Shop::checkIdShopDefault($this->def['table']) && !$this->id_shop_default)
$this->id_shop_default = min($id_shop_list);
// Database update
if (!$result = ObjectModel::$db->update($this->def['table'], $this->getFields(), '`'.pSQL($this->def['primary']).'` = '.(int)$this->id, 0, $null_values))
return false;
// Database insertion for multishop fields related to the object
if (Shop::isTableAssociated($this->def['table']))
{
$fields = $this->getFieldsShop();
$fields[$this->def['primary']] = (int)$this->id;
if (is_array($this->update_fields))
{
$update_fields = $this->update_fields;
$this->update_fields = null;
$all_fields = $this->getFieldsShop();
$all_fields[$this->def['primary']] = (int)$this->id;
$this->update_fields = $update_fields;
}
else
$all_fields = $fields;
foreach ($id_shop_list as $id_shop)
{
$fields['id_shop'] = (int)$id_shop;
$all_fields['id_shop'] = (int)$id_shop;
$where = $this->def['primary'].' = '.(int)$this->id.' AND id_shop = '.(int)$id_shop;
// A little explanation of what we do here : we want to create multishop entry when update is called, but
// only if we are in a shop context (if we are in all context, we just want to update entries that alread exists)
$shop_exists = ObjectModel::$db->getValue('SELECT '.$this->def['primary'].' FROM '._DB_PREFIX_.$this->def['table'].'_shop WHERE '.$where);
if ($shop_exists)
$result &= ObjectModel::$db->update($this->def['table'].'_shop', $fields, $where, 0, $null_values);
else if (Shop::getContext() == Shop::CONTEXT_SHOP)
$result &= ObjectModel::$db->insert($this->def['table'].'_shop', $all_fields, $null_values);
}
}
// Database update for multilingual fields related to the object
if (isset($this->def['multilang']) && $this->def['multilang'])
{
$fields = $this->getFieldsLang();
if (is_array($fields))
{
foreach ($fields as $field)
{
foreach (array_keys($field) as $key)
if (!Validate::isTableOrIdentifier($key))
throw new PrestaShopException('key '.$key.' is not a valid table or identifier');
// If this table is linked to multishop system, update / insert for all shops from context
if ($this->isLangMultishop())
{
$id_shop_list = Shop::getContextListShopID();
if (count($this->id_shop_list) > 0)
$id_shop_list = $this->id_shop_list;
foreach ($id_shop_list as $id_shop)
{
$field['id_shop'] = (int)$id_shop;
$where = pSQL($this->def['primary']).' = '.(int)$this->id
.' AND id_lang = '.(int)$field['id_lang']
.' AND id_shop = '.(int)$id_shop;
if (ObjectModel::$db->getValue('SELECT COUNT(*) FROM '.pSQL(_DB_PREFIX_.$this->def['table']).'_lang WHERE '.$where))
$result &= ObjectModel::$db->update($this->def['table'].'_lang', $field, $where);
else
$result &= ObjectModel::$db->insert($this->def['table'].'_lang', $field);
}
}
// If this table is not linked to multishop system ...
else
{
$where = pSQL($this->def['primary']).' = '.(int)$this->id
.' AND id_lang = '.(int)$field['id_lang'];
if (Db::getInstance()->getValue('SELECT COUNT(*) FROM '.pSQL(_DB_PREFIX_.$this->def['table']).'_lang WHERE '.$where))
$result &= ObjectModel::$db->update($this->def['table'].'_lang', $field, $where);
else
$result &= ObjectModel::$db->insert($this->def['table'].'_lang', $field, $null_values);
}
}
}
}
// @hook actionObject*UpdateAfter
Hook::exec('actionObjectUpdateAfter', array('object' => $this));
Hook::exec('actionObject'.get_class($this).'UpdateAfter', array('object' => $this));
return $result;
}
/**
* Delete current object from database
*
* @return boolean Deletion result
*/
public function delete()
{
if (!ObjectModel::$db)
ObjectModel::$db = Db::getInstance();
// @hook actionObject*DeleteBefore
Hook::exec('actionObjectDeleteBefore', array('object' => $this));
Hook::exec('actionObject'.get_class($this).'DeleteBefore', array('object' => $this));
$this->clearCache();
$result = true;
// Remove association to multishop table
if (Shop::isTableAssociated($this->def['table']))
{
$id_shop_list = Shop::getContextListShopID();
if (count($this->id_shop_list))
$id_shop_list = $this->id_shop_list;
$result &= ObjectModel::$db->delete($this->def['table'].'_shop', '`'.$this->def['primary'].'`='.(int)$this->id.' AND id_shop IN ('.implode(', ', $id_shop_list).')');
}
// Database deletion
$has_multishop_entries = $this->hasMultishopEntries();
if ($result && !$has_multishop_entries)
$result &= ObjectModel::$db->delete($this->def['table'], '`'.pSQL($this->def['primary']).'` = '.(int)$this->id);
if (!$result)
return false;
// Database deletion for multilingual fields related to the object
if (!empty($this->def['multilang']) && !$has_multishop_entries)
$result &= ObjectModel::$db->delete($this->def['table'].'_lang', '`'.pSQL($this->def['primary']).'` = '.(int)$this->id);
// @hook actionObject*DeleteAfter
Hook::exec('actionObjectDeleteAfter', array('object' => $this));
Hook::exec('actionObject'.get_class($this).'DeleteAfter', array('object' => $this));
return $result;
}
/**
* Delete several objects from database
*
* @param array $selection
* @return bool Deletion result
*/
public function deleteSelection($selection)
{
$result = true;
foreach ($selection as $id)
{
$this->id = (int)$id;
$result = $result && $this->delete();
}
return $result;
}
/**
* Toggle object status in database
*
* @return boolean Update result
*/
public function toggleStatus()
{
// Object must have a variable called 'active'
if (!array_key_exists('active', $this))
throw new PrestaShopException('property "active" is missing in object '.get_class($this));
// Update active status on object
$this->active = !(int)$this->active;
// Change status to active/inactive
return $this->update(false);
}
/**
* @deprecated 1.5.0 (use getFieldsLang())
*/
protected function getTranslationsFields($fields_array)
{
$fields = array();
if ($this->id_lang == null)
foreach (Language::getLanguages(false) as $language)
$this->makeTranslationFields($fields, $fields_array, $language['id_lang']);
else
$this->makeTranslationFields($fields, $fields_array, $this->id_lang);
return $fields;
}
/**
* @deprecated 1.5.0
*/
protected function makeTranslationFields(&$fields, &$fields_array, $id_language)
{
$fields[$id_language]['id_lang'] = $id_language;
$fields[$id_language][$this->def['primary']] = (int)$this->id;
if ($this->id_shop && $this->isLangMultishop())
$fields[$id_language]['id_shop'] = (int)$this->id_shop;
foreach ($fields_array as $k => $field)
{
$html = false;
$field_name = $field;
if (is_array($field))
{
$field_name = $k;
$html = (isset($field['html'])) ? $field['html'] : false;
}
/* Check fields validity */
if (!Validate::isTableOrIdentifier($field_name))
throw new PrestaShopException('identifier is not table or identifier : '.$field_name);
// Copy the field, or the default language field if it's both required and empty
if ((!$this->id_lang && isset($this->{$field_name}[$id_language]) && !empty($this->{$field_name}[$id_language]))
|| ($this->id_lang && isset($this->$field_name) && !empty($this->$field_name)))
$fields[$id_language][$field_name] = $this->id_lang ? pSQL($this->$field_name, $html) : pSQL($this->{$field_name}[$id_language], $html);
else if (in_array($field_name, $this->fieldsRequiredLang))
$fields[$id_language][$field_name] = pSQL($this->id_lang ? $this->$field_name : $this->{$field_name}[Configuration::get('PS_LANG_DEFAULT')], $html);
else
$fields[$id_language][$field_name] = '';
}
}
/**
* Check for fields validity before database interaction
*
* @param bool $die
* @param bool $error_return
* @return bool|string
*/
public function validateFields($die = true, $error_return = false)
{
foreach ($this->def['fields'] as $field => $data)
{
if (!empty($data['lang']))
continue;
if (is_array($this->update_fields) && empty($this->update_fields[$field]))
continue;
$message = $this->validateField($field, $this->$field);
if ($message !== true)
{
if ($die)
throw new PrestaShopException($message);
return $error_return ? $message : false;
}
}
return true;
}
/**
* Check for multilingual fields validity before database interaction
*
* @param bool $die
* @param bool $error_return
* @return bool|string
*/
public function validateFieldsLang($die = true, $error_return = false)
{
foreach ($this->def['fields'] as $field => $data)
{
if (empty($data['lang']))
continue;
$values = $this->$field;
if (!is_array($values))
$values = array($this->id_lang => $values);
foreach ($values as $id_lang => $value)
{
if (is_array($this->update_fields) && empty($this->update_fields[$field][$id_lang]))
continue;
$message = $this->validateField($field, $value, $id_lang);
if ($message !== true)
{
if ($die)
throw new PrestaShopException($message);
return $error_return ? $message : false;
}
}
}
return true;
}
/**
* Validate a single field
*
* @since 1.5.0
* @param string $field Field name
* @param mixed $value Field value
* @param int $id_lang
* @return bool|string
*/
public function validateField($field, $value, $id_lang = null)
{
$data = $this->def['fields'][$field];
// Check if field is required
$required_fields = (isset(self::$fieldsRequiredDatabase[get_class($this)])) ? self::$fieldsRequiredDatabase[get_class($this)] : array();
if (!$id_lang || $id_lang == Configuration::get('PS_LANG_DEFAULT'))
if (!empty($data['required']) || in_array($field, $required_fields))
if (Tools::isEmpty($value))
return 'Property '.get_class($this).'->'.$field.' is empty';
// Default value
if (!$value && !empty($data['default']))
{
$value = $data['default'];
$this->$field = $value;
}
// Check field values
if (!empty($data['values']) && is_array($data['values']) && !in_array($value, $data['values']))
return 'Property '.get_class($this).'->'.$field.' has bad value (allowed values are: '.implode(', ', $data['values']).')';
// Check field size
if (!empty($data['size']))
{
$size = $data['size'];
if (!is_array($data['size']))
$size = array('min' => 0, 'max' => $data['size']);
$length = Tools::strlen($value);
if ($length < $size['min'] || $length > $size['max'])
return 'Property '.get_class($this).'->'.$field.' length ('.$length.') must be between '.$size['min'].' and '.$size['max'];
}
// Check field validator
if (!empty($data['validate']))
{
if (!method_exists('Validate', $data['validate']))
throw new PrestaShopException('Validation function not found. '.$data['validate']);
if (!empty($value) && !call_user_func(array('Validate', $data['validate']), $value))
return 'Property '.get_class($this).'->'.$field.' is not valid';
}
return true;
}
public static function displayFieldName($field, $class = __CLASS__, $htmlentities = true, Context $context = null)
{
global $_FIELDS;
if (file_exists(_PS_TRANSLATIONS_DIR_.Context::getContext()->language->iso_code.'/fields.php'))
include(_PS_TRANSLATIONS_DIR_.Context::getContext()->language->iso_code.'/fields.php');
$key = $class.'_'.md5($field);
return ((is_array($_FIELDS) && array_key_exists($key, $_FIELDS)) ? ($htmlentities ? htmlentities($_FIELDS[$key], ENT_QUOTES, 'utf-8') : $_FIELDS[$key]) : $field);
}
/**
* TODO: refactor rename all calls to this to validateController
* @deprecated since 1.5 use validateController instead
*/
public function validateControler($htmlentities = true)
{
Tools::displayAsDeprecated();
return $this->validateController($htmlentities);
}
public function validateController($htmlentities = true)
{
$errors = array();
$required_fields_database = (isset(self::$fieldsRequiredDatabase[get_class($this)])) ? self::$fieldsRequiredDatabase[get_class($this)] : array();
foreach ($this->def['fields'] as $field => $data)
{
// Check if field is required by user
if (in_array($field, $required_fields_database))
$data['required'] = true;
// Checking for required fields
if (isset($data['required']) && $data['required'] && ($value = Tools::getValue($field, $this->{$field})) == false && (string)$value != '0')
if (!$this->id || $field != 'passwd')
$errors[] = '<b>'.self::displayFieldName($field, get_class($this), $htmlentities).'</b> '.Tools::displayError('is required.');
// Checking for maximum fields sizes
if (isset($data['size']) && ($value = Tools::getValue($field, $this->{$field})) && Tools::strlen($value) > $data['size'])
$errors[] = sprintf(
Tools::displayError('%1$s is too long. Maximum length: %2$d'),
self::displayFieldName($field, get_class($this), $htmlentities),
$data['size']
);
// Checking for fields validity
// Hack for postcode required for country which does not have postcodes
if (($value = Tools::getValue($field, $this->{$field})) || ($field == 'postcode' && $value == '0'))
{
if (isset($data['validate']) && !Validate::$data['validate']($value) && (!empty($value) || $data['required']))
$errors[] = '<b>'.self::displayFieldName($field, get_class($this), $htmlentities).'</b> '.Tools::displayError('is invalid.');
else
{
if (isset($data['copy_post']) && !$data['copy_post'])
continue;
if ($field == 'passwd')
{
if ($value = Tools::getValue($field))
$this->{$field} = Tools::encrypt($value);
}
else
$this->{$field} = $value;
}
}
}