*

ProductController

*

*

• actionProductAdd

  *
  *
  • Legacy code (for legacy Admin controller, Product pages) is not modified
  *
  • Since 1.7 (refactored Admin Product pages), triggered by an adapter from legacy code: not modified
  *
  • Parameters: *
    *
    1. product: [object] Product (unchanged)
    *
    2. cookie: [object] Cookie (unchanged)
    *
    3. cart: [object] Cart (unchanged)
    *
    4. altern: ???
    *
    *
  *
  • Returns: void
  *
  *
*

• actionProductDelete

  *
  *
  • Legacy code (for legacy Admin controller, Product pages) is not modified
  *
  • Since 1.7 (refactored Admin Product pages), triggered by an adapter from legacy code: not modified
  *
  • Parameters: *
    *
    1. id_product: [int] Product ID to be deleted (unchanged)
    *
    2. product: [object] Product (unchanged)
    *
    3. cookie: [object] Cookie (unchanged)
    *
    4. cart: [object] Cart (unchanged)
    *
    5. altern: ???
    *
    *
  *
  • Returns: void
  *
  *
*

• actionProductUpdate

  *
  *
  • Legacy code (for legacy Admin controller, Product pages) is not modified
  *
  • Since 1.7 (refactored Admin Product pages), triggered by an adapter from legacy code or directly from an adapter: duplicated behavior.
  *
  • Parameters: *
    *
    1. id_product: [int] Product ID to be deleted (unchanged)
    *
    2. product: [object] Product (unchanged)
    *
    3. cookie: [object] Cookie (unchanged)
    *
    4. cart: [object] Cart (unchanged)
    *
    5. altern: ???
    *
    *
  *
  • Returns: void
  *
  *
*

• actionAdminProductsListingFieldsModifier

  *
  *
  • Legacy code (for legacy Admin controller, Product pages) is not modified
  *
  • Since 1.7 (refactored Admin Product pages), triggered by an adapter with a DIFFERENT BEHAVIOR.
  *
  • Parameters for the new 1.7 behavior (if _ps_version present and >=1.7.0): *
    *
    1. _ps_version: [int] value of _PS_VERSION_ is present only if triggered on new Product catalog page (>=1.7)
    *
    2. sql_select: [&array] SELECT fields (to modify directly if needed)
    *
    3. sql_table: [&array] TABLES to join (to modify directly if needed)
    *
    4. sql_where: [&array] WHERE clauses (to modify directly if needed)
    *
    5. sql_order: [&array] ORDER BY clauses (to modify directly if needed)
    *
    6. sql_limit: [&string] LIMIT clause (to modify directly if needed)
    *
    7. cookie: [object] Cookie (unchanged)
    *
    8. cart: [object] Cart (unchanged)
    *
    9. altern: ???
    *
    *
  *
  • {@see AbstractAdminQueryBuilder::compileSqlQuery()} for more details about how to build these arrays.
  *
  • {@see AdminProductDataProvider::getCatalogProductList()} for an example.
  *
  • Returns: void (but you can modify input parameters passed by reference)
  *
  *
*

• actionAdminProductsListingResultsModifier

  *
  *
  • Legacy code (for legacy Admin controller, Product pages) is not modified
  *
  • Since 1.7 (refactored Admin Product pages), triggered by an adapter with a DIFFERENT BEHAVIOR.
  *
  • Parameters for the new 1.7 behavior (if _ps_version present and >=1.7.0): *
    *
    1. _ps_version: [int] value of _PS_VERSION_ is present only if triggered on new Product catalog page (>=1.7)
    *
    2. products: [&array] List of the products on the requested page, after sql query (modified by actionAdminProductsListingFieldsModifier hook)
    *
    3. total: [integer] total count of products (without pagination) that matches with the requested filters
    *
    4. cookie: [object] Cookie (unchanged)
    *
    5. cart: [object] Cart (unchanged)
    *
    6. altern: ???
    *
    *
  *
  • {@see AdminProductDataProvider::getCatalogProductList()} for an example.
  *
  • Returns: void (but you can modify input parameters passed by reference)
  *
  *
*

• displayAdminProductsExtra

  *
  *
  • Legacy code (for legacy Admin controller, Product pages) is not modified
  *
  • Since 1.7 (refactored Admin Product pages), triggered by the new architecture in Twig template.
  *
  • Parameters for the new 1.7 behavior (if _ps_version present and >=1.7.0): *
    *
    1. _ps_version: [int] value of _PS_VERSION_ is present only if triggered on new Product details page (>=1.7)
    *
    2. id_product: [int] Product ID to be detailed in the form
    *
    3. cookie: [object] Cookie (unchanged)
    *
    4. cart: [object] Cart (unchanged)
    *
    5. altern: ???
    *
    *
  *
  • Returns: HTML code, all embedded. While the page has been refactored, JS and legacy HTML/CSS classes are all changed.
  *
  *
*

• actionUpdateQuantity

  *
  *
  • Legacy code (for legacy Admin controller, Product pages) is not modified
  *
  • Since 1.7 (refactored Admin Product pages), triggered by an adapter from legacy code or directly from an adapter: duplicated behavior.
  *
  • Parameters: *
    *
    1. id_product: [int] Product ID to be updated (unchanged)
    *
    2. id_product_attribute: [int] Product attribute ID to be updated (unchanged, 0 if the product has no attribute)
    *
    3. quantity: [int] Quantity to set (unchanged)
    *
    4. cookie: [object] Cookie (unchanged)
    *
    5. cart: [object] Cart (unchanged)
    *
    6. altern: ???
    *
    *
  *
  • Returns: void
  *
  *
*

• action{Admin|AdminProductsController}{Duplicate|Delete|Sort|Activate|Deactivate}{Before|After}

  *
  *
  • Since 1.7, triggered from the Controller
  *
  • Parameter, one of these: *
    *
    1. product_list_id: [array] A list of product IDs concerning the action
    *
    2. product_id: [int] The product ID concerning the action
    *
    3. product_list_position: [array] The positions of products in the product_list_id parameter, to sort
    *
    *
  *
  • Returns: void
  *
  *
*

• shouldUseLegacyPage

  *
  *
  • Since 1.7, triggered from the Controller. This is a transitional behavior and can be removed in the future.
  *
  • Parameters: *
    *
    1. page: [string] The page name concerning the parameter change ('product', etc...)
    *
    2. use_legacy: [boolean] True if the user ask to use legacy page instead of the new one.
    *
    *
  *
  • Returns: void
  *
  *
*

• actionProductActivation

  *
  *
  • Since 1.7, triggered from the AdminProductDataUpdater via sf ProductController.
  *
  • Parameters: *
    *
    1. id_product: [int] Product ID to be updated
    *
    2. product: [object] Product
    *
    3. activated: [boolean] True if activation, False if deactivation.
    *
    *
  *
  • Returns: void
  *
  *
*

*