Index

A

• $action_url variable
  • about / Displaying comments in a product hook
• $ajax_action_url variable
  • about / Displaying comments in a product hook
• access, to class and controller files
  • forbidding / Forbidding direct access to class and controller files
• actionAdmin{Action}After hook / The list of all the dynamic hooks
• actionAdmin{Action}Before hook / The list of all the dynamic hooks
• actionCarrierUpdate hook / Handling carrier update
• actionObject{ObjectModel}AddAfter hook / The list of all the dynamic hooks
• actionObject{ObjectModel}AddBefore hook / The list of all the dynamic hooks
• actionObject{ObjectModel}DeleteAfter hook / The list of all the dynamic hooks
• actionObject{ObjectModel}DeleteBefore hook / The list of all the dynamic hooks
• actionObject{ObjectModel}UpdateAfter hook / The list of all the dynamic hooks
• actionObject{ObjectModel}UpdateBefore hook / The list of all the dynamic hooks
• action{AdminController}{Action}After hook / The list of all the dynamic hooks
• action{AdminController}{Action}Before hook / The list of all the dynamic hooks
• addRowAction method / Adding actions on the list view
• admin controller
  • about / Adding an admin controller
  • new tab, adding to new panel / Adding and installing a new tab to your admin panel
  • new tab, installing to new panel / Adding and installing a new tab to your admin panel
  • tab, deleting when uninstalling module / Uninstalling the tab when the module is uninstalled
  • comments, listing / Listing comments in your admin controller
  • list view, improving / Improving the list view
  • actions, adding on list view / Adding actions on the list view
  • custom view template, creating / Creating your own view template
  • form view, configuring / Configuring your form view
• AdminController class / Improving the list view
  • updating / Updating the AdminController class
• ajax_hook parameter
  • about / Displaying comments in a product hook
• api_credentials_id variable / Working with a third-party API
• assignProductTabContent method / Cleaning your code using the hook's controller
• {Action} variable / Definitions of the variables
• {AdminController} variable / Definitions of the variables

B

• back office hooks
  • using / Using back office hooks
  • module, attaching to product hook / Attaching your module to a product hook
  • comments, displaying in product hook / Displaying comments in a product hook
  • comments associated with customers, displaying / Displaying comments associated with a customer
  • links, creating between admin sections / Making links between admin sections
• base64_encode method
  • about / Checking the use of base64_decode
• bindParam() method / Protecting your code against SQL injection
• bindValue() method / Protecting your code against SQL injection
• Bootstrap Star Rating jQuery plugin
  • URL / Adding CSS and JS in your module
• bqSQL() method / Protecting your code against SQL injection
• bulk_actions variable / Adding actions on the list view

C

• $confirmation variable / Making a simple configuration form
• cache system
  • using, for performance optimization / Using the cache system
• cancel_url variable / Working with a third-party API
• CarrierModule
  • about / First step to create a carrier module
• carrier module
  • creating / First step to create a carrier module
  • web services, using / Using web services
  • API description / API description
  • configuring / Module configuration
  • carriers, creating / Creating new carriers
  • web services, using on shopping cost calculation / Using web services on shipping cost calculation
  • carrier update, handling / Handling carrier update
  • relay points, displaying / Displaying relay points
  • selected relay point, associating to cart / Associating the chosen relay point with the cart
  • customer's choice, displaying in back office / Displaying the customer's choice in the back office
• Carrier object fields
  • name / Creating new carriers
  • id_tax_rules_group / Creating new carriers
  • active / Creating new carriers
  • deleted / Creating new carriers
  • delay / Creating new carriers
  • shipping_handling / Creating new carriers
  • range_behavior / Creating new carriers
  • is_module / Creating new carriers
  • shipping_external / Creating new carriers
  • external_module_name / Creating new carriers
  • need_range / Creating new carriers
• carriers
  • creating / Creating new carriers
• carrier update
  • handling / Handling carrier update
• carrier variable / Handling carrier update
• cart
  • validating, into order / Validating a cart into an order
