-
Notifications
You must be signed in to change notification settings - Fork 3
POSM Notifications Issued
One of the major changes in POSM v4.4.0 is the migration of its notifications to use a NOTIFY_ prefix otherwise, any observers you've developed that use the snake-cased event-name syntax will fail to get that message in zc158!
Indicates that POSM's AJAX processing is preparing to gather information about the current product's managed variants from the database, giving an observer the chance to add to the fields selected from the products_options_stock (pos) and products_options_stock_attributes (posa) tables.
$p2: A reference to the $select_clause variable, initialized to SELECT posa.options_id, posa.options_values_id, pos.products_quantity AS quantity, pos.pos_name_id AS oos_msg_id, pos.pos_model AS model, pos.pos_date AS oos_date. An observer can add to this collection of fields.
Indicates that POSM's AJAX processing has successfully gathered the product's fields identified in the previous notification, enabling an observer to record some 'extra_info' into the option-values returned by the AJAX handler.
$p1: An associative array of values representing the $db fields returned by the just-issued database query.
$p2: A reference to the $extra_info variable, initialized to an empty string. An observer can append its information here and the value is returned by the AJAX request as the 'extra_info' element of the options_value array.
Indicates that POSM's AJAX processing has completed its processing and gives an observer a chance to identify any extension-related jQuery functions to be called upon return by POSM's dependent-attributes jQuery.
$p1: An associative array containing the $option_values to be returned to the jQuery processing.
$p2: A reference to the $extra_functions variable, initialized to (bool)false. If a POSM extension has additional jQuery to process the attributes, its observer sets this value to an array of associative arrays keyed on the to-be-run jQuery function name with the array element's value being the parameters expected by said jQuery function.
Indicates that the observer has been instantiated. Starting with POSM v4.2.0, the issuance of the notification also indicates that POSM is enabled. For previous versions of POSM, a watching observer needs to check the class' enabled flag for that indication.
None.
Issued by the observer during order-creation, once per unique product in the order, based on its receipt of the NOTIFY_ORDER_PROCESSING_STOCK_DECREMENT_BEGIN notification from the order class. This gives a watching observer the opportunity to either bypass the stock decrement for all products or just for the current product (so long as the product is currently stock-managed by POSM).
The processing performed at this point enables POSM and/or a POSM-extension to modify the base order class processing of stock-decrementation.
$p1: A read-only associative array containing the order's product array for the current product and its stock information. The stock value is (bool)false if the product is not POSM-managed, otherwise the value contains a $db return that has selected all fields from the product variant's products_options_stock table entry.
$p2: A reference to the $bypass_stock_decrement variable, initialized to (bool)false. If an observer sets this value to (bool)true, the stock-decrement for the product is not performed regardless of whether or not the product is POSM-managed.
$p3: A reference to the $decrement_options_stock variable, initialized to (bool)true. If an observer sets this value to (bool)false and the product is POSM-managed, then the stock-decrement for the product is not performed.
Issued by the observer during order-creation, once per unique product in the order, based on its receipt of the NOTIFY_ORDER_DURING_CREATE_ADDED_PRODUCT_LINE_ITEM notification from the order class. This gives a watching observer the opportunity to either bypass the stock decrement for all products or just for the current product (so long as the product is currently stock-managed by POSM).
The processing performed at this point provides POSM an/or a POSM-extension a means to affect the product variant's stock recording in the database.
$p1: A read-only associative array containing the product (set to the order's $sql_data_array that just created an orders_products record for the current product) and the product's stock information. The stock value is (bool)false if the product is not POSM-managed, otherwise the value contains a $db return that has selected all fields from the product variant's products_options_stock table entry.
$p2: A reference to the $decrement_managed_stock variable, initialized to (bool)true. If an observer sets this value to (bool)true, the stock-decrement for the product is not performed regardless of whether or not the product is POSM-managed.
$p3: A reference to the $decrement_options_stock variable, initialized to (bool)true. If an observer sets this value to (bool)false and the product is POSM-managed, then the stock-decrement for the product is not performed.
POSM's observer processes the returned values as one of four (4) possibilities ... in the order identified below:
- If any observer has set
$decrement_managed_stock($p2) to a value other than(bool)true, POSM's observer totally bypasses its stock-handling. - If the overall product is not POSM-managed, the observer ensures that the product's recorded quantity does not fall below 0.
- If the product variant is not POSM-managed or any observer has set
$decrement_options_stock($p3) to a value other than(bool)true, the observer sets the base product's quantity to be the sum of all the product's managed-variants' quantities. - Otherwise, the product-variant is POSM-managed and its stock is to be handled. The variant's quantity is decremented and the base product's quantity is set to the sum of all the product's managed-variants' quantities. If configured and indicated, a variant-specific low-stock e-mail is sent.
Issued by the observer's get_in_stock_message method at various points in a product's rendering, conditionally adding an in-/out-of-stock message to the product's name. This gives a watching observer the opportunity to further control the stock message's display.
$p1: A read-only associative array containing the prid (containing the product's uprid) and the product's pos_record. The pos_record value is (bool)false if the product is not POSM-managed, otherwise the value contains a $db return that has selected all fields from the product variant's products_options_stock table entry.
$p2: A reference to the $message_override variable, initialized to (bool)false.
$p3: A reference to the $use_in_stock_message variable, initialized to (bool)true.
$p4: A reference to the $show_mixed_stock_messages variable, initialized to (bool)true.
Watching observers can control whether:
- The overall in-/out-of-stock message handling should be bypassed, using the in- or out-of-stock message as indicated. The observer, in this case, sets the
$message_override($p2) to(bool)trueand the$use_in_stock_message($p3) to identify whether the in-stock (true) or out-of-stock (otherwise) messaging should be used. - No mixed-stock messages should be displayed. If the ordered quantity of a managed product is mixed, i.e. some in-stock and some out, and the observer sets
$show_mixed_stock_messages($p4) to something other than(bool)true then the message for the product shows the out-of-stock message only.
Indicates that POSM's jQuery processing for its dependent-attributes feature is preparing to include its <script>, giving an observer the opportunity to either opt-out by setting the reference to the $posm_dependent_attrs_enable variable to a value other than (bool)true or to force the handling to continue by setting the value to specifically (bool)true.
$p2: A reference to the $posm_dependent_attrs_enable variable, initialized to (bool)true if POSM's POSM_DEPENDENT_ATTRS_ENABLE configuration is set to 'true'; (bool)false otherwise.
Indicates that the observer has received an EDIT_ORDERS_ADD_PRODUCT notification from the Edit Orders plugin.
$p1: A read-only associative array containing the information that Edit Orders supplied in the first parameter of its notification.
$p2: A reference to the $bypass_add variable, initialized to (bool)false. If an observer sets this value to (bool)true, the POSM observer's processing of the product-addition is bypassed.
Issued by the observer during its processing of an EDIT_ORDERS_ADD_PRODUCT notification from the Edit Orders plugin, so long as no observer has requested that the base processing be bypassed (see the notification above).
$p1: A read-only associative array containing EO's product array for the current product and the product's stock information. The stock value is (bool)false if the product is not POSM-managed, otherwise the value contains a $db return that has selected all fields from the product variant's products_options_stock table entry.
$p2: A reference to the $bypass_managed_stock_update variable, initialized to (bool)false. If an observer sets this value to (bool)true, the stock-decrement for the base product/product-variant is not performed regardless of whether or not the product is POSM-managed.
Issued by the observer during the removal of a product from an order, either requested by the Zen Cart admin's orders.php or via the Edit Orders plugin's processing.
$p1: A read-only value identifying the $orders_products_id of the ordered product being removed from the order.
$p2: A reference to the $bypass_quantity_updates variable, initialized to (bool)false. If an observer sets this value to any other value, neither the product variant's quantity nor the base product's overall quantity are updated.
Issued by the observer's getInStockMessage method at various points in a product's rendering, conditionally adding an in-/out-of-stock message to the product's name. This gives a watching observer the opportunity to further control the stock message's display.
$p1: A read-only associative array containing
-
op_info. A$dbreturn from a query for theproducts_idandproducts_quantityof the current ordered product, i.e. this reflects the quantity ordered. -
prod_info. A$dbreturn from a query for theproducts_typeandproducts_quantityof the associated product, i.e. this reflects the currently stocked overall quantity of the product. -
pos_info. Either(bool)false, if the product is not POSM-managed, or a$dbreturn from a query for the current productspos_id,products_quantity,pos_dateandpos_name_idassociated with the managed-variant of the product. This quantity reflects the variant's currently stocked quantity.
$p2: A reference to the $message_text_override variable, initialized to an empty string ('').
$p3: A reference to the $force_out_of_stock_message variable, initialized to (bool)false.
Watching observers can control whether:
- A specific stock-related message is appended to the product's name by setting the
$message_text_overridevalue to a non-empty string. - Force, for POSM-managed products, POSM's out-of-stock message for out-of-stock products, i.e. no 'mixed-stock' messages will be used.
Issued by the insert_stock_option function to indicate that a managed-variant for a product has been inserted into the database.
$p1: A read-only associative array containing
-
pID. The product's id associated with the variant. -
options_values_array. An associative array, containing key/value pairs to identify eachoptions_idandoptions_values_idassociated with the variant. -
quantity. The initial quantity value applied to the variant. -
pos_id. Thepos_idfrom theproducts_options_stocktable that is associated with the variant.
Issued at the beginning of any update processing, gives observers a chance to record their posted values and ensure that all inputs have been retrieved.
$p1: The number of 'base' quantity inputs received from the form's posting. An observer, for non-checkbox type inputs, must ensure that the count of each posted input array received matches this count.
$p2: A reference to the $missing_inputs_flag variable, initialized to a (bool)false. Setting this flag to (bool)true will result in the update failing to complete.
$p3: A reference to the $error variable, initialized to a (bool)false. Setting this flag to (bool)true will result in the update failing to complete; the observer is expected to have set a message in the messageStack identifying the source of the error.
$p4: A reference to the $onload variable, initialized to an empty string (''). The variable contains script-related actions to be performed on the page body's load.
Issued just prior to updating a record in the products_options_stock table, giving observers the chance to include their fields in the update. This version of the notification also enables observers to indicate that an error was detected in one of their custom fields, resulting in the database update being bypassed.
$p1: The $pos_id of the record being updated.
$p2: A reference to the $update_posm_record_sql variable.
$p3: A reference to the $error variable, initialized to a (bool)false. Setting this flag to (bool)true will result in the update failing to complete; the observer is expected to have set a message in the messageStack identifying the source of the error.
$p4: A reference to the $onload variable, initialized to an empty string (''). The variable contains script-related actions to be performed on the page body's load.
Issued when a request is received to remove one or more managed-options from a product, enabling an observer to perform any custom actions based on the base product's current managed-status.
$p1: The products_id of the product from which one or more managed options were removed.
Issued just prior to the </head> for the page; an observer can identify additional CSS styles to be inserted into a <style> tag or javascript (not jQuery) to be inserted into a <script> tag.
- An alternative to the use of this notification is to include add-on specific CSS/JS content via separate files present in the admin's
/includes/cssand/includes/javascriptsub-directories, respectively. Files' names to be loaded for this page should start withproducts_options_stock_for the files to be auto-loaded. - Since this javascript is loaded prior to the load of the jQuery base, any JS content must be pure javascript. Any jQuery content required by the POSM extension for this page should be placed in the
/includes/javascriptsub-directory, as identified above.
$p2: A reference to the $css_content string, set initially to an empty string. If, on return, the value is not empty, the string is rendered in a <style> tag.
$p3: A reference to the $js_content string, set initially to an empty string. If, on return, the value is not empty, the string is rendered in a <script> tag.
$p4: A reference to the $onload string. The observer should append its onload actions to the pre-existing string.
Issued during the creation of the array of the current product's managed variants (used for lower table's display), once for each option-combination.
$p1: An associative array of all products_options_stock table fields associated with the current option. The pos_id element of the array defines the current element of the $pos_product_options array being processed.
$p2: A reference to the $pos_product_options array. An observer is expected to add fields in the current pos_id element containing values in the info_array supplied to observers of the NOTIFY_POSM_LOWER_CONTENT_INSERT_B4_QTY and NOTIFY_POSM_LOWER_CONTENT_INSERT_AFTER_QTY notifications described below.
Issued prior to the in-page rendering, requesting that observers identify the number of columns of data that they will be adding to the upper and lower tables' display.
$p2: Initialized to the count of columns that the POSM manager uses. Each observer is expected to update this count by their respective number of added columns. Upon return from this notification, the constant STATIC_FIELD_COUNT is defined with the returned value.
Issued prior to the rendering of the data for the upper form's Quantity heading column. Watching observers are expected to fill this array with additional heading elements to encompass the additional columns that were registered in the POSM_START_HTML_OUTPUT notification!
$p2: A reference to the $additional_content array (initialized as an empty array).
The $additional_content array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column heading, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the heading content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.colspan="3".
For example, an observer that has indicated that it supplies 2 additional columns could either add two empty column-headings:
$p2[] = ['text' => ' '];
$p2[] = ['text' => ' '];or the observer could simply identify a single column spanning 2 columns:
$p2[] = ['text' => ' ', 'params' => 'colspan="2"']Issued prior to the rendering of the element for the upper form's Quantity input column. Watching observers are expected to fill this array with additional data to encompass the additional columns that were registered in the NOTIFY_POSM_START_HTML_OUTPUT notification!
$p2: A reference to the $additional_content array (initialized as an empty array).
The $additional_content array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column data, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.colspan="3".
For example, an observer that has indicated that it supplies 2 additional columns could either add two empty column elements:
$p2[] = ['text' => ' '];
$p2[] = ['text' => ' '];or the observer could simply identify a single column spanning 2 columns:
$p2[] = ['text' => ' ', 'params' => 'colspan="2"']Issued after the rendering of the tool's instructions, enabling a POSM extension to include its instructions on the screen.
$p2: A reference to the $additional_instructions array (initialized as an empty array).
The $additional_instructions array is a numerically-indexed array, with each array element containing string to be output as a single, full-width, table row.
Issued prior to the rendering of the lower-form's Quantity column heading. Observers can 'split' their added columns to be either before (using this notification) or after (using the NOTIFY_POSM_LOWER_HEADING_INSERT_AFTER_QTY notification) the base tool's Quantity column. Between their response to the two notifications, watching observers are expected to fill this array with additional data elements to encompass the additional columns that were registered in the NOTIFY_POSM_START_HTML_OUTPUT notification!
$p2: A reference to the $extra_headings array (initialized as an empty array).
The $extra_headings array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column data, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the heading content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.colspan="3". -
class. This optional entry identifies any additional extension-specific class(es) to be applied to the heading.
For example, an observer that has indicated that it supplies 2 additional columns could either add two empty column-headings:
$p2[] = ['text' => ' '];
$p2[] = ['text' => ' '];or the observer could simply identify a single column spanning 2 columns:
$p2[] = ['text' => ' ', 'params' => 'colspan="2"']Issued after the rendering of the lower form's Quantity column heading. Observers can 'split' their added columns to be either after (using this notification) or before (using the POSM_LOWER_HEADING_INSERT_B4_QTY notification) the base tool's Quantity column. Between their response to the two notifications, watching observers are expected to fill this array with additional data elements to encompass the additional columns that were registered in the NOTIFY_POSM_START_HTML_OUTPUT notification!
$p2: A reference to the $extra_headings array (initialized as an empty array).
The $extra_headings array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column data, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the heading content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.colspan="3". -
class. This optional entry identifies any additional extension-specific class to be applied to the input.
For example, an observer that has indicated that it supplies 2 additional columns could either add two empty column-headings:
$p2[] = ['text' => ' '];
$p2[] = ['text' => ' '];or the observer could simply identify a single column spanning 2 columns:
$p2[] = ['text' => ' ', 'params' => 'colspan="2"']Issued prior to rendering the lower form's Update button, enabling observers to identify additional HTML parameters to apply to form's Update buttons.
$p2: A reference to the $posm_update_button_parms variable (initialized as an empty string), to which observers can append their required HTML parameters.
Issued prior to the rendering of the lower form's Quantity input column. Observers can 'split' their added columns to be either before (using this notification) or after (using the NOTIFY_POSM_LOWER_CONTENT_INSERT_AFTER_QTY notification) the base tool's Quantity column. Between their response to the two notifications, watching observers are expected to fill this array with additional data elements to encompass the additional columns that were registered in the NOTIFY_POSM_START_HTML_OUTPUT notification!
$p1: An associative array identifying the pos_id associated with the current row, the current tool's action, as well as the info_array for the row, containing the data previously gathered via the NOTIFY_POSM_ADD_PRODUCT_OPTION notification.
$p2: A reference to the $lower_content array (initialized as an empty array).
The $lower_content array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column heading, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.colspan="3".
For example, an observer that has indicated that it supplies 2 additional columns could either add two empty column elements:
$p2[] = ['text' => ' '];
$p2[] = ['text' => ' '];or the observer could simply identify a single column spanning 2 columns:
$p2[] = ['text' => ' ', 'params' => 'colspan="2"']Issued after the rendering of the lower form's Quantity input column. Observers can 'split' their added columns to be either after (using this notification) or before (using the NOTIFY_POSM_LOWER_CONTENT_INSERT_B4_QTY notification) the base tool's Quantity column. Between their response to the two notifications, watching observers are expected to fill this array with additional data elements to encompass the additional columns that were registered in the NOTIFY_POSM_START_HTML_OUTPUT notification!
$p1: An associative array identifying the pos_id associated with the current row, the current tool's action, as well as the info_array for the row, containing the data previously gathered via the NOTIFY_POSM_ADD_PRODUCT_OPTION notification.
$p2: A reference to the $lower_content array (initialized as an empty array).
The $lower_content array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column data, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the heading content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.colspan="3". -
class. This optional entry identifies any additional extension-specific class to be applied to the input.
For example, an observer that has indicated that it supplies 2 additional columns could either add two empty column-headings:
$p2[] = ['text' => ' '];
$p2[] = ['text' => ' '];or the observer could simply identify a single column spanning 2 columns:
$p2[] = ['text' => ' ', 'params' => 'colspan="2"']Issued at the beginning of any update processing, gives observers a chance to record their posted values and ensure that all inputs have been retrieved.
None.
Issued just prior to updating a record in the products_options_stock table, giving observers the chance to include their fields in the update. This version of the notification also enables observers to indicate that an error was detected in one of their custom fields, resulting in the database update being bypassed.
$p1: The $pos_id of the record being updated.
$p2: A reference to the $posm_sql_data array with which the products_options_stock table record is to be updated.
$p3: A reference to the $where_str to be used when performing the update.
$p4: A reference to the $error variable, initialized to a (bool)false. Setting this flag to (bool)true will result in the update failing to complete; the observer is expected to have set a message in the messageStack identifying the source of the error.
$p5: A reference to the $onload variable, initialized to an empty string (''). The variable contains script-related actions to be performed on the page body's load.
Issued during database update processing, once for each base product whose managed options were updated. Added for POSM v4.4.0.
$p1: The products_id of the product from which one or more managed options were updated.
Issued just after the rendering of in-line CSS for the page's header; an observer can identify additional CSS styles to be inserted into a <style> tag or javascript (not jQuery) to be inserted into a <script> tag.
- An alternative to the use of this notification is to include add-on specific CSS/JS content via separate files present in the admin's
/includes/cssand/includes/javascriptsub-directories, respectively. Files' names to be loaded for this page should start withproducts_options_stock_view_all_for the files to be auto-loaded. - Since this javascript is loaded prior to the load of the jQuery base, any JS content must be pure javascript. Any jQuery content required by the POSM extension for this page should be placed in the
/includes/javascriptsub-directory, as identified above.
$p2: A reference to the $onload string. The observer should append its onload actions to the pre-existing string.
$p3: A reference to the $css_content string, set initially to an empty string. If, on return, the value is not empty, the string is rendered in a <style> tag.
$p4: A reference to the $js_content string, set initially to an empty string. If, on return, the value is not empty, the string is rendered in a <script> tag.
Issued prior to the in-page rendering, requesting that observers identify the number of columns of data that they will be adding to the upper and lower tables' display.
$p2: Initialized to the count of columns that the POSM View All tool supplies. Each observer is expected to update this count by their respective number of added columns. Upon return from this notification, the constant STATIC_FIELD_COUNT is defined with the returned value.
$p3: A reference to the $instructions2 string, initially set to the language constant TEXT_POS_INSTRUCTIONS2. Observers should append their usage instructions to the input string; the resultant value is echoed between a <p></p> tag-pair.
Issued prior to the rendering of the form's Quantity column heading. Watching observers are expected to fill this array with additional heading elements to encompass the additional columns that were registered in the NOTIFY_POSM_VIEW_ALL_START_BODY notification!
$p2: A reference to the $additional_content array (initialized as an empty array).
The $additional_content array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column heading, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the heading content.
For example, an observer that has indicated that it supplies 2 additional columns should add two column-headings:
$p2[] = ['text' => 'Column 1', 'align' => 'center'];
$p2[] = ['text' => 'Column 2'];Issued prior to the rendering of each form-row that contains a main product's name (and link). Observers could add strings (or form elements) to be prepended to that name and link and (optionally) insert additional heading-columns into that row.
$p1: Identifies the products_id of the current main product.
$p2: A reference to the $products_name_extra_info string (initialized as an empty string).
$p3: A reference to the $additional_content array (initialized as an empty array).
The $additional_content array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column data, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.colspan="3".
For example, an observer that has indicated that it supplies 2 additional columns could either add two empty column elements:
$p2[] = ['text' => ' '];
$p2[] = ['text' => ' '];or the observer could simply identify a single column spanning 2 columns:
$p2[] = ['text' => ' ', 'params' => 'colspan="2"']Issued prior to the rendering of the form's Quantity input column for the current product variant. Watching observers are expected to fill this array with additional form elements to encompass the additional columns that were registered in the NOTIFY_POSM_VIEW_ALL_START_BODY notification!
$p1: An associative array containing all products_options_stock database fields and values for the row's current pos_id.
$p2: A reference to the $additional_content array (initialized as an empty array).
The $additional_content array is a numerically-indexed array, with each array element containing an associative array containing:
-
text. This required entry identifies the text to be associated with the column heading, even if it's blank! -
align. This optional entry identifies the alignment (one ofcenter,rightorleft) to apply to the content. -
params. This optional entry identifies any additional parameters to apply to the column, e.g.onclick="runme();". -
class. This optional entry identifies any additional extension-specific class to be applied to the column.
For example, an observer that has indicated that it supplies 2 additional columns adds two empty column elements:
$pos_id = $p1['pos_id'];
$p2[] = [
'text' => zen_draw_input_field("pos_var1[$pos_id]", $var1),
'align' => 'center',
];
$p2[] = [
'text' => zen_draw_input_field("pos_var2[$pos_id]", $var2),
'align' => 'center',
];