{

/**

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;

const TYPE_SQL = 8;

/**

const FORMAT_COMMON = 1;

const FORMAT_LANG = 2;

const FORMAT_SHOP = 3;

/**

const HAS_ONE = 1;

const HAS_MANY = 2;

/** @var int Object ID */

public $id;

/** @var int Language ID */

protected $id_lang = null;

/** @var int Shop ID */

protected $id_shop = null;

/** @var array|null List of shop IDs */

public $id_shop_list = null;

/** @var bool */

protected $get_shop_from_context = true;

/** @var array|null Holds required fields for each ObjectModel class */

protected static $fieldsRequiredDatabase = null;

/**

protected $table;

/**

protected $identifier;

/**

protected $fieldsRequired = array();

/**

protected $fieldsSize = array();

/**

protected $fieldsValidate = array();

/**

protected $fieldsRequiredLang = array();

/**

protected $fieldsSizeLang = array();

/**

protected $fieldsValidateLang = array();

/**

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. */

protected $image_format = 'jpg';

/**

public static $definition = array();

/**

protected static $loaded_classes = array();

/** @var array Contains current object definition. */

protected $def;

/** @var array|null 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 times. */

protected static $db = false;

/** @var bool Enables to define an ID before adding object. */

public $force_id = false;

/**

protected static $cache_objects = true;

public static function getRepositoryClassName()

{

return null;

}

/**

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,

);

}

/**

public function __construct($id = null, $id_lang = null, $id_shop = null)

{

$class_name = get_class($this);

if (!isset(ObjectModel::$loaded_classes[$class_name])) {

$this->def = ObjectModel::getDefinition($class_name);

$this->setDefinitionRetrocompatibility();

if (!Validate::isTableOrIdentifier($this->def['primary']) || !Validate::isTableOrIdentifier($this->def['table'])) {

throw new PrestaShopException('Identifier or table format not valid for class '.$class_name);

}

ObjectModel::$loaded_classes[$class_name] = get_object_vars($this);

} else {

foreach (ObjectModel::$loaded_classes[$class_name] as $key => $value) {

$this->{$key} = $value;

}

}

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 ($id) {

$entity_mapper = Adapter_ServiceLocator::get("Adapter_EntityMapper");

$entity_mapper->load($id, $id_lang, $this, $this->def, $this->id_shop, self::$cache_objects);

}

}

/**

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;

}

/**

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;

}

/**

public function getFieldsLang()

{

// Backward compatibility

if (method_exists($this, 'getTranslationsFieldsChild')) {

return $this->getTranslationsFieldsChild();

}

$this->validateFieldsLang();

$is_lang_multishop = $this->isLangMultishop();

$fields = array();

if ($this->id_lang === null) {

foreach (Language::getIDs(false) as $id_lang) {

$fields[$id_lang] = $this->formatFields(self::FORMAT_LANG, $id_lang);

$fields[$id_lang]['id_lang'] = $id_lang;

if ($this->id_shop && $is_lang_multishop) {

$fields[$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;

}

/**

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']) && $data['shop'] != 'both') || !empty($data['lang'])))) {

continue;

}

if (is_array($this->update_fields)) {

if ((!empty($data['lang']) || (!empty($data['shop']) && $data['shop'] != 'both')) && (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];

} elseif (!empty($data['required'])) {

$value = $value[Configuration::get('PS_LANG_DEFAULT')];

} else {

$value = '';

}

}

$purify = (isset($data['validate']) && Tools::strtolower($data['validate']) == 'iscleanhtml') ? true : false;

// Format field value

$fields[$field] = ObjectModel::formatValue($value, $data['type'], false, $purify, !empty($data['allow_null']));

}

return $fields;

}

/**

public static function formatValue($value, $type, $with_quotes = false, $purify = true, $allow_null = false)

{

if ($allow_null && $value === null) {

return array('type' => 'sql', 'value' => 'NULL');

}

switch ($type) {

case self::TYPE_INT:

return (int)$value;

case self::TYPE_BOOL:

return (int)$value;

case self::TYPE_FLOAT:

return (float)str_replace(',', '.', $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 ($purify) {

$value = Tools::purifyHTML($value);

}

if ($with_quotes) {

return '\''.pSQL($value, true).'\'';

}

return pSQL($value, true);

case self::TYPE_SQL:

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);

}

}

/**

public function save($null_values = false, $auto_date = true)

{

return (int)$this->id > 0 ? $this->update($null_values) : $this->add($auto_date, $null_values);

}

/**

public function add($auto_date = true, $null_values = false)

{

if (isset($this->id) && !$this->force_id) {

unset($this->id);

}

// @hook actionObject*AddBefore

Hook::exec('actionObjectAddBefore', array('object' => $this));

Hook::exec('actionObject'.get_class($this).'AddBefore', array('object' => $this));

// Automatically fill dates

if ($auto_date && property_exists($this, 'date_add')) {

$this->date_add = date('Y-m-d H:i:s');

}

if ($auto_date && 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 (Shop::checkIdShopDefault($this->def['table'])) {

$this->id_shop_default = (in_array(Configuration::get('PS_SHOP_DEFAULT'), $id_shop_list) == true) ? Configuration::get('PS_SHOP_DEFAULT') : min($id_shop_list);

}

if (!$result = Db::getInstance()->insert($this->def['table'], $this->getFields(), $null_values)) {

return false;

}

// Get object id in database

$this->id = Db::getInstance()->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 &= Db::getInstance()->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 &= Db::getInstance()->insert($this->def['table'].'_lang', $field);

}

} else {

$result &= Db::getInstance()->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;

}

/**

public function duplicateObject()

{

$definition = ObjectModel::getDefinition($this);

$res = Db::getInstance()->getRow('

FROM `'._DB_PREFIX_.bqSQL($definition['table']).'`

WHERE `'.bqSQL($definition['primary']).'` = '.(int)$this->id

);

if (!$res) {

return false;

}

unset($res[$definition['primary']]);

foreach ($res as $field => &$value) {

if (isset($definition['fields'][$field])) {

$value = ObjectModel::formatValue($value, $definition['fields'][$field]['type'], false, true,

!empty($definition['fields'][$field]['allow_null']));

}

}

if (!Db::getInstance()->insert($definition['table'], $res)) {

return false;

}

$object_id = Db::getInstance()->Insert_ID();

if (isset($definition['multilang']) && $definition['multilang']) {

$result = Db::getInstance()->executeS('

FROM `'._DB_PREFIX_.bqSQL($definition['table']).'_lang`

WHERE `'.bqSQL($definition['primary']).'` = '.(int)$this->id);

if (!$result) {

return false;

}

foreach ($result as &$row) {

foreach ($row as $field => &$value) {

if (isset($definition['fields'][$field])) {

$value = ObjectModel::formatValue($value, $definition['fields'][$field]['type'], false, true,

!empty($definition['fields'][$field]['allow_null']));

}

}

}

// Keep $row2, you cannot use $row because there is an unexplicated conflict with the previous usage of this variable

foreach ($result as $row2) {

$row2[$definition['primary']] = (int)$object_id;

if (!Db::getInstance()->insert($definition['table'].'_lang', $row2)) {

return false;

}

}

}

/** @var ObjectModel $object_duplicated */

$object_duplicated = new $definition['classname']((int)$object_id);

$object_duplicated->duplicateShops((int)$this->id);

return $object_duplicated;

}