• cart object / Looking at the Context object
• className variable / Listing comments in your admin controller
• code
  • cleaning, controller used / Cleaning your code using the hook's controller
  • reference link / Displaying relay points
  • protecting, against SQL injection / Protecting your code against SQL injection
• Combine, Compress, and Cache (CCC)
  • using, for performance optimization / Using Combine, Compress, and Cache
• comments
  • saving, database class used / Using the database class to save comments
  • displaying / Displaying comments
• compatibility check
  • about / Checking compatibilities and dependencies, The compatibility check
• Configuration**updateValue function
  • about / Making a simple configuration form
• Configuration class
  • using, with multistore / Using the Configuration class with multistore
• configuration options, PrestaShop module
  • uninstall / First steps
  • disable / First steps
  • reset / First steps
  • delete / First steps
• configure parameter
  • about / Displaying comments in a product hook
• confirm parameter / Adding actions on the list view
• Context
  • about / Looking at the Context object
  • objects / Looking at the Context object
• controller
  • used, for cleaning code / Cleaning your code using the hook's controller
• controller object / Looking at the Context object
• cookie object / Looking at the Context object
• country object / Looking at the Context object
• Create Read Update Delete (CRUD) / Adding an admin controller
• CSS
  • adding, in module / Adding CSS and JS in your module
• currency
  • checking / Checking the currency
• currency object / Looking at the Context object
• customer's choice, carrier module
  • displaying, in back office / Displaying the customer's choice in the back office
• customer object / Looking at the Context object
• custom order state
  • creating / Creating your own order state

D

• data
  • verifying, with MD5 hash / Verifying the data with MD5 hash
• database table
  • creating, on module installation / Creating a database table on module installation
  • deleting, on uninstall / Deleting a table on uninstallation
• Db**getInstance() method
  • about / Using the database class to save comments
• dependency check
  • about / Checking compatibilities and dependencies, The dependency check
• desc parameter / Creating your own view template
• displayPayment hook
  • working / Creating a payment module
• displayProductTabContent hook
  • about / Registering our module on hooks
• display type hooks
  • methods / Registering our module on hooks
• display{AdminController}Form hook / The list of all the dynamic hooks
• display{AdminController}ListAfter hook / The list of all the dynamic hooks
• display{AdminController}ListBefore hook / The list of all the dynamic hooks
• display{AdminController}Options hook / The list of all the dynamic hooks
• display{AdminController}View hook / The list of all the dynamic hooks
• dynamic hooks
  • about / The dynamic hooks

E

• e-mail
  • associating, with order state / Associating an e-mail with an order state
• employee object / Looking at the Context object
• escape method
  • reference link / Protecting your templates against XSS
• eval function
  • about / Checking the use of eval
• example code files
  • reference link / First steps
• exec function
  • about / Checking the use of system, exec, and backquotes
• execute($sqlRequest) method
  • about / Using the database class to save comments
• executeS($sqlRequest) method
  • about / Using the database class to save comments
• extra_vars variable / Associating an e-mail with an order state

F

• $fields_form array
  • about / Configuring your form view
  • legend / Configuring your form view
  • input / Configuring your form view
  • submit / Configuring your form view
• $fields_list variable / Improving the list view
• field_list variable / Listing comments in your admin controller
• foreach Smarty
  • reference link / Displaying comments
• front controller
  • used, for creating page / Using front controllers to create a new page
  • creating / Creating the front controller
  • compatibility, maintaining with Friendly URL option / Maintaining compatibility with the Friendly URL option
  • small action dispatcher, creating / Creating a small action dispatcher
  • product name, displaying / Displaying the product name and comments
  • comments, displaying / Displaying the product name and comments
  • CSS, including / Including CSS and JS media in the controller
  • JS media, including / Including CSS and JS media in the controller
  • pagination system, adding / Adding a pagination system

G

• getCacheId method / Using the Smarty cache
• getContent.tpl file
  • about / Making a simple configuration form
• getContent function
  • adding, to module / Adding the module configuration
