- Class name: HookCore
- Parent class: ObjectModel
- Source: classes/Hook.php line 27
- $_hook_modules_cache
- $_hook_modules_cache_exec
- $definition
- $description
- $executed_hooks
- $live_edit
- $name
- $position
- $title
- $db
- $def
- $fieldsRequired
- $fieldsRequiredDatabase
- $fieldsRequiredLang
- $fieldsSize
- $fieldsSizeLang
- $fieldsValidate
- $fieldsValidateLang
- $get_shop_from_context
- $id
- $id_lang
- $id_shop
- $id_shop_list
- $identifier
- $image_dir
- $image_format
- $table
- $tables
- $update_fields
- $webserviceParameters
- PDFInvoice
- __construct
- add
- addFieldsRequiredDatabase
- addProduct
- associateTo
- backBeforePayment
- clearCache
- delete
- deleteImage
- deleteProduct
- deleteSelection
- displayFieldName
- duplicateObject
- duplicateShops
- exec
- existsInDatabase
- formatFields
- formatValue
- get
- getAssociatedShops
- getDefinition
- getFieldByLang
- getFields
- getFieldsLang
- getFieldsRequiredDatabase
- getFieldsShop
- getHookAliasList
- getHookModuleExecList
- getHookModuleList
- getHooks
- getIdByName
- getModulesFromHook
- getRetroHookName
- getTranslationsFields
- getValidationRules
- getWebserviceObjectList
- getWebserviceParameters
- hasMultishopEntries
- hydrate
- hydrateCollection
- isAssociatedToShop
- isCurrentlyUsed
- isLangMultishop
- isMultishop
- makeTranslationFields
- newOrder
- orderConfirmation
- paymentReturn
- postUpdateOrderStatus
- preloadHookModulesCache
- productFooter
- productOutOfStock
- save
- setDefinitionRetrocompatibility
- setFieldsToUpdate
- toggleStatus
- update
- updateCarrier
- updateMultishopTable
- updateOrderStatus
- updateProduct
- updateProductAttribute
- updateQuantity
- validateControler
- validateController
- validateField
- validateFields
- validateFieldsLang
- validateFieldsRequiredDatabase
- wrapLiveEdit
protected mixed $_hook_modules_cache = null
- Visibility: protected
- This property is static.
- Source: classes/Hook.php line 77.
protected mixed $_hook_modules_cache_exec = null
- Visibility: protected
- This property is static.
- Source: classes/Hook.php line 82.
public mixed $definition = array('table' => 'hook', 'primary' => 'id_hook', 'fields' => array('name' => array('type' => self::TYPE_STRING, 'validate' => 'isHookName', 'required' => true, 'size' => 64), 'title' => array('type' => self::TYPE_STRING), 'description' => array('type' => self::TYPE_HTML), 'position' => array('type' => self::TYPE_BOOL), 'live_edit' => array('type' => self::TYPE_BOOL)))
- Visibility: public
- This property is static.
- Source: classes/Hook.php line 62.
public string $description
- Visibility: public
- Source: classes/Hook.php line 42.
public array $executed_hooks = array()
- Visibility: public
- This property is static.
- Source: classes/Hook.php line 57.
public boolean $live_edit = false
- Visibility: public
- Source: classes/Hook.php line 52.
public string $name
- Visibility: public
- Source: classes/Hook.php line 32.
public boolean $position = false
- Visibility: public
- Source: classes/Hook.php line 47.
public string $title
- Visibility: public
- Source: classes/Hook.php line 37.
protected \Db $db = false
- Visibility: protected
- This property is static.
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 140.
protected array $def
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 130.
protected mixed $fieldsRequired = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 80.
protected mixed $fieldsRequiredDatabase = null
- Visibility: protected
- This property is static.
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 65.
protected mixed $fieldsRequiredLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 95.
protected mixed $fieldsSize = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 85.
protected mixed $fieldsSizeLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 100.
protected mixed $fieldsValidate = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 90.
protected mixed $fieldsValidateLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 105.
protected mixed $get_shop_from_context = true
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 63.
public integer $id
- Visibility: public
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 54.
protected integer $id_lang = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 57.
protected mixed $id_shop = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 59.
public mixed $id_shop_list = null
- Visibility: public
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 61.
protected mixed $identifier
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 75.
protected string $image_dir = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 116.
protected string $image_format = 'jpg'
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 119.
protected mixed $table
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 70.
protected mixed $tables = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 110.
protected array $update_fields = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 135.
protected array $webserviceParameters = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 113.
mixed HookCore::PDFInvoice($pdf, $id_order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 540
- $pdf mixed
- $id_order mixed
mixed ObjectModelCore::__construct(integer $id, integer $id_lang, integer $id_shop)
Build object
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 168
- $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
mixed HookCore::add($autodate, $null_values)
- Visibility: public
- Source: classes/Hook.php line 84
- $autodate mixed
- $null_values mixed
mixed ObjectModelCore::addFieldsRequiredDatabase($fields)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1146
- $fields mixed
mixed HookCore::addProduct($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 657
- $product mixed
boolean ObjectModelCore::associateTo(integer|array $id_shops)
This function associate an item to its context
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1193
- $id_shops integer|array
mixed HookCore::backBeforePayment($module)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 551
- $module mixed
mixed ObjectModelCore::clearCache($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1160
- $all mixed
boolean ObjectModelCore::delete()
Delete current object from database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 691
boolean ObjectModelCore::deleteImage($force_delete)
Delete images associated with the object
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1319
- $force_delete mixed
mixed HookCore::deleteProduct($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 675
- $product mixed
boolean ObjectModelCore::deleteSelection(array $selection)
Delete several objects from database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 737
- $selection array
mixed ObjectModelCore::displayFieldName($field, $class, $htmlentities, \Context $context)
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 939
- $field mixed
- $class mixed
- $htmlentities mixed
- $context Context
\new ObjectModelCore::duplicateObject()
Duplicate current object to database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 528
mixed ObjectModelCore::duplicateShops($id)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1237
- $id mixed
string HookCore::exec(string $hook_name, array $hook_args, integer $id_module, $array_return, $check_exceptions)
Execute modules for specified hook
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 354
- $hook_name string - Hook Name
- $hook_args array - Parameters for the functions
- $id_module integer - Execute hook for this module only
- $array_return mixed
- $check_exceptions mixed
boolean ObjectModelCore::existsInDatabase(integer $id_entity, string $table)
Specify if an ObjectModel is already in database
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1356
- $id_entity integer
- $table string
array ObjectModelCore::formatFields(integer $type, integer $id_lang)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 335
- $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)
Format a data
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 381
- $value mixed
- $type integer
- $with_quotes mixed
integer HookCore::get(string $hookName)
Return hook ID from name
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 596
- $hookName string - Hook name
array ObjectModelCore::getAssociatedShops()
Get the list of associated id_shop
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1222
array ObjectModelCore::getDefinition(string $class, string $field)
Get object definition
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1462
- $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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1569
- $field_name mixed
- $id_lang null
array ObjectModelCore::getFields()
Prepare fields for ObjectModel class (add, update) All fields are verified (pSQL, intval.
..)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 263
array ObjectModelCore::getFieldsLang()
Prepare multilang fields
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 300
mixed ObjectModelCore::getFieldsRequiredDatabase($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1138
- $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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 286
array HookCore::getHookAliasList()
Get list of hook alias
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 137
array HookCore::getHookModuleExecList(string $hook_name)
Get list of modules we can execute per hook
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 240
- $hook_name string - Get list of modules for this hook if given
array HookCore::getHookModuleList()
Get list of all registered hooks with modules
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 177
array HookCore::getHooks(boolean $position)
Return Hooks List
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 96
- $position boolean
integer HookCore::getIdByName(string $hook_name)
Return hook ID from name
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 111
- $hook_name string - Hook name
array HookCore::getModulesFromHook(integer $id_hook, integer $id_module)
Return Hooks List
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 223
- $id_hook integer
- $id_module integer
integer HookCore::getRetroHookName(string $hook_name)
Return retrocompatible hook name
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 159
- $hook_name string - Hook name
mixed ObjectModelCore::getTranslationsFields($fields_array)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 769
- $fields_array mixed
array ObjectModelCore::getValidationRules(string $class)
Returns object validation rules (fields validity)
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 148
- $class string - Child class name for static use (optional)
mixed ObjectModelCore::getWebserviceObjectList($sql_join, $sql_filter, $sql_sort, $sql_limit)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1080
- $sql_join mixed
- $sql_filter mixed
- $sql_sort mixed
- $sql_limit mixed
mixed ObjectModelCore::getWebserviceParameters($ws_params_attribute_name)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1006
- $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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1262
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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1394
- $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.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1413
- $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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1175
- $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.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1374
- $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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1274
mixed ObjectModelCore::isMultishop()
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1269
mixed ObjectModelCore::makeTranslationFields($fields, $fields_array, $id_language)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 785
- $fields mixed
- $fields_array mixed
- $id_language mixed
mixed HookCore::newOrder($cart, $order, $customer, $currency, $orderStatus)
Called when quantity of a product is updated.
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 616
- $cart mixed
- $order mixed
- $customer mixed
- $currency mixed
- $orderStatus mixed
mixed HookCore::orderConfirmation($id_order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 488
- $id_order mixed
mixed HookCore::paymentReturn($id_order, $id_module)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 514
- $id_order mixed
- $id_module mixed
mixed HookCore::postUpdateOrderStatus($newOrderStatusId, $id_order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 476
- $newOrderStatusId mixed
- $id_order mixed
boolean HookCore::preloadHookModulesCache()
Preload hook modules cache
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 577
mixed HookCore::productFooter($product, $category)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 639
- $product mixed
- $category mixed
mixed HookCore::productOutOfStock($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 648
- $product mixed
boolean ObjectModelCore::save(boolean $null_values, boolean $autodate)
Save current object to database (add or update)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 425
- $null_values boolean
- $autodate boolean
mixed ObjectModelCore::setDefinitionRetrocompatibility()
Retrocompatibility for classes without $definition static Remove this in 1.6 !
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1500
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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1595
- $fields array
boolean ObjectModelCore::toggleStatus()
Toggle object status in database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 753
boolean ObjectModelCore::update(boolean $null_values)
Update current object to database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 577
- $null_values boolean
mixed HookCore::updateCarrier($id_carrier, $carrier)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 563
- $id_carrier mixed
- $carrier mixed
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.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1289
- $classname string
- $data array
- $where string
- $specific_where string - Only executed for common table
mixed HookCore::updateOrderStatus($newOrderStatusId, $id_order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 462
- $newOrderStatusId mixed
- $id_order mixed
mixed HookCore::updateProduct($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 666
- $product mixed
mixed HookCore::updateProductAttribute($id_product_attribute)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 684
- $id_product_attribute mixed
mixed HookCore::updateQuantity($product, $order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 630
- $product mixed
- $order mixed
mixed ObjectModelCore::validateControler($htmlentities)
TODO: refactor rename all calls to this to validateController
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 954
- $htmlentities mixed
mixed ObjectModelCore::validateController($htmlentities)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 960
- $htmlentities mixed
boolean|string ObjectModelCore::validateField(string $field, mixed $value, integer $id_lang)
Validate a single field
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 892
- $field string - Field name
- $value mixed - Field value
- $id_lang integer
boolean|string ObjectModelCore::validateFields(boolean $die, boolean $error_return)
Check for fields validity before database interaction
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 823
- $die boolean
- $error_return boolean
boolean|string ObjectModelCore::validateFieldsLang(boolean $die, boolean $error_return)
Check for multilingual fields validity before database interaction
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 852
- $die boolean
- $error_return boolean
mixed ObjectModelCore::validateFieldsRequiredDatabase($htmlentities)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1116
- $htmlentities mixed
mixed HookCore::wrapLiveEdit($display, $moduleInstance, $id_hook)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 443
- $display mixed
- $moduleInstance mixed
- $id_hook mixed