Return Authorization Module (RMA)

[DivaVocals]

Some of your suggestions removes some of the flexibility Clyde was trying to build in..

1. Button versus a link on the account histroy page, the inclusion of this code should be a flexible admin configurable choice IMHO. I'll take a look at how to make that so.. Anfd the text should DEFINITELY not be hard coded in.. It should be in a proper language definition file.
2. Regarding item #2 (mods to includes\templates\YourTemplate\templates\tpl_returns_default.php, and \includes\languages\english\YourTeplate\returns.php)
   
   • The extra code Clyde included is for form error validation. Not sure from a usability POV that this should change. Clyde is not here to confirm this, but from a usability POV, I can only assume he felt that it made more sense to put the field level error messages next to each field versus including them all in the message stack. He opted instead for a simpler single message stack error message with field level error messages.
   • It would be a less than satisfying user experience to present the shopper with only one error message "Errors have occured on your submission! Please correct and re-submit" without indicating WHICH field is in error, and HOPING they will "figure it out" based on a simple "Required" symbol. Clyde's approach eliminates the possiblity of user frustration and lends to a better user experience.
   • I'm not sure that the the code from the Capitalize_Signup_Fields mod should be included.. Seems more of a personal choice and as much as possible I'm a BIG proponent that modules should be flexible. Not sure it's practical to make this an admin configurable option either, but I will take a look.. Honestly if folks want this feature they really should just install the Capitalize_Signup_Fields mod themselves
   • Replacing the send button with the submit button.. I'll have to look at this and see how the contact form is configure.. at the very LEAST the RMA form and the contact form should use the same submit/send button.
   • Will take a look at the returns message.. Again, Clyde is not here to confirm what he did, but given the code, it appears he was leaning towards a more flexible solution by giving the admin more options to control the look and feel.. Your changes are a personal choice, and while I don't think they should be part of the codebase, perhaps I could take a look to see if the current options could allow a shopowner to make similar changes without removing ALL of the current code as you have done or provide the means for shopowners to make similar changes if the current codebase won't accomodate this. there are folks who have been using this module who LIKE the returns message the way it is.. This module should support choices and flexibility with regards to look and feel.
   
   
3. Adding the comment is a good idea.. I will also include this in the readme as not all shopowners (especially the DIYers) are going to KNOW to look for this comment. It might even be a BETTER idea to try and make this an admin configurable option so that DIYer shopowners don't HAVE to mess with the code to make this change..

A few more suggestions

1) Return Button
Actually, the need for a button, and hence edits to button_names.php, can be dispensed with by replacing the following line in includes\templates\YourTemplate\templates\tpl_account_history_info_default.php

<div class="rmaRequestButton"><?php echo '<a href="' . zen_href_link(FILENAME_RETURNS, (isset($_GET['page']) ? 'page=' . $_GET['page'] . '&' : '') . 'order_id=' . $_GET['order_id'], 'SSL') . '">' . zen_image_button(BUTTON_RMA_REQUEST) . '</a>'; ?></div>

with something similar to:

<!-- bof RMA Button #600 -->
<p><?php echo '<strong>Returns</strong><br />If you wish to return any of the above items to us, please do not send any items before <a href="' . zen_href_link(FILENAME_RETURNS, (isset($_GET['page']) ? 'page=' . $_GET['page'] . '&' : '') . 'order_id=' . $_GET['order_id'], 'SSL') . '">obtaining our authorisation</a>.'; ?></p>
<!-- bof RMA Button #600 -->

Of course, the text component could be turned into a define placed in \includes\languages\english\YourTemplate\account_history_info.php (override file).



2) In includes\templates\YourTemplate\templates\tpl_returns_default.php,
a)the "required" options can be dispensed with in favour of the more simple approach (ie input is either required or not)

Compare this

