http://www.mediawiki.org/wiki/Special:Code/MediaWiki/73698

Revision: 73698
Author:   kaldari
Date:     2010-09-25 01:40:56 +0000 (Sat, 25 Sep 2010)

Log Message:
-----------
form refactoring - first pass

Modified Paths:
--------------
    
trunk/extensions/DonationInterface/payflowpro_gateway/extras/recaptcha/recaptcha.body.php
    trunk/extensions/DonationInterface/payflowpro_gateway/forms/Form.php
    trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumn.php
    
trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumnLetter.php
    
trunk/extensions/DonationInterface/payflowpro_gateway/payflowpro_gateway.body.php

Modified: 
trunk/extensions/DonationInterface/payflowpro_gateway/extras/recaptcha/recaptcha.body.php
===================================================================
--- 
trunk/extensions/DonationInterface/payflowpro_gateway/extras/recaptcha/recaptcha.body.php
   2010-09-25 01:12:49 UTC (rev 73697)
+++ 
trunk/extensions/DonationInterface/payflowpro_gateway/extras/recaptcha/recaptcha.body.php
   2010-09-25 01:40:56 UTC (rev 73698)
@@ -55,7 +55,7 @@
                global $wgOut;
                $form_class = $pfp_gateway_object->getFormClass();
                $form_obj = new $form_class( $data, $pfp_gateway_object->errors 
);
-               $form = $form_obj->generateFormBody( $data, 
$pfp_gateway_object->errors );
+               $form = $form_obj->generateFormStart( $data, 
$pfp_gateway_object->errors );
                $form .= Xml::openElement( 'div', array( 'id' => 
'mw-donate-captcha' ));
 
                // get the captcha
@@ -63,8 +63,10 @@
                $use_ssl = ( $wgProto == 'https' ) ? TRUE : FALSE;
                $form .= recaptcha_get_html( $wgPayflowRecaptchaPublicKey, 
$this->recap_err, $use_ssl );
                $form .= '<span class="creditcard-error-msg">' . wfMsg( 
'payflowpro_gateway-error-msg-captcha-please') . '</span>';
-               $form .= Xml::closeElement( 'div' );
+               
+               $form .= Xml::closeElement( 'div' ); // close 
div#mw-donate-captcha
                $form .= $form_obj->generateFormSubmit( $data, 
$pfp_gateway_object->errors );
+               $form .= $form_obj->generateFormEnd( $data, 
$pfp_gateway_object->errors );
                $wgOut->addHTML( $form );
        }
 

Modified: trunk/extensions/DonationInterface/payflowpro_gateway/forms/Form.php
===================================================================
--- trunk/extensions/DonationInterface/payflowpro_gateway/forms/Form.php        
2010-09-25 01:12:49 UTC (rev 73697)
+++ trunk/extensions/DonationInterface/payflowpro_gateway/forms/Form.php        
2010-09-25 01:40:56 UTC (rev 73698)
@@ -26,8 +26,9 @@
         */
        public $form_errors;
 
-       abstract public function generateFormBody();
+       abstract public function generateFormStart();
        abstract public function generateFormSubmit();
+       abstract public function generateFormEnd();
        
        public function __construct( &$data, &$error ) {
                global $wgPayflowGatewayTest;
@@ -38,6 +39,26 @@
        }
        
        /**
+        * Generates the donation footer ("There are other ways to give...")
+        * @returns string of HTML
+        */
+       public function generateDonationFooter() {
+               global $wgScriptPath;
+               $form = '';
+               $form .= Xml::openElement( 'div', array( 'class' => 
'payflow-cc-form-section', 'id' => 'payflowpro_gateway-donate-addl-info' ));
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-donate-addl-info-secure-logos' ));
+               $form .= Xml::tags( 'p', array( 'class' => '' ), 
Xml::openElement( 'img', array( 'src' => $wgScriptPath . 
"/extensions/DonationInterface/payflowpro_gateway/includes/rapidssl_ssl_certificate.gif"
 ))); 
+               $form .= Xml::closeElement( 'div' ); // close 
div#payflowpro_gateway-donate-addl-info-secure-logos
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-donate-addl-info-text' ));
+               $form .= Xml::tags( 'p', array( 'class' => '' ), wfMsg( 
'payflowpro_gateway-otherways' ));
+               $form .= Xml::tags( 'p', array( 'class' => '' ), wfMsg( 
'payflowpro_gateway-credit-storage-processing' ) );
+               $form .= Xml::tags( 'p', array( 'class' => ''), wfMsg( 
'payflowpro_gateway-question-comment' ) );
+               $form .= Xml::closeElement( 'div' ); // close 
div#payflowpro_gateway-donate-addl-info-text
+               $form .= Xml::closeElement( 'div' ); // close 
div#payflowpro_gateway-donate-addl-info
+               return $form;
+       }
+       
+       /**
         * Fetch the array of iso country codes => country names
         * @return array
         */