/**

public function update($null_values = false)

{

// @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');

if (isset($this->update_fields) && is_array($this->update_fields) && count($this->update_fields)) {

$this->update_fields['date_upd'] = true;

}

}

// Automatically fill dates

if (array_key_exists('date_add', $this) && $this->date_add == null) {

$this->date_add = date('Y-m-d H:i:s');

if (isset($this->update_fields) && is_array($this->update_fields) && count($this->update_fields)) {

$this->update_fields['date_add'] = true;

}

}

$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 = (in_array(Configuration::get('PS_SHOP_DEFAULT'), $id_shop_list) == true) ? Configuration::get('PS_SHOP_DEFAULT') : min($id_shop_list);

}

// Database update

if (!$result = Db::getInstance()->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 = Db::getInstance()->getValue('SELECT '.$this->def['primary'].' FROM '._DB_PREFIX_.$this->def['table'].'_shop WHERE '.$where);

if ($shop_exists) {

$result &= Db::getInstance()->update($this->def['table'].'_shop', $fields, $where, 0, $null_values);

} elseif (Shop::getContext() == Shop::CONTEXT_SHOP) {

$result &= Db::getInstance()->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 (Db::getInstance()->getValue('SELECT COUNT(*) FROM '.pSQL(_DB_PREFIX_.$this->def['table']).'_lang WHERE '.$where)) {

$result &= Db::getInstance()->update($this->def['table'].'_lang', $field, $where);

} else {

$result &= Db::getInstance()->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 &= Db::getInstance()->update($this->def['table'].'_lang', $field, $where);

} else {

$result &= Db::getInstance()->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;

}

/**

public function delete()

{

// @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 &= Db::getInstance()->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 &= Db::getInstance()->delete($this->def['table'], '`'.bqSQL($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 &= Db::getInstance()->delete($this->def['table'].'_lang', '`'.bqSQL($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;

}

/**

public function deleteSelection($ids)

{

$result = true;

foreach ($ids as $id) {

$this->id = (int)$id;

$result = $result && $this->delete();

}

return $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 only active field

$this->setFieldsToUpdate(array('active' => true));

// Update active status on object

$this->active = !(int)$this->active;

// Change status to active/inactive

return $this->update(false);

}

/**

protected function getTranslationsFields($fields_array)

{

$fields = array();

if ($this->id_lang == null) {

foreach (Language::getIDs(false) as $id_lang) {

$this->makeTranslationFields($fields, $fields_array, $id_lang);

}

} else {

$this->makeTranslationFields($fields, $fields_array, $this->id_lang);

}

return $fields;

}

/**

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);

} elseif (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] = '';

}

}

}

/**

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]) && isset($this->def['fields'][$field]['shop']) && $this->def['fields'][$field]['shop']) {

continue;

}

$message = $this->validateField($field, $this->$field);

if ($message !== true) {

if ($die) {

throw new PrestaShopException($message);

}

return $error_return ? $message : false;

}

}

return true;

}

/**

public function validateFieldsLang($die = true, $error_return = false)

{

foreach ($this->def['fields'] as $field => $data) {

if (empty($data['lang'])) {

continue;

}

$values = $this->$field;

// If the object has not been loaded in multilanguage, then the value is the one for the current language of the object

if (!is_array($values)) {

$values = array($this->id_lang => $values);

}

// The value for the default must always be set, so we put an empty string if it does not exists

if (!isset($values[Configuration::get('PS_LANG_DEFAULT')])) {

$values[Configuration::get('PS_LANG_DEFAULT')] = '';

}

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;

}

/**

public function validateField($field, $value, $id_lang = null, $skip = array(), $human_errors = false)

{

static $ps_lang_default = null;

static $ps_allow_html_iframe = null;

if ($ps_lang_default === null) {

$ps_lang_default = Configuration::get('PS_LANG_DEFAULT');

}

if ($ps_allow_html_iframe === null) {

$ps_allow_html_iframe = (int)Configuration::get('PS_ALLOW_HTML_IFRAME');

}

$this->cacheFieldsRequiredDatabase();

$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 == $ps_lang_default) {

if (!in_array('required', $skip) && (!empty($data['required']) || in_array($field, $required_fields))) {

if (Tools::isEmpty($value)) {