<label class="inputLabel" for="contactname"><?php echo (($error == true && $entry_name_error == true) ?  ENTRY_NAME . zen_image($template->get_template_dir(RETURN_WARNING_IMAGE, DIR_WS_TEMPLATE, $current_page_base,'images'). '/' . RETURN_WARNING_IMAGE, RETURN_WARNING_IMAGE_ALT, RETURN_WARNING_IMAGE_WIDTH, RETURN_WARNING_IMAGE_HEIGHT) : ENTRY_NAME . zen_image($template->get_template_dir(RETURN_REQUIRED_IMAGE, DIR_WS_TEMPLATE, $current_page_base,'images'). '/' . RETURN_REQUIRED_IMAGE, RETURN_REQUIRED_IMAGE_ALT, RETURN_REQUIRED_IMAGE_WIDTH, RETURN_REQUIRED_IMAGE_HEIGHT)); ?></label>
<?php echo (($error == true && $entry_name_error == true) ? zen_draw_input_field('contactname', $name, ' size="20" id="contactname"') . ENTRY_NAME_ERROR : zen_draw_input_field('contactname', $name, ' size="20" id="contactname"')); ?>

to this

<label class="inputLabel" for="contactname"><?php echo ENTRY_NAME . '<span class="reqd">' . ENTRY_REQUIRED_SYMBOL . '</span>'; ?></label>
<?php echo zen_draw_input_field('contactname', zen_output_string_protected($name), ' size="46" id="contactname" onchange="capitalize(this,1);"'); ?>

The latter even includes code from the Capitalize_Signup_Fields mod, although IIRC Plugins mispells capitalize.


b) the send button can be replaced by the submit button as per the following:

<div class="buttonRow forward"><?php echo zen_image_submit(BUTTON_IMAGE_SUBMIT, BUTTON_SUBMIT_ALT); ?></div>

c) the following success message was way too much work for me

<div class="mainContent success">
<?php echo '<div id="returnSuccess">' . TEXT_SUCCESS . '</div>' . '<div id="returnRequired">'. TEXT_SUCCESS_RMA_REQUIRED . '</div>' . '<div id="returnPolicy">'. TEXT_SUCCESS_RMA_POLICY_BOF . '<a href="' . zen_href_link(FILENAME_SHIPPING, '', 'SSL') . '">' . TEXT_SUCCESS_RMA_POLICY_LINK . '</a>' . TEXT_SUCCESS_RMA_POLICY_EOF . '</div>' . '<div id="returnAddressWrapper">' . '<div id="returnRMA">' . TEXT_SUCCESS_RMA_ID . $rma_number . '</div>' . '<div id="returnAddress">' . TEXT_SUCCESS_RMA_RETURN_ADDRESS . '</div>'; if (RETURN_STORE_NAME_ADDRESS == 'true') { echo '<address>' . nl2br(STORE_NAME_ADDRESS) . '</address>'; } echo '<div id="returnPhone">' . TEXT_SUCCESS_RMA_RETURN_PHONE . '</div>' . '</div>'; ?>

which I simplified to

<?php echo TEXT_SUCCESS . TEXT_SUCCESS_RMA_REFERENCE . '<strong>' . $order_number . $rma_number . '</strong><br /><br /><br />' . TEXT_SUCCESS_RMA_THANKS; ?>

with corresponding defines in \includes\languages\english\YourTeplate\returns.php reduced to:

define('TEXT_SUCCESS', 'Your request was successfully submitted and a confirmation email has been sent to your email address.<br /><br />We will review your request and respond as soon as practicable. If you do not hear from us within seven (7) days, please <a href="index.php?main_page=contact_us">prompt us</a> before re-submitting your request.<br /><br />Our Returns Policy is contained in our <a href="index.php?main_page=terms_of_sale">Terms of Sale</a>.<br /><br />If you have any comments, queries or concerns regarding our Returns Policy, please <a href="index.php?main_page=contact_us">let us know</a>.<br /><br /><br />');

define('TEXT_SUCCESS_RMA_REFERENCE', 'Your reference number for this request is: ');

define('TEXT_SUCCESS_RMA_THANKS', 'Thank you for your feedback.<br /><br />');

3) In \includes\modules\pages\returns\header_php.php, the date format "mdY" can be changed as commented in the following snippet

$rma_request_date = date('mdY'); // Ymd or even Ymd H:i:s

Cheers