Modified: 
trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumn.php
===================================================================
--- trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumn.php   
2010-09-25 01:12:49 UTC (rev 73697)
+++ trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumn.php   
2010-09-25 01:40:56 UTC (rev 73698)
@@ -6,58 +6,70 @@
                parent::__construct( $form_data, $form_errors );
        }
        
-       public function generateFormBody() {
+       public function generateFormStart() {
                global $wgPayflowGatewayHeader, $wgPayflwGatewayTest, $wgOut;
                $form = $this->generateBannerHeader();
                
-               $form .= $this->generatePersonalContainerTop();
-               $form .= $this->generatePersonalFields();
+               $form .= Xml::openElement( 'div', array( 'id' => 
'mw-creditcard' ) ); /*.
+                       Xml::openElement( 'div', array( 'id' => 
'mw-creditcard-intro' ) ) .
+                       Xml::tags( 'p', array( 'class' => 
'mw-creditcard-intro-msg' ), wfMsg( 'payflowpro_gateway-form-message' ) ) .
+                       Xml::closeElement( 'div' );*/
+       
+               // provide a place at the top of the form for displaying 
general messages
+               if ( $this->form_errors['general'] ) {
+                       $form .= Xml::openElement( 'div', array( 'id' => 
'mw-payflow-general-error' ));
+                       if ( is_array( $this->form_errors['general'] )) {
+                               foreach ( $this->form_errors['general'] as 
$this->form_errors_msg ) {
+                                       $form .= Xml::tags( 'p', array( 'class' 
=> 'creditcard-error-msg' ), $this->form_errors_msg );
+                               }
+                       } else {
+                               $form .= Xml::tags( 'p', array( 'class' => 
'creditcard-error-msg' ), $this->form_errors_msg );
+                       }
+                       $form .= Xml::closeElement( 'div' );
+               }
 
-               $form .= Xml::closeElement( 'table' );
-               $form .= Xml::closeElement( 'div' );
+               // open form
+               $form .= Xml::openElement( 'div', array( 'id' => 
'mw-creditcard-form' ) );
+               // Xml::element seems to convert html to htmlentities
+               $form .= "<p class='creditcard-error-msg'>" . 
$this->form_errors['retryMsg'] . "</p>";
+               $form .= Xml::openElement( 'form', array( 'name' => 'payment', 
'method' => 'post', 'action' => '', 'onsubmit' => 'return validate_form(this)', 
'autocomplete' => 'off' ) );
                
-               $form .= $this->generatePaymentContainerTop();
-               $form .= $this->generatePaymentFields();
-
-               $form .= Xml::closeElement( 'table' ); 
+               $form .= Xml::openElement( 'div', array( 'id' => 'left-column', 
'class' => 'payflow-cc-form-section'));
+               $form .= $this->generatePersonalContainer();
+               $form .= Xml::closeElement( 'div' ); // close div#left-column
+               
+               $form .= Xml::openElement( 'div', array( 'id' => 
'right-column', 'class' => 'payflow-cc-form-section' ));
+               $form .= $this->generatePaymentContainer();
+               
                return $form;
        }
 
        public function generateFormSubmit() {
-               global $wgScriptPath;
-               // submit button and close form
+               // submit button
                $form = Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-form-submit'));
                $form .= Xml::openElement( 'div', array( 'id' => 
'mw-donate-submit-button' ));  
                //$form .= Xml::submitButton( wfMsg( 
'payflowpro_gateway-submit-button' ));
                $form .= Xml::element( 'input', array( 'class' => 'input-button 
button-navyblue', 'value' => wfMsg( 'payflowpro_gateway-submit-button'), 
'onclick' => 'submit_form( this )', 'type' => 'submit'));
-               $form .= Xml::closeElement( 'div' );
+               $form .= Xml::closeElement( 'div' ); // close 
div#mw-donate-submit-button
                $form .= Xml::openElement( 'div', array( 'class' => 
'mw-donate-submessage', 'id' => 'payflowpro_gateway-donate-submessage' ) ) .
                        wfMsg( 'payflowpro_gateway-donate-click' ); 
