Can users see their registration?

[jansteenstra822]

We have an OCS up and running for some months and have just implemented the registration and payment modules.

Registration works fine. Users can choose several registration types with several options. As administrator, we are able to view these registrations in the registration manager. We were wondering, though, how and if users could see their registration type and options.

Thanks in advance.

[tshore]

I have created a receipt page. I find that PayPal's receipts aren't detailed enough. This is where I have people returned to the website from PayPal (or whatever payment gateway is used). And then, after that, if they click on the registration link, they will be taken to the receipt page. Here are a couple of examples:

Picture 6.png (126.19 KiB) Viewed 3024 times

Picture 7.png (146.22 KiB) Viewed 3024 times

[jansteenstra822]

That was exactly what I am talking about. It looks very neat. Now people can see what they registered for. I suppose you can't share the code for that?

[tshore]

I apologize for the delayed response. I've been having some email issues. I can try to share, but, as with anything in OCS, you generally need to touch multiple files, so I can't guarantee that I will be able to find everything for you.

Please let me know whether you're using OCS 2.1.2 or 2.3 so that I can give you the right code.

[RickMath]

Trudy

Your work on this is wonderful. Can you share the code? I running OCS 2.1.2 and will upgrade to OCS 2.3 over the summer.

I am sure I speak for others that would appreciate the above.

Thanks

Rick

[tshore]

Finally some code (OCS 2.3) for anyone that's still interested in this. Note that I had to append .txt onto the files as you aren't allowed to upload .php files.

I added a function:
/plugins/paymethod/paypal/PayPalPlugin.inc.php:displayPaymentReceipt (see attachment)

You have to add a function with the same name here:
/classes/payment/PaymentManager.inc.php:displayPaymentReceipt
(oops, in OCS 2.3.3 this has been moved to /lib/pkp/classes/payment 2010-12-13)

Code: Select all

   function displayPaymentReceipt() {
      $paymentPlugin =& $this->getPaymentPlugin();
      if ($paymentPlugin !== null && $paymentPlugin->isConfigured()) return $paymentPlugin->displayPaymentReceipt();
      return false;
   }

and here:
/classes/plugins/PaymethodPlugin.inc.php:displayPaymentReceipt

Code: Select all

   function displayPaymentReceipt() {
      die('ABSTRACT METHOD');
   }

Then you have to redirect people to the receipt page after they finish paying with paypal:
/plugins/paymethod/paypal/PayPalPlugin.inc.php:displayPaymentForm (see attachment)

Added this code in:
/pages/schedconf/SchedConfHandler.inc.php:registration (attached)

Code: Select all

         // MOHSHO 2008: added /displayReceipt to end of URL so that people could get a receipt
         if (in_array('displayReceipt', $args) || $registration->getDatePaid())  {
            $paymentManager->displayPaymentReceipt();
            exit();
         }

I added a few lines in the PayPal locale file (see attached, search for receipt):
/plugins/paymethod/paypal/locale/en_US/locale.xml

I will continue in a 2nd post. There is a max of 3 attachments per post...

[tshore]

Create a new template file for the receipt page:
/plugins/paymethod/paypal/templates/paymentReceipt.tpl (attached)

Oh, and that might be it. There may be other things that you had to do, but that's all I could find. I hope someone finds this to be useful.

[tshore]

I think that there are more changes required - sorry.

I just noticed that /plugins/paymethod/paypal/templates/paymentReceipt.tpl calls a new function:

/classes/registration/Registration.inc.php:getAmountPaid().

Code: Select all

   /**
    * Get registration amount paid.
    * @return int
    */
   function getAmountPaid() {
      return $this->getData('amountPaid');
   }
   
   /**
    * Set registration amount paid.
    * @param $amountPaid int
    */
   function setAmountPaid($amountPaid) {
      return $this->setData('amountPaid', $amountPaid);
   }

You also need to add a field in the registrations DB table:

Code: Select all

ALTER TABLE `registrations`
ADD `amount_paid` BIGINT( 20 ) DEFAULT '0' AFTER `date_paid`;

Also need to add this line:

Code: Select all

   $registration->setAmountPaid($queuedPayment->getAmount());

to the function /classes/payment/ocs/OCSPaymentManager.inc.php:fulfillQueuedPayment

And there may be more...

[r2d2]

Hi Trudy,

Thank you for this valuable contribution. In addition to above, the following is also necessary:

In \classes\registration\RegistrationDAO.inc.php, add the following line to approximately line 154. This is necessary to display the amount paid on the page:

Code: Select all

$registration->setAmountPaid($row['amount_paid']);

Also, both of the following functions need to be updated as below with amount_paid and related variables:

