[net.nemein.payment] element index

Package indexes

All elements
f g h i m n p r _
_
top
Variable $_account
net_nemein_payment_handler_paypal::$_account in paypal.php
The PayPal account to use (this is an E-Mail address).
Variable $_additional_options
net_nemein_payment_handler_paypal::$_additional_options in paypal.php
Additional options to pass to PayPal, see class introduction for details.
Variable $_amount
net_nemein_payment_handler::$_amount in handler.php
The amount that is being invoiced.
Variable $_amount_string
net_nemein_payment_handler_nordea::$_amount_string in nordea.php
String representation of the amount used in interaction with the Nordea servers.
Variable $_authentication_seed
net_nemein_payment_handler_paypal::$_authentication_seed in paypal.php
The seed used to secure the MD5 sum of the payment reference and amount.
Variable $_backend
net_nemein_payment_handler_paypal::$_backend in paypal.php
The PayPal Backend to use, this is either 'live', 'sandbox' or a full URL.
Variable $_cancel_url
net_nemein_payment_handler_nordea::$_cancel_url in nordea.php
Return address if payment was cancelled.
Variable $_currency
net_nemein_payment_handler_paypal::$_currency in paypal.php
The currency to use.
Variable $_currency
net_nemein_payment_handler_nordea::$_currency in nordea.php
Currency code, Nordea currently only supports EUR.
Variable $_date
net_nemein_payment_handler_nordea::$_date in nordea.php
Payment due date.
Variable $_handler_config
net_nemein_payment_handler::$_handler_config in handler.php
The handler configuration array.
Variable $_key_version
net_nemein_payment_handler_nordea::$_key_version in nordea.php
Key version (I suspect that this relates to the MAC).
Variable $_language
net_nemein_payment_handler_nordea::$_language in nordea.php
Payment interface language (1 = Finnish, 2 = Swedish, 3 = English).
Variable $_local_cert
net_nemein_payment_handler_paypal::$_local_cert in paypal.php
The path to the X.509 certificate used to sign the requests to PayPal.
Variable $_local_cert_id
net_nemein_payment_handler_paypal::$_local_cert_id in paypal.php
The Certificate ID assigend by PayPal when uploading the certificate.
Variable $_local_key
net_nemein_payment_handler_paypal::$_local_key in paypal.php
The path to the X.509 private key used to sign the requests to PayPal.
Variable $_local_key_password
net_nemein_payment_handler_paypal::$_local_key_password in paypal.php
Contains the password required to access the local key, if set.
Variable $_mac
net_nemein_payment_handler_nordea::$_mac in nordea.php
The Message authentication code, computed as outlined in Chapter 3.3 of the Nordea specs. This is an MD5 sum.
Variable $_message
net_nemein_payment_handler::$_message in handler.php
An arbitary message to the user, shown during payment processing (if supported by the payment handler).
Variable $_ok_url
net_nemein_payment_handler_nordea::$_ok_url in nordea.php
Return address following successful payment.
Variable $_payment_confirmation
net_nemein_payment_handler_nordea::$_payment_confirmation in nordea.php
Payment confirmation (YES adds additional, required information to the response).
Variable $_payment_reference
net_nemein_payment_handler_nordea::$_payment_reference in nordea.php
Payment reference number, constructed out of the reference id by adding the check digit.
Variable $_payment_reference_suffix
net_nemein_payment_handler_nordea::$_payment_reference_suffix in nordea.php
Payment reference number suffix, used to distinguish different installations from each other.
Variable $_paypal_cert
net_nemein_payment_handler_paypal::$_paypal_cert in paypal.php
The path to the X.509 certificate to use to encrypt the requests to PayPal. This must be a valid certificate parameter for the openssl PHP module.
Variable $_pdt_id_token
net_nemein_payment_handler_paypal::$_pdt_id_token in paypal.php
The PayPal identity token required for PDT access.
Variable $_rcv_account
net_nemein_payment_handler_nordea::$_rcv_account in nordea.php
Receiver Account, if different from the default.
Variable $_rcv_name
net_nemein_payment_handler_nordea::$_rcv_name in nordea.php
Service Provider Name, if different from the default.
Variable $_reference
net_nemein_payment_handler::$_reference in handler.php
The payment reference accociated with this record. The exact allowed characters for this field varies with the actual handler, refer to their class documentations for details.
Variable $_rejected_url
net_nemein_payment_handler_nordea::$_rejected_url in nordea.php
Return address if payment was rejected.
Variable $_request_args
net_nemein_payment_handler_paypal::$_request_args in paypal.php
This variable holds the arguments that should go into the request. It is build during the payment rendering and is rendered encrypted if possible.
Variable $_request_url
net_nemein_payment_handler_paypal::$_request_url in paypal.php
The request URL derived from the "backend" variable. This is always a full URL.
Variable $_response_payment_code
net_nemein_payment_handler_nordea::$_response_payment_code in nordea.php
The payment code as returned by the bank's system.
Variable $_return_url
net_nemein_payment_handler::$_return_url in handler.php
The URL to return to after processing the payment. This must be a fully qualified URL which calls the process_payment handler function.
Variable $_stamp
net_nemein_payment_handler_nordea::$_stamp in nordea.php
The stamp identifying the request. This is an unique number which is used to prevent double processing on the server side. It is built using the current timestamp and the order ID.
Variable $_version
net_nemein_payment_handler_nordea::$_version in nordea.php
Payment interface version.
Method _calculate_mac
net_nemein_payment_handler_nordea::_calculate_mac() in nordea.php
Calculates the message authentication code for the current request data.
Method _calculate_reference
net_nemein_payment_handler_nordea::_calculate_reference() in nordea.php
Calculates the payment reference number by adding the check digit as described in Chapter 3.2, Field number 8 in the Payment specification.
Method _calculate_stamp
net_nemein_payment_handler_nordea::_calculate_stamp() in nordea.php
Calculates the stamp for this payment, which has to be unique.
Method _check_mac
net_nemein_payment_handler_nordea::_check_mac() in nordea.php
Calculates the message authentication code from the return information and triggers an error, if it does not match the one supplied in the response (as stored in $_mac).
Method _detect_language
net_nemein_payment_handler_nordea::_detect_language() in nordea.php
Sync the Remote UI language with the language set by MidCOM.
Method _execute_pdt_request
net_nemein_payment_handler_paypal::_execute_pdt_request() in paypal.php
Executes an PDT request to the server determined by the _get_pdt_server helper.
Method _generate_return_urls
net_nemein_payment_handler_nordea::_generate_return_urls() in nordea.php
This helper generates the three (ok, cancel, reject) return urls for the current payment request. They are generated using the supplied return URL and pass a parameter by HTTP GET so that the result can be processed accordingly.
Method _get_message_digest
net_nemein_payment_handler_paypal::_get_message_digest() in paypal.php
This function computes the MD5 hash which secures the payment reference and the amount.
Method _get_pdt_server
net_nemein_payment_handler_paypal::_get_pdt_server() in paypal.php
Determines the server name to send PDT requests to.
Method _mask_text_strings
net_nemein_payment_handler_nordea::_mask_text_strings() in nordea.php
This helper masks text strings (currently only the user message is affected) so that it does not interfere with the surrounding HTML.
Method _on_process_payment
net_nemein_payment_handler_invoice::_on_process_payment() in invoice.php
Process the payment and populate the payment status variables.
Method _on_process_payment
net_nemein_payment_handler::_on_process_payment() in handler.php
Process the payment and populate the payment status variables.
Method _on_process_payment
net_nemein_payment_handler_paypal::_on_process_payment() in paypal.php
Process the payment and populate the payment status variables.
Method _on_process_payment
net_nemein_payment_handler_nordea::_on_process_payment() in nordea.php
Processes the payment. Incomplete request arrays always result in a critical error, aborting execution.
Method _on_render_payment_link
net_nemein_payment_handler_invoice::_on_render_payment_link() in invoice.php
Renders the payment link, this is a simple href to the return URL.
Method _on_render_payment_link
net_nemein_payment_handler_paypal::_on_render_payment_link() in paypal.php
Renders the payment link.
Method _on_render_payment_link
net_nemein_payment_handler::_on_render_payment_link() in handler.php
Render the payment link for the current configuration.
Method _on_render_payment_link
net_nemein_payment_handler_nordea::_on_render_payment_link() in nordea.php
Renders the payment link, preparation in thie order:
Method _prepare_request_args
net_nemein_payment_handler_paypal::_prepare_request_args() in paypal.php
Prepares the request_args array to add the actual data. The array is initialized with the additional options field (thus any restricted option will be overwritten later) and is completed with the actual payment information.
Method _prepare_request_url
net_nemein_payment_handler_paypal::_prepare_request_url() in paypal.php
Determines the actual URL to send the request to.
Method _print
net_nemein_payment_handler_nordea::_print() in nordea.php
This helper prints the actual form to stdout.
Method _process_cancel
net_nemein_payment_handler_nordea::_process_cancel() in nordea.php
The payment has been cancelled by the user.
Method _process_ok
net_nemein_payment_handler_nordea::_process_ok() in nordea.php
The payment has been successful.
Method _process_ok
net_nemein_payment_handler_paypal::_process_ok() in paypal.php
Verifies the response by using PayPals Payment Data Transfer (PDT) service.
Method _process_reject
net_nemein_payment_handler_nordea::_process_reject() in nordea.php
The payment has been rejected by the bank.
Method _read_response
net_nemein_payment_handler_paypal::_read_response() in paypal.php
Reads all applicable information from the HTTP Request into the class. The message digest is not yet checked the PDT data is required to do that.
Method _read_response
net_nemein_payment_handler_nordea::_read_response() in nordea.php
Reads and verifies the response received from the Nordea server.
Method _render_encrypted
net_nemein_payment_handler_paypal::_render_encrypted() in paypal.php
Renders an encrypted request for paypal. Called if the corresponding certificates are set.
Method _render_plain
net_nemein_payment_handler_paypal::_render_plain() in paypal.php
Renders a plain unencrypted form for payment.
Method _validate_against_pdt
net_nemein_payment_handler_paypal::_validate_against_pdt() in paypal.php
This function validates the current response data using the PDT service of PayPal.
f
top
Page factory.php
factory.php in factory.php
g
top
Method get_instance
net_nemein_payment_factory::get_instance() in factory.php
Singelton interface, returns the factory instance.
h
top
Variable $handlers
net_nemein_payment_factory::$handlers in factory.php
The list of configured and constructed handlers. They are indexed automatically.
Page handler.php
handler.php in handler.php
i
top
Method initialize
net_nemein_payment_factory::initialize() in factory.php
Parses the configuration and initializes all concrete handler classes.
Page invoice.php
invoice.php in invoice.php
Page interfaces.php
interfaces.php in interfaces.php
m
top
Variable $machine_response
net_nemein_payment_handler::$machine_response in handler.php
Machine readable data about the processed payment. This is usually a serialized string.
Variable $message
net_nemein_payment_handler::$message in handler.php
Human readable message about the processed payment. It is recommended that you store this information at the related order.
n
top
Page nordea.php
nordea.php in nordea.php
Constant NET_NEMEIN_PAYMENT_CANCELLED
NET_NEMEIN_PAYMENT_CANCELLED in interfaces.php
Payment return code set when the user cancelled the payment.
Constant NET_NEMEIN_PAYMENT_ERROR
NET_NEMEIN_PAYMENT_ERROR in interfaces.php
Payment return code set when an internal, unrecoverable error was detected.
Class net_nemein_payment_factory
net_nemein_payment_factory in factory.php
Payment handler factory class.
Method net_nemein_payment_factory
net_nemein_payment_factory::net_nemein_payment_factory() in factory.php
Constructor, initialize base class.
Method net_nemein_payment_handler
net_nemein_payment_handler::net_nemein_payment_handler() in handler.php
Initializes the class, populates the config member variable.
Class net_nemein_payment_handler
net_nemein_payment_handler in handler.php
Payment handler base class.
Method net_nemein_payment_handler_invoice
net_nemein_payment_handler_invoice::net_nemein_payment_handler_invoice() in invoice.php
Constructor, relays to base class.
Class net_nemein_payment_handler_invoice
net_nemein_payment_handler_invoice in invoice.php
Simple payment handler used for having an "Pay by Invoice" alternative available.
Method net_nemein_payment_handler_nordea
net_nemein_payment_handler_nordea::net_nemein_payment_handler_nordea() in nordea.php
Constructor, relays to base class.
Class net_nemein_payment_handler_nordea
net_nemein_payment_handler_nordea in nordea.php
Nordea E-payment service payment handler
Method net_nemein_payment_handler_paypal
net_nemein_payment_handler_paypal::net_nemein_payment_handler_paypal() in paypal.php
Constructor, relays to base class.
Class net_nemein_payment_handler_paypal
net_nemein_payment_handler_paypal in paypal.php
PayPal Frontend for FORM based payments (does not use Web Services).
Method net_nemein_payment_interface
net_nemein_payment_interface::net_nemein_payment_interface() in interfaces.php
Class net_nemein_payment_interface
net_nemein_payment_interface in interfaces.php
Payment library MidCOM interface class.
Constant NET_NEMEIN_PAYMENT_OK
NET_NEMEIN_PAYMENT_OK in interfaces.php
Payment return code for a successful Payment.
Constant NET_NEMEIN_PAYMENT_OK_BUT_PENDING
NET_NEMEIN_PAYMENT_OK_BUT_PENDING in interfaces.php
Payment return code for an accepted Payment which has not been executed yet.
Constant NET_NEMEIN_PAYMENT_REJECTED
NET_NEMEIN_PAYMENT_REJECTED in interfaces.php
Payment return code for a Payment which has been rejected by the E-Banking service provider.
p
top
Page paypal.php
paypal.php in paypal.php
Method process_payment
net_nemein_payment_handler::process_payment() in handler.php
Processes the payment that has been rendered previously.
Method process_payment
net_nemein_payment_factory::process_payment() in factory.php
Processes the payment that has been invoked by a previous instance of this call.
r
top
Variable $result
net_nemein_payment_handler::$result in handler.php
Status code, one of NET_NEMEIN_PAYMENT_OK, NET_NEMEIN_PAYMENT_REJECTED, NET_NEMEIN_PAYMENT_CANCELLED or NET_NEMEIN_PAYMENT_ERROR.
Method render_payment_link
net_nemein_payment_handler::render_payment_link() in handler.php
Renders a link (this might be a FORM actually, so take this into account in your layout code) to pay the specified amount. The Return URL must lead to a piece of code which calls process_payment.
Method render_payment_links
net_nemein_payment_factory::render_payment_links() in factory.php
Renders a list of payment links for all configured handlers. The Return URL must lead to a piece of code which calls process_payment.
f g h i m n p r _