- Class name: ObjectModelCore
- This is an abstract class
- Source: classes/ObjectModel.php line 27
- FORMAT_COMMON
- FORMAT_LANG
- FORMAT_SHOP
- HAS_MANY
- HAS_ONE
- TYPE_BOOL
- TYPE_DATE
- TYPE_FLOAT
- TYPE_HTML
- TYPE_INT
- TYPE_NOTHING
- TYPE_STRING
- $db
- $def
- $definition
- $fieldsRequired
- $fieldsRequiredDatabase
- $fieldsRequiredLang
- $fieldsSize
- $fieldsSizeLang
- $fieldsValidate
- $fieldsValidateLang
- $force_id
- $get_shop_from_context
- $id
- $id_lang
- $id_shop
- $id_shop_list
- $identifier
- $image_dir
- $image_format
- $table
- $tables
- $update_fields
- $webserviceParameters
- __construct
- add
- addFieldsRequiredDatabase
- associateTo
- cacheFieldsRequiredDatabase
- clearCache
- delete
- deleteImage
- deleteSelection
- displayFieldName
- duplicateObject
- duplicateShops
- existsInDatabase
- formatFields
- formatValue
- getAssociatedShops
- getDefinition
- getFieldByLang
- getFields
- getFieldsLang
- getFieldsRequiredDatabase
- getFieldsShop
- getTranslationsFields
- getValidationRules
- getWebserviceObjectList
- getWebserviceParameters
- hasMultishopEntries
- hydrate
- hydrateCollection
- isAssociatedToShop
- isCurrentlyUsed
- isLangMultishop
- isMultiShopField
- isMultishop
- makeTranslationFields
- save
- setDefinitionRetrocompatibility
- setFieldsToUpdate
- toggleStatus
- update
- updateMultishopTable
- validateControler
- validateController
- validateField
- validateFields
- validateFieldsLang
- validateFieldsRequiredDatabase
const FORMAT_COMMON = 1
List of data to format
- Source: classes/ObjectModel.php line 43.
const FORMAT_LANG = 2
- Source: classes/ObjectModel.php line 44.
const FORMAT_SHOP = 3
- Source: classes/ObjectModel.php line 45.
const HAS_MANY = 2
- Source: classes/ObjectModel.php line 51.
const HAS_ONE = 1
List of association types
- Source: classes/ObjectModel.php line 50.
const TYPE_BOOL = 2
- Source: classes/ObjectModel.php line 33.
const TYPE_DATE = 5
- Source: classes/ObjectModel.php line 36.
const TYPE_FLOAT = 4
- Source: classes/ObjectModel.php line 35.
const TYPE_HTML = 6
- Source: classes/ObjectModel.php line 37.
const TYPE_INT = 1
List of field types
- Source: classes/ObjectModel.php line 32.
const TYPE_NOTHING = 7
- Source: classes/ObjectModel.php line 38.
const TYPE_STRING = 3
- Source: classes/ObjectModel.php line 34.
protected \Db $db = false
- Visibility: protected
- This property is static.
- Source: classes/ObjectModel.php line 140.
protected array $def
- Visibility: protected
- Source: classes/ObjectModel.php line 130.
public array $definition = array()
- Visibility: public
- This property is static.
- Source: classes/ObjectModel.php line 125.
protected mixed $fieldsRequired = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 80.
protected mixed $fieldsRequiredDatabase = null
- Visibility: protected
- This property is static.
- Source: classes/ObjectModel.php line 65.
protected mixed $fieldsRequiredLang = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 95.
protected mixed $fieldsSize = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 85.
protected mixed $fieldsSizeLang = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 100.
protected mixed $fieldsValidate = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 90.
protected mixed $fieldsValidateLang = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 105.
public \boolean, $force_id = false
- Visibility: public
- Source: classes/ObjectModel.php line 145.
protected mixed $get_shop_from_context = true
- Visibility: protected
- Source: classes/ObjectModel.php line 63.
public integer $id
- Visibility: public
- Source: classes/ObjectModel.php line 54.
protected integer $id_lang = null
- Visibility: protected
- Source: classes/ObjectModel.php line 57.
protected mixed $id_shop = null
- Visibility: protected
- Source: classes/ObjectModel.php line 59.
public mixed $id_shop_list = null
- Visibility: public
- Source: classes/ObjectModel.php line 61.
protected mixed $identifier
- Visibility: protected
- Source: classes/ObjectModel.php line 75.
protected string $image_dir = null
- Visibility: protected
- Source: classes/ObjectModel.php line 116.
protected string $image_format = 'jpg'
- Visibility: protected
- Source: classes/ObjectModel.php line 119.
protected mixed $table
- Visibility: protected
- Source: classes/ObjectModel.php line 70.
protected mixed $tables = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 110.
protected array $update_fields = null
- Visibility: protected
- Source: classes/ObjectModel.php line 135.
protected array $webserviceParameters = array()
- Visibility: protected
- Source: classes/ObjectModel.php line 113.
mixed ObjectModelCore::__construct(integer $id, integer $id_lang, integer $id_shop)
Build object
- Visibility: public
- Source: classes/ObjectModel.php line 173
- $id integer - Existing object id in order to load object (optional)
- $id_lang integer - Required if object is multilingual (optional)
- $id_shop integer - ID shop for objects with multishop on langs
boolean ObjectModelCore::add(boolean $autodate, boolean $null_values)
Add current object to database
- Visibility: public
- Source: classes/ObjectModel.php line 435
- $autodate boolean
- $null_values boolean
mixed ObjectModelCore::addFieldsRequiredDatabase($fields)
- Visibility: public
- Source: classes/ObjectModel.php line 1218
- $fields mixed
boolean ObjectModelCore::associateTo(integer|array $id_shops)
This function associate an item to its context
- Visibility: public
- Source: classes/ObjectModel.php line 1270
- $id_shops integer|array
mixed ObjectModelCore::cacheFieldsRequiredDatabase()
- Visibility: public
- Source: classes/ObjectModel.php line 1205
mixed ObjectModelCore::clearCache($all)
- Visibility: public
- Source: classes/ObjectModel.php line 1232
- $all mixed
boolean ObjectModelCore::delete()
Delete current object from database
- Visibility: public
- Source: classes/ObjectModel.php line 697
boolean ObjectModelCore::deleteImage($force_delete)
Delete images associated with the object
- Visibility: public
- Source: classes/ObjectModel.php line 1401
- $force_delete mixed
boolean ObjectModelCore::deleteSelection(array $selection)
Delete several objects from database
- Visibility: public
- Source: classes/ObjectModel.php line 743
- $selection array
mixed ObjectModelCore::displayFieldName($field, $class, $htmlentities, \Context $context)
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 988
- $field mixed
- $class mixed
- $htmlentities mixed
- $context Context
\new ObjectModelCore::duplicateObject()
Duplicate current object to database
- Visibility: public
- Source: classes/ObjectModel.php line 527
mixed ObjectModelCore::duplicateShops($id)
- Visibility: public
- Source: classes/ObjectModel.php line 1314
- $id mixed
boolean ObjectModelCore::existsInDatabase(integer $id_entity, string $table)
Specify if an ObjectModel is already in database
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 1438
- $id_entity integer
- $table string
array ObjectModelCore::formatFields(integer $type, integer $id_lang)
- Visibility: protected
- Source: classes/ObjectModel.php line 330
- $type integer - FORMAT_COMMON or FORMAT_LANG or FORMAT_SHOP
- $id_lang integer - If this parameter is given, only take lang fields
mixed ObjectModelCore::formatValue(mixed $value, integer $type, $with_quotes, $purify)
Format a data
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 377
- $value mixed
- $type integer
- $with_quotes mixed
- $purify mixed
array ObjectModelCore::getAssociatedShops()
Get the list of associated id_shop
- Visibility: public
- Source: classes/ObjectModel.php line 1299
array ObjectModelCore::getDefinition(string $class, string $field)
Get object definition
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 1544
- $class string - Name of object
- $field string - Name of field if we want the definition of one field only
mixed ObjectModelCore::getFieldByLang($field_name, null $id_lang)
Return the field value for the specified language if the field is multilang, else the field value.
- Visibility: public
- Source: classes/ObjectModel.php line 1651
- $field_name mixed
- $id_lang null
array ObjectModelCore::getFields()
Prepare fields for ObjectModel class (add, update) All fields are verified (pSQL, intval.
..)
- Visibility: public
- Source: classes/ObjectModel.php line 258
array ObjectModelCore::getFieldsLang()
Prepare multilang fields
- Visibility: public
- Source: classes/ObjectModel.php line 295
mixed ObjectModelCore::getFieldsRequiredDatabase($all)
- Visibility: public
- Source: classes/ObjectModel.php line 1197
- $all mixed
array ObjectModelCore::getFieldsShop()
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.
- Visibility: public
- Source: classes/ObjectModel.php line 281
mixed ObjectModelCore::getTranslationsFields($fields_array)
- Visibility: protected
- Source: classes/ObjectModel.php line 778
- $fields_array mixed
array ObjectModelCore::getValidationRules(string $class)
Returns object validation rules (fields validity)
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 153
- $class string - Child class name for static use (optional)
mixed ObjectModelCore::getWebserviceObjectList($sql_join, $sql_filter, $sql_sort, $sql_limit)
- Visibility: public
- Source: classes/ObjectModel.php line 1138
- $sql_join mixed
- $sql_filter mixed
- $sql_sort mixed
- $sql_limit mixed
mixed ObjectModelCore::getWebserviceParameters($ws_params_attribute_name)
- Visibility: public
- Source: classes/ObjectModel.php line 1060
- $ws_params_attribute_name mixed
boolean ObjectModelCore::hasMultishopEntries()
Check if there is more than one entries in associated shop table for current entity
- Visibility: public
- Source: classes/ObjectModel.php line 1339
mixed ObjectModelCore::hydrate(array $data, integer $id_lang)
Fill an object with given data. Data must be an array with this syntax: array(objProperty => value, objProperty2 => value, etc.)
- Visibility: public
- Source: classes/ObjectModel.php line 1476
- $data array
- $id_lang integer
array ObjectModelCore::hydrateCollection(string $class, array $datas, integer $id_lang)
Fill (hydrate) a list of objects in order to get a collection of these objects
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 1495
- $class string - Class of objects to hydrate
- $datas array - List of data (multi-dimensional array)
- $id_lang integer
boolean ObjectModelCore::isAssociatedToShop(integer $id_shop)
Check if current object is associated to a shop
- Visibility: public
- Source: classes/ObjectModel.php line 1247
- $id_shop integer
boolean ObjectModelCore::isCurrentlyUsed(string $table, boolean $has_active_column)
This method is allow to know if a entity is currently used
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 1456
- $table string - name of table linked to entity
- $has_active_column boolean - true if the table has an active column
mixed ObjectModelCore::isLangMultishop()
- Visibility: public
- Source: classes/ObjectModel.php line 1356
mixed ObjectModelCore::isMultiShopField($field)
- Visibility: public
- Source: classes/ObjectModel.php line 1351
- $field mixed
mixed ObjectModelCore::isMultishop()
- Visibility: public
- Source: classes/ObjectModel.php line 1346
mixed ObjectModelCore::makeTranslationFields($fields, $fields_array, $id_language)
- Visibility: protected
- Source: classes/ObjectModel.php line 794
- $fields mixed
- $fields_array mixed
- $id_language mixed
boolean ObjectModelCore::save(boolean $null_values, boolean $autodate)
Save current object to database (add or update)
- Visibility: public
- Source: classes/ObjectModel.php line 423
- $null_values boolean
- $autodate boolean
mixed ObjectModelCore::setDefinitionRetrocompatibility()
Retrocompatibility for classes without $definition static Remove this in 1.6 !
- Visibility: protected
- Source: classes/ObjectModel.php line 1582
mixed ObjectModelCore::setFieldsToUpdate(array $fields)
Set a list of specific fields to update array(field1 => true, field2 => false, langfield1 => array(1 => true, 2 => false))
- Visibility: public
- Source: classes/ObjectModel.php line 1677
- $fields array
boolean ObjectModelCore::toggleStatus()
Toggle object status in database
- Visibility: public
- Source: classes/ObjectModel.php line 759
boolean ObjectModelCore::update(boolean $null_values)
Update current object to database
- Visibility: public
- Source: classes/ObjectModel.php line 583
- $null_values boolean
boolean ObjectModelCore::updateMultishopTable(string $classname, array $data, string $where, string $specific_where)
Update a table and splits the common datas and the shop datas
- Visibility: public
- This method is static.
- Source: classes/ObjectModel.php line 1371
- $classname string
- $data array
- $where string
- $specific_where string - Only executed for common table
mixed ObjectModelCore::validateControler($htmlentities)
TODO: refactor rename all calls to this to validateController
- Visibility: public
- Source: classes/ObjectModel.php line 1006
- $htmlentities mixed
mixed ObjectModelCore::validateController($htmlentities)
- Visibility: public
- Source: classes/ObjectModel.php line 1012
- $htmlentities mixed
boolean|string ObjectModelCore::validateField(string $field, mixed $value, integer $id_lang, $skip, $human_errors)
Validate a single field
- Visibility: public
- Source: classes/ObjectModel.php line 905
- $field string - Field name
- $value mixed - Field value
- $id_lang integer
- $skip mixed
- $human_errors mixed
boolean|string ObjectModelCore::validateFields(boolean $die, boolean $error_return)
Check for fields validity before database interaction
- Visibility: public
- Source: classes/ObjectModel.php line 832
- $die boolean
- $error_return boolean
boolean|string ObjectModelCore::validateFieldsLang(boolean $die, boolean $error_return)
Check for multilingual fields validity before database interaction
- Visibility: public
- Source: classes/ObjectModel.php line 861
- $die boolean
- $error_return boolean
mixed ObjectModelCore::validateFieldsRequiredDatabase($htmlentities)
- Visibility: public
- Source: classes/ObjectModel.php line 1174
- $htmlentities mixed