• getInfosOnProductsList method / Placing all the database requests in our ObjectModel class
• getOrderShippingCost.php controller
  • creating / Using web services on shipping cost calculation
• getOrderShippingCost method
  • about / Using web services on shipping cost calculation
• getProductComments method / Placing all the database requests in our ObjectModel class
• getProductNbComments method / Placing all the database requests in our ObjectModel class
• getRelayPoint method
  • about / API description
• getRow($sqlRequest) method
  • about / Using the database class to save comments
• getShippingCost method
  • about / API description
• getValue($sqlRequest) method
  • about / Using the database class to save comments

H

• $href variable
  • about / Adding a callback to options
• HelperForm
  • used, for creating scalable form / Using HelperForm to make a scalable form
  • table option / Using HelperForm to make a scalable form
  • default_form_language option / Using HelperForm to make a scalable form
  • allow_employee_form_lang option / Using HelperForm to make a scalable form
  • submit_action option / Using HelperForm to make a scalable form
  • current_index option / Using HelperForm to make a scalable form
  • token option / Using HelperForm to make a scalable form
  • tpl_vars option / Using HelperForm to make a scalable form
• hookDisplayProductTabContent method / Cleaning your code using the hook's controller
• hooks
  • module, registering on / Registering our module on hooks
  • module position, changing / Changing the position of your module on a hook
  • used, for displaying templates / Using hooks to display templates
  • comments, saving with database class / Using the database class to save comments
  • comments, displaying / Displaying comments
  • triggering / Triggering hooks
  • adding / Adding a hook
  • dynamic hooks / The dynamic hooks
• href parameter / Creating your own view template

I

• icon parameter / Creating your own view template
• id_carrier variable / Handling carrier update
• id_cart variable / Working with a third-party API
• id_product parameter
  • about / Displaying comments in a product hook
• input array
  • about / Configuring your form view
  • type parameter / Configuring your form view
  • hidden parameter / Configuring your form view
  • text parameter / Configuring your form view
  • tags parameter / Configuring your form view
  • textarea parameter / Configuring your form view
  • select parameter / Configuring your form view
  • radio parameter / Configuring your form view
  • checkbox parameter / Configuring your form view
  • file parameter / Configuring your form view
  • password parameter / Configuring your form view
  • group parameter / Configuring your form view
  • shop parameter / Configuring your form view
  • categories parameter / Configuring your form view
  • color parameter / Configuring your form view
  • date parameter / Configuring your form view
  • label parameter / Configuring your form view
  • desc parameter / Configuring your form view
  • name parameter / Configuring your form view
  • size parameter / Configuring your form view
  • cols parameter / Configuring your form view
  • rows parameter / Configuring your form view
  • required parameter / Configuring your form view
  • default_value parameter / Configuring your form view
  • options parameter / Configuring your form view
  • query parameter / Configuring your form view
  • id parameter / Configuring your form view
• input types, HelperForm
  • categories / Using HelperForm to make a scalable form
  • file / Using HelperForm to make a scalable form
  • color / Using HelperForm to make a scalable form
  • date / Using HelperForm to make a scalable form
  • datetime / Using HelperForm to make a scalable form
  • switch / Using HelperForm to make a scalable form
• insert($table, $data) method
  • about / Using the database class to save comments
• Insert_ID() method
  • about / Using the database class to save comments
• installCarriers method
  • creating / Creating new carriers
• install method
  • about / Registering our module on hooks, Creating a database table on module installation
• installOrderState method / Creating your own order state
• isCached method / Using the Smarty cache

J

• jQuery official documentation
  • URL / Adding CSS and JS in your module
• JS
  • adding, in module / Adding CSS and JS in your module
• js parameter / Creating your own view template

K

• key_tab parameter
  • about / Making links between admin sections

L

• Language**getLanguages($active) method / Adding and installing a new tab to your admin panel
• language object / Looking at the Context object
• legend array
  • about / Configuring your form view
• link object / Looking at the Context object

M

• mail function
  • using / Checking for unusual e-mail sending