Code: Select all

   /**
    * Insert a new Registration.
    * @param $registration Registration
    * @return boolean
    */
   function insertRegistration(&$registration) {
      $ret = $this->update(
         sprintf('INSERT INTO registrations
            (sched_conf_id, user_id, type_id, date_registered, date_paid, amount_paid, membership, domain, ip_range, special_requests)
            VALUES
            (?, ?, ?, %s, %s, ?, ?, ?, ?, ?)',
            $this->dateToDB($registration->getDateRegistered()), $this->dateToDB($registration->getDatePaid())),
         array(
            $registration->getSchedConfId(),
            $registration->getUserId(),
            $registration->getTypeId(),
            $registration->getAmountPaid(),
            $registration->getMembership(),
            $registration->getDomain(),
            $registration->getIPRange(),
            $registration->getSpecialRequests()
         )
      );
      $registration->setId($this->getInsertRegistrationId());
      return $registration->getId();
   }

   /**
    * Update an existing registration.
    * @param $registration Registration
    * @return boolean
    */
   function updateRegistration(&$registration) {
      return $this->update(
         sprintf('UPDATE registrations
            SET
               sched_conf_id = ?,
               user_id = ?,
               type_id = ?,
               date_registered = %s,
               date_paid = %s,
               amount_paid = ?,
               membership = ?,
               domain = ?,
               ip_range = ?,
               special_requests = ?
            WHERE registration_id = ?',
            $this->dateToDB($registration->getDateRegistered()), $this->dateToDB($registration->getDatePaid())),
         array(
            $registration->getSchedConfId(),
            $registration->getUserId(),
            $registration->getTypeId(),
            $registration->getAmountPaid(),
            $registration->getMembership(),
            $registration->getDomain(),
            $registration->getIPRange(),
            $registration->getSpecialRequests(),
            $registration->getId()
         )
      );
   }

[r2d2]

Hi Trudy,

Inserting the amount_paid variable as above only shows the amount for the Registration Type, without adding each Registration Options to this amount. I guess we need to use the totalFees variable as you defined in paymentReceipt.tpl. I couldn't make it work though. Could you please briefly tell me how you did it?

[tshore]

Hmmm. This should be taken care of in an unmodified version of OCS, no? I can see where it's calculated in classes/registration/form/UserRegistrationForm.inc.php.

I think I also made some changes in:

/classes/payment/ocs/OCSQueuedPayment.inc.php

but I think that this just reworks the description sent to PayPal. I've attached a copy of this file from OCS 2.3.3.

OCSQueuedPayment.inc.php.txt

/classes/payment/ocs/OCSQueuedPayment.inc.php

(2.8 KiB) Downloaded 78 times

[r2d2]

Hi Trudy,

Thanks for a quick reply.Yes, I have applied your customization to an unmodified version of OCS 2.3.3.

The OCSQueuedPayment.inc.php file you have just posted is the same as the one you posted earlier. The only slight difference is that it displays the prices of options on the browser, without making any calculations. This does not address the issue.

I have just realized that no matter what the total fee is, the system always enters '1' in to the amount_paid column of the registrations table. Since the default value of "amount_paid" is '0', that means the system does write in to the amount_paid column. But it writes it as a binary value (I guess). Here, '1' should mean 'exists'. I suspect I need to define the "amount_paid" variable in \classes\registration\RegistrationDAO.inc.php here:

Code: Select all


import('registration.Registration');
import('registration.RegistrationType');

define('REGISTRATION_DATE_REGISTERED',   0x01);
define('REGISTRATION_DATE_PAID',   0x02);

define('REGISTRATION_USER',      0x01);
define('REGISTRATION_MEMBERSHIP',   0x02);
define('REGISTRATION_DOMAIN',      0x03);
define('REGISTRATION_IP_RANGE',      0x04);


I do not know what these numbers are (hexadecimals?). How should we define the amount_paid vairable here?

Thanks again.

[tshore]

Sorry about re-posting the same file. Did a search on the page for that file and my browser didn't find it, so I thought that I hadn't included it before...

You don't need to define a new variable at the top of RegistrationDAO.inc.php.

Is it possible that you aren't completing your test payments? Nothing is written to the amount_paid field in the registrations table until the PayPal IPN is received. So you need to complete a transaction all the way to the end (either using a real PayPal payment or a Sandbox payment) for the amount_paid field to contain the correct amount.

[r2d2]

I have actually made 5-6 real payments using my credit card. The system successfully receives PayPal IPN message, and then inserts '1' (rather than the totalFees) into the amount_paid field. I wonder which file(s) are responsible for transferring the total fees variable received via the PayPal IPN message. PayPal communicates with the system via IPN, and transfers that variable to the system, but I am not sure where (and how) the system writes it in to the registrations database. I have been hair pulling with this single issue for two days without luck.

[tshore]

PayPalPlugin.inc.php does this:

Code: Select all

                     // Fulfill the queued payment.
                     if ($ocsPaymentManager->fulfillQueuedPayment($queuedPaymentId, $queuedPayment)) {


which is in OCSPaymentManager.inc.php and it does this:

Code: Select all

            $registration->setAmountPaid($queuedPayment->getAmount());
            $registrationDao->updateRegistration($registration);


And the actual writing to the DB is in RegistrationDAO.inc.php:

Code: Select all

   function updateRegistration(&$registration) {
      return $this->update(
         sprintf('UPDATE registrations
            SET
               sched_conf_id = ?,
               user_id = ?,
               type_id = ?,
               date_registered = %s,
               date_paid = %s,
               payment_method = ?,
               amount_paid = ?,
               membership = ?,
               domain = ?,
               ip_range = ?,
               special_requests = ?
            WHERE registration_id = ?',
            $this->dateToDB($registration->getDateRegistered()), $this->dateToDB($registration->getDatePaid())),
         array(
            $registration->getSchedConfId(),
            $registration->getUserId(),
            $registration->getTypeId(),
            $registration->getPaymentMethod(),
            $registration->getAmountPaid(),
            $registration->getMembership(),
            $registration->getDomain(),
            $registration->getIPRange(),
            $registration->getSpecialRequests(),
            $registration->getId()
         )
      );
   }