-               $form .= Xml::closeElement( 'div' );
-               $form .= Xml::closeElement( 'div' );
+               $form .= Xml::closeElement( 'div' ); // close 
div#payflowpro_gateway-donate-submessage
+               $form .= Xml::closeElement( 'div' ); // close 
div#payflowpro_gateway-form-submit
+               return $form;
+       }
+       
+       public function generateFormEnd() {
+               $form = '';
                // add hidden fields                    
                $hidden_fields = $this->getHiddenFields();
                foreach ( $hidden_fields as $field => $value ) {
                        $form .= Xml::hidden( $field, $value );
                }
-                       
+               $form .= Xml::closeElement( 'div' ); // close div#right-column
                $form .= Xml::closeElement( 'form' );
-
-               $form .= Xml::openElement( 'div', array( 'class' => 
'payflow-cc-form-section', 'id' => 'payflowpro_gateway-donate-addl-info' ));
-               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-donate-addl-info-secure-logos' ));
-               
-               $form .= Xml::tags( 'p', array( 'class' => '' ), 
Xml::openElement( 'img', array( 'src' => $wgScriptPath . 
"/extensions/DonationInterface/payflowpro_gateway/includes/rapidssl_ssl_certificate.gif"
 ))); 
-               $form .= Xml::closeElement( 'div' );
-               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-donate-addl-info-text' ));
-               $form .= Xml::tags( 'p', array( 'class' => '' ), wfMsg( 
'payflowpro_gateway-otherways' ));
-               $form .= Xml::tags( 'p', array( 'class' => '' ), wfMsg( 
'payflowpro_gateway-credit-storage-processing' ) );
-               $form .= Xml::tags( 'p', array( 'class' => ''), wfMsg( 
'payflowpro_gateway-question-comment' ) );
-               $form .= Xml::closeElement( 'div' );
-               $form .= Xml::closeElement( 'div' );
-
-               $form .= Xml::closeElement( 'div' );
-               $form .= Xml::closeElement( 'div' );
-               $form .= Xml::closeElement( 'div' );
+               $form .= Xml::closeElement( 'div' ); // close 
div#mw-creditcard-form
+               $form .= $this->generateDonationFooter();
+               $form .= Xml::closeElement( 'div' ); // div#close mw-creditcard
                return $form;
        }
 
@@ -70,33 +82,16 @@
                }       
        }
 