• malicious code, searching
  • about / Searching for malicious code in modules
  • strange e-mail sending, checking for / Checking for unusual e-mail sending
  • strange URL calls, checking for / Checking for strange URL calls
  • eval usage, checking / Checking the use of eval
  • system usage, checking / Checking the use of system, exec, and backquotes
  • exec usage, checking / Checking the use of system, exec, and backquotes
  • backquotes usage, checking / Checking the use of system, exec, and backquotes
  • base64_decode usage, checking / Checking the use of base64_decode
  • conclusion / Wrapping up on this section
• MD5 hash
  • data, verifying / Verifying the data with MD5 hash
• mobile_detect object / Looking at the Context object
• module code
  • updating / Updating the module code
  • ObjectModel class, updating / Updating the ObjectModel class
  • Context, using in get method / Using Context in the get method
  • AdminController class, updating / Updating the AdminController class
• module configuration form, carrier module
  • creating / Module configuration
• module controller
  • routes, creating / Creating routes for a module's controller
• module validator tool
  • reference link / Using the Smarty cache
• multistore feature
  • configuring, on PrestaShop / Configuring the multistore feature on your PrestaShop
  • enabling / Enabling the multistore feature
  • new shop, creating / Creating a new shop
  • Configuration class, using with / Using the Configuration class with multistore
• mymodcarrier_load method / Displaying relay points
• MYMOD_CH_ORDER variable / Associating an e-mail with an order state
• MySQL table, of module
  • updating / Updating the MySQL table of the module

N

• need_range parameter / Using web services on shipping cost calculation

O

• ObjectModel class
  • creating / Creating the ObjectModel class
  • using, in module / Using the ObjectModel class in our module
  • database requests, placing / Placing all the database requests in our ObjectModel class
  • updating / Updating the ObjectModel class
• object models
  • used, for creating cleaner code / Using object models to create cleaner code
• objects, Context
  • cart / Looking at the Context object
  • customer / Looking at the Context object
  • cookie / Looking at the Context object
  • link / Looking at the Context object
  • country / Looking at the Context object
  • employee / Looking at the Context object
  • controller / Looking at the Context object
  • language / Looking at the Context object
  • currency / Looking at the Context object
  • shop / Looking at the Context object
  • smarty / Looking at the Context object
  • mobile_detect / Looking at the Context object
• onClickOption method
  • about / Adding a callback to options
• options callback
  • using / Adding a callback to options
• order state
  • about / Creating your own order state
  • e-mail, associating with / Associating an e-mail with an order state
• OrderState object model
  • send_email variable / Creating your own order state
  • module_name variable / Creating your own order state
  • invoice variable / Creating your own order state
  • color variable / Creating your own order state
  • logable variable / Creating your own order state
  • shipped variable / Creating your own order state
  • unremovable variable / Creating your own order state
  • delivery variable / Creating your own order state
  • hidden variable / Creating your own order state
  • paid variable / Creating your own order state
  • deleted variable / Creating your own order state
  • name variable / Creating your own order state
• overrides, installing with modules
  • about / Installing overrides with modules
  • override class, creating / Creating the override class
  • template file, editing / Editing the template file to display grades on products list
  • method, creating in native class / Creating a new method in a native class
• {ObjectModel} variable / Definitions of the variables

P

• $params parameter / Using web services on shipping cost calculation
• $params variable / Handling carrier update
• page parameter
  • about / Displaying comments in a product hook
• payment controller
  • creating / Creating the payment controller
• payment module
  • creating / Creating a payment module
  • payment controller, creating / Creating the payment controller
  • currency, checking / Checking the currency
  • cart, validating into order / Validating a cart into an order
  • information, displaying on order confirmation page / Displaying information on the order confirmation page
  • custom order state, creating / Creating your own order state
  • e-mail, associating with order state / Associating an e-mail with an order state
  • third-party API, working with / Working with a third-party API
• PaymentModule class / Creating a payment module
• payment _token variable / Working with a third-party API
• performance, optimizing
  • Combine, Compress, and Cache (CCC), using / Using Combine, Compress, and Cache
  • cache system, using / Using the cache system
  • Smarty cache, using / Using the Smarty cache
