- Class name: HookCore
- Parent class: ObjectModel
- Source: classes/Hook.php line 28
- $_hook_modules_cache
- $_hook_modules_cache_exec
- $definition
- $description
- $executed_hooks
- $live_edit
- $name
- $position
- $title
- $def
- $fieldsRequired
- $fieldsRequiredDatabase
- $fieldsRequiredLang
- $fieldsSize
- $fieldsSizeLang
- $fieldsValidate
- $fieldsValidateLang
- $id
- $id_lang
- $id_shop
- $identifier
- $image_dir
- $image_format
- $table
- $tables
- $webserviceParameters
- PDFInvoice
- __construct
- add
- addFieldsRequiredDatabase
- addProduct
- associateTo
- backBeforePayment
- clearCache
- delete
- deleteImage
- deleteProduct
- deleteSelection
- displayFieldName
- duplicateShops
- exec
- existsInDatabase
- formatFields
- formatValue
- get
- getDefinition
- getFieldByLang
- getFields
- getFieldsLang
- getFieldsRequiredDatabase
- getHookAliasList
- getHookModuleExecList
- getHookModuleList
- getHooks
- getIdByName
- getModulesFromHook
- getRetroHookName
- getTranslationsFields
- getValidationRules
- getWebserviceObjectList
- getWebserviceParameters
- hydrate
- hydrateCollection
- isAssociatedToGroupShop
- isAssociatedToShop
- isCurrentlyUsed
- isLangMultishop
- makeTranslationFields
- newOrder
- orderConfirmation
- paymentReturn
- postUpdateOrderStatus
- preloadHookModulesCache
- productFooter
- productOutOfStock
- save
- setDefinitionRetrocompatibility
- toggleStatus
- update
- updateCarrier
- updateOrderStatus
- updateProduct
- updateProductAttribute
- updateQuantity
- validateControler
- validateController
- validateField
- validateFields
- validateFieldsLang
protected mixed $_hook_modules_cache = null
- Visibility: protected
- This property is static.
- Source: classes/Hook.php line 78.
protected mixed $_hook_modules_cache_exec = null
- Visibility: protected
- This property is static.
- Source: classes/Hook.php line 83.
public mixed $definition = array('table' => 'hook', 'primary' => 'id_hook', 'fields' => array('name' => array('type' => self::TYPE_STRING, 'validate' => 'isHookName', 'required' => true, 'size' => 32), '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 63.
public string $description
- Visibility: public
- Source: classes/Hook.php line 43.
public array $executed_hooks = array()
- Visibility: public
- This property is static.
- Source: classes/Hook.php line 58.
public boolean $live_edit = false
- Visibility: public
- Source: classes/Hook.php line 53.
public string $name
- Visibility: public
- Source: classes/Hook.php line 33.
public boolean $position = false
- Visibility: public
- Source: classes/Hook.php line 48.
public string $title
- Visibility: public
- Source: classes/Hook.php line 38.
protected array $def
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 122.
protected mixed $fieldsRequired = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 72.
protected mixed $fieldsRequiredDatabase = null
- Visibility: protected
- This property is static.
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 57.
protected mixed $fieldsRequiredLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 87.
protected mixed $fieldsSize = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 77.
protected mixed $fieldsSizeLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 92.
protected mixed $fieldsValidate = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 82.
protected mixed $fieldsValidateLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 97.
public integer $id
- Visibility: public
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 48.
protected integer $id_lang = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 51.
protected mixed $id_shop = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 53.
protected mixed $identifier
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 67.
protected string $image_dir = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 108.
protected string $image_format = 'jpg'
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 111.
protected mixed $table
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 62.
protected mixed $tables = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 102.
protected array $webserviceParameters = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 105.
mixed HookCore::PDFInvoice($pdf, $id_order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 485
- $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 150
- $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
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 372
- $autodate boolean
- $null_values boolean
mixed ObjectModelCore::addFieldsRequiredDatabase($fields)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 925
- $fields mixed
mixed HookCore::addProduct($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 602
- $product mixed
boolean ObjectModelCore::associateTo(integer|array $id_shops, string $type)
This function associate an item to its context
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 973
- $id_shops integer|array
- $type string
mixed HookCore::backBeforePayment($module)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 496
- $module mixed
mixed ObjectModelCore::clearCache($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 939
- $all mixed
boolean ObjectModelCore::delete()
Delete current object from database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 521
boolean ObjectModelCore::deleteImage()
Delete images associated with the object
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1047
mixed HookCore::deleteProduct($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 620
- $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 559
- $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 757
- $field mixed
- $class mixed
- $htmlentities mixed
- $context Context
mixed ObjectModelCore::duplicateShops($id)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1017
- $id mixed
string HookCore::exec(string $hook_name, array $hookArgs, integer $id_module)
Execute modules for specified hook
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 319
- $hook_name string - Hook Name
- $hookArgs array - Parameters for the functions
- $id_module integer - Execute hook for this module only
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 1081
- $id_entity integer
- $table string
array ObjectModelCore::formatFields(integer $id_lang)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 272
- $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 319
- $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 541
- $hookName string - Hook name
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 1184
- $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 1261
- $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 234
array ObjectModelCore::getFieldsLang()
Prepare multilang fields
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 249
mixed ObjectModelCore::getFieldsRequiredDatabase($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 917
- $all mixed
array HookCore::getHookAliasList()
Get list of hook alias
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 131
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 236
- $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 171
array HookCore::getHooks(boolean $position)
Return Hooks List
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 91
- $position boolean
integer HookCore::getIdByName(string $hook_name)
Return hook ID from name
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 105
- $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 219
- $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 153
- $hook_name string - Hook name
mixed ObjectModelCore::getTranslationsFields($fields_array)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 595
- $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 130
- $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 890
- $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 816
- $ws_params_attribute_name mixed
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 1116
- $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 1135
- $class string - Class of objects to hydrate
- $datas array - List of data (multi-dimensional array)
- $id_lang integer
boolean ObjectModelCore::isAssociatedToGroupShop(integer $id_group_shop)
Check if current object is associated to a group shop
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1003
- $id_group_shop 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 954
- $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 1099
- $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 1037
mixed ObjectModelCore::makeTranslationFields($fields, $fields_array, $id_language)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 611
- $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 561
- $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 433
- $id_order mixed
mixed HookCore::paymentReturn($id_order, $id_module)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 459
- $id_order mixed
- $id_module mixed
mixed HookCore::postUpdateOrderStatus($newOrderStatusId, $id_order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 421
- $newOrderStatusId mixed
- $id_order mixed
boolean HookCore::preloadHookModulesCache()
Preload hook modules cache
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 522
mixed HookCore::productFooter($product, $category)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 584
- $product mixed
- $category mixed
mixed HookCore::productOutOfStock($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 593
- $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 360
- $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 1207
boolean ObjectModelCore::toggleStatus()
Toggle object status in database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 575
boolean ObjectModelCore::update(boolean $null_values)
Update current object to database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 446
- $null_values boolean
mixed HookCore::updateCarrier($id_carrier, $carrier)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 508
- $id_carrier mixed
- $carrier mixed
mixed HookCore::updateOrderStatus($newOrderStatusId, $id_order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 407
- $newOrderStatusId mixed
- $id_order mixed
mixed HookCore::updateProduct($product)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 611
- $product mixed
mixed HookCore::updateProductAttribute($id_product_attribute)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 629
- $id_product_attribute mixed
mixed HookCore::updateQuantity($product, $order)
- Visibility: public
- This method is static.
- Source: classes/Hook.php line 575
- $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 772
- $htmlentities mixed
mixed ObjectModelCore::validateController($htmlentities)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 778
- $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 710
- $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 649
- $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 675
- $die boolean
- $error_return boolean