-       protected function generatePersonalContainerTop() {
-               $form = Xml::openElement( 'div', array( 'id' => 'mw-creditcard' 
) ); /*.
-                       Xml::openElement( 'div', array( 'id' => 
'mw-creditcard-intro' ) ) .
-                       Xml::tags( 'p', array( 'class' => 
'mw-creditcard-intro-msg' ), wfMsg( 'payflowpro_gateway-form-message' ) ) .
-                       Xml::closeElement( 'div' );*/
-       
-               // provide a place at the top of the form for displaying 
general messages
-               if ( $this->form_errors['general'] ) {
-                       $form .= Xml::openElement( 'div', array( 'id' => 
'mw-payflow-general-error' ));
-                       if ( is_array( $this->form_errors['general'] )) {
-                               foreach ( $this->form_errors['general'] as 
$this->form_errors_msg ) {
-                                       $form .= Xml::tags( 'p', array( 'class' 
=> 'creditcard-error-msg' ), $this->form_errors_msg );
-                               }
-                       } else {
-                               $form .= Xml::tags( 'p', array( 'class' => 
'creditcard-error-msg' ), $this->form_errors_msg );
-                       }
-                       $form .= Xml::closeElement( 'div' );
-               }
-
-               // open form and table
-               $form .= Xml::openElement( 'div', array( 'id' => 
'mw-creditcard-form' ) );
-               // Xml::element seems to convert html to htmlentities
-               $form .= "<p class='creditcard-error-msg'>" . 
$this->form_errors['retryMsg'] . "</p>";
-               $form .= Xml::openElement( 'form', array( 'name' => 'payment', 
'method' => 'post', 'action' => '', 'onsubmit' => 'return validate_form(this)', 
'autocomplete' => 'off' ) );
-               $form .= Xml::openElement( 'div', array( 'class' => 
'payflow-cc-form-section', 'id' => 'payflowpro_gateway-personal-info' ));       
            ;
+       protected function generatePersonalContainer() {
+               $form = '';
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-personal-info' ));                 ;
                $form .= Xml::tags( 'h3', array( 'class' => 
'payflow-cc-form-header','id' => 'payflow-cc-form-header-personal' ), wfMsg( 
'payflowpro_gateway-cc-form-header-personal' ));
                $form .= Xml::openElement( 'table', array( 'id' => 
'payflow-table-donor' ) );
+               
+               $form .= $this->generatePersonalFields();
+               
+               $form .= Xml::closeElement( 'table' ); // close 
table#payflow-table-donor
+               $form .= Xml::closeElement( 'div' ); // close 
div#payflowpro_gateway-personal-info
 
                return $form;
        }
@@ -167,11 +162,17 @@
                return $form;
        }
 
-       protected function generatePaymentContainerTop() {
+       protected function generatePaymentContainer() {
+               $form = '';
                // credit card info
-               $form = Xml::openElement( 'div', array( 'class' => 
'payflow-cc-form-section', 'id' => 'payflowpro_gateway-payment-info' ));
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-payment-info' ));
                $form .= Xml::tags( 'h3', array( 'class' => 
'payflow-cc-form-header', 'id' => 'payflow-cc-form-header-payment' ), wfMsg( 
'payflowpro_gateway-cc-form-header-payment' ));
                $form .= Xml::openElement( 'table', array( 'id' => 
'payflow-table-cc' ) );
+               
+               $form .= $this->generatePaymentFields();
+               
+               $form .= Xml::closeElement( 'table' ); // close 
table#payflow-table-cc
+               $form .= Xml::closeElement( 'div' ); // close 
div#payflowpro_gateway-payment-info
 
                return $form;
        }

Modified: 
trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumnLetter.php
===================================================================
--- 
trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumnLetter.php 
    2010-09-25 01:12:49 UTC (rev 73697)
+++ 
trunk/extensions/DonationInterface/payflowpro_gateway/forms/TwoColumnLetter.php 
    2010-09-25 01:40:56 UTC (rev 73698)
@@ -12,42 +12,48 @@
                $this->updateHiddenFields();
         }
 
-        public function generateFormBody() {
-                global $wgOut, $wgRequest;
-                $form = parent::generateBannerHeader();
-                
-                $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-cc_form_container'));
-                
-                $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-cc_form_form', 'class' => 
'payflowpro_gateway-cc_form_column'));
-                               $form .= Xml::Tags( 'p', array( 'id' => 
'payflowpro_gateway-cc_otherways' ), wfMsg( 'payflowpro_gateway-otherways' ));
-                               $form .= parent::generatePersonalContainerTop();
-                $form .= parent::generatePersonalFields();
-                $form .= Xml::closeElement( 'table' );
-                $form .= Xml::closeElement( 'div' );
-                $form .= parent::generatePaymentContainerTop();
-                $form .= parent::generatePaymentFields();
-                $form .= Xml::closeElement( 'table' );
-                       $form .= Xml::closeElement( 'div' ); 
+       public function generateFormStart() {
+               global $wgOut, $wgRequest;
+               $form = parent::generateBannerHeader();
+               
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-cc_form_container'));
+               
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-cc_form_form', 'class' => 
'payflowpro_gateway-cc_form_column'));
+               $form .= Xml::Tags( 'p', array( 'id' => 
'payflowpro_gateway-cc_otherways' ), wfMsg( 'payflowpro_gateway-otherways' ));
+               $form .= parent::generatePersonalContainer();
+               $form .= parent::generatePaymentContainer();
                $form .= $this->generateCommentFields();
                return $form;