• PrestaShop
  • multistore feature, configuring / Configuring the multistore feature on your PrestaShop
  • dynamic hooks / The list of all the dynamic hooks
  • variables, in dynamic hooks / Definitions of the variables
• PrestaShop module
  • creating / First steps
  • configuration options / First steps
  • configuration options, adding / Adding the module configuration
  • simple configuration form, creating / Making a simple configuration form
  • registering, on hooks / Registering our module on hooks
  • position, changing in hook / Changing the position of your module on a hook
  • unhooking / Changing the position of your module on a hook
  • CSS, adding / Adding CSS and JS in your module
  • JS, adding / Adding CSS and JS in your module
  • upgrading / Upgrading your module
  • code, updating / Updating the module code
  • protecting, against directory listing / Protecting your module against directory listing
  • malicious code, searching / Searching for malicious code in modules
  • performance, optimizing / Performance and optimization
• processConfiguration method
  • creating / Making a simple configuration form
• processProductTabContent method / Cleaning your code using the hook's controller
• pSQL() method / Protecting your code against SQL injection

Q

• query($sqlRequest) method
  • about / Using the database class to save comments

R

• registerHook method
  • about / Registering our module on hooks, Adding a hook
• Relay Point carrier / Displaying relay points
• relay points
  • displaying / Displaying relay points
• removeCSS method / Adding CSS and JS in your module
• removeJS method / Adding CSS and JS in your module
• renderView method / Creating your own view template
• return_url variable / Working with a third-party API
• routes, module controller
  • creating / Creating routes for a module's controller

S

• $shipping_cost parameter / Using web services on shipping cost calculation
• scalable form
  • creating, HelperForm used / Using HelperForm to make a scalable form
• script API
  • id_cart value / Building the validation API controller
  • transaction_id value / Building the validation API controller
  • total_paid value / Building the validation API controller
  • validation_token value / Building the validation API controller
• security, PrestaShop module
  • about / Securing your module
  • module, protecting against directory listing / Protecting your module against directory listing
  • access to class and controller files, forbidding / Forbidding direct access to class and controller files
  • code, protecting against SQL injection / Protecting your code against SQL injection
  • templates, protecting against XSS / Protecting your templates against XSS
  • data, verifying with MD5 hash / Verifying the data with MD5 hash
• selected relay point
  • associating, to cart / Associating the chosen relay point with the cart
• shipping cost calculation
  • web services, using on / Using web services on shipping cost calculation
• shop object / Looking at the Context object
• Smarty cache
  • using, for performance optimization / Using the Smarty cache
• Smarty documentation
  • URL / Making a simple configuration form
• smarty object / Looking at the Context object
• submit array
  • about / Configuring your form view
• system function
  • about / Checking the use of system, exec, and backquotes

T

• $this->page_header_toolbar_btn variable / Creating your own view template
• $this->_path variable / Adding CSS and JS in your module
• $type string
  • about / Adding a callback to options
• Tab**getIdFromClassName($class_name) method / Adding and installing a new tab to your admin panel
• table variable / Listing comments in your admin controller
• templates
  • displaying, hooks used / Using hooks to display templates
  • protecting, against XSS / Protecting your templates against XSS
• testConnection method
  • about / API description
• text parameter / Adding actions on the list view
• third-party API
  • working with / Working with a third-party API
  • module configuration form, updating / Updating the module's configuration form
  • payment method, displaying / Displaying the new payment method
  • validation API controller, building / Building the validation API controller
• Tools**getValue function
  • about / Making a simple configuration form
• Tools**isSubmit method
  • creating / Making a simple configuration form
• total_to_pay variable / Working with a third-party API
• translate method
  • using / Using the translate method

U

• unhook / Changing the position of your module on a hook
• uninstall method
  • about / Deleting a table on uninstallation
• update($table, $data, $condition) method
  • about / Using the database class to save comments

V

• validation_url variable / Working with a third-party API
• versions, of modules
  • reference links / Using the Smarty cache