-        }
+       }
+        
+       public function generateFormEnd() {
+               global $wgRequest, $wgOut;
+               $form = '';
+               // add hidden fields                    
+               $hidden_fields = $this->getHiddenFields();
+               foreach ( $hidden_fields as $field => $value ) {
+                       $form .= Xml::hidden( $field, $value );
+               }
+                       
+               $form .= Xml::closeElement( 'form' );
 
-        public function generateFormSubmit() {
-                global $wgRequest, $wgOut;
-                $form = parent::generateFormSubmit();  
+               $form .= $this->generateDonationFooter();
 
-                $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-cc_form_letter', 'class' => 
'payflowpro_gateway-cc_form_column'));
-                               $form .= Xml::openElement( 'div', array( 'id' 
=> 'payflowpro_gateway-cc_form_letter_inside' ));
-                $text_template = $wgRequest->getText( 'text_template' );
-                if ( $wgRequest->getText( 'language' )) $text_template .= '/' 
. $wgRequest->getText( 'language' );
-                
-                $form .= ( strlen( $text_template )) ? $wgOut->parse( 
'{{'.$text_template.'}}' ) : '';
-                               $form .= Xml::closeElement( 'div' );
-                $form .= Xml::closeElement( 'div' );
-                       $form .= Xml::closeElement( 'div' );
-                return $form;
-        }
+               $form .= Xml::closeElement( 'div' );
+               $form .= Xml::closeElement( 'div' );
+               $form .= Xml::closeElement( 'div' );
 
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-cc_form_letter', 'class' => 
'payflowpro_gateway-cc_form_column'));
+               $form .= Xml::openElement( 'div', array( 'id' => 
'payflowpro_gateway-cc_form_letter_inside' ));
+               $text_template = $wgRequest->getText( 'text_template' );
+               if ( $wgRequest->getText( 'language' )) $text_template .= '/' . 
$wgRequest->getText( 'language' );
+               
+               $form .= ( strlen( $text_template )) ? $wgOut->parse( 
'{{'.$text_template.'}}' ) : '';
+               $form .= Xml::closeElement( 'div' );
+               $form .= Xml::closeElement( 'div' );
+               return $form;
+       }
+
        public function generateCommentFields() {
                $form = Xml::openElement( 'div', array( 'class' => 
'payflow-cc-form-section', 'id' => 'payflowpro_gateway-comment_form' ));
                $form .= Xml::tags( 'h3', array( 'class' => 
'payflow-cc-form-header', 'id' => 'payflow-cc-form-header-comments' ), wfMsg( 
'donate_interface-comment-title' ));

Modified: 
trunk/extensions/DonationInterface/payflowpro_gateway/payflowpro_gateway.body.php
===================================================================
--- 
trunk/extensions/DonationInterface/payflowpro_gateway/payflowpro_gateway.body.php
   2010-09-25 01:12:49 UTC (rev 73697)
+++ 
trunk/extensions/DonationInterface/payflowpro_gateway/payflowpro_gateway.body.php
   2010-09-25 01:40:56 UTC (rev 73698)
@@ -194,8 +194,9 @@
        
                $form_class = $this->getFormClass();
                $form_obj = new $form_class( $data, $error );   
-               $form = $form_obj->generateFormBody();
+               $form = $form_obj->generateFormStart();
                $form .= $form_obj->generateFormSubmit();
+               $form .= $form_obj->generateFormEnd();
                $wgOut->addHTML( $form );
        }
 



_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs

Reply via email to