setup

README

@@ -0,0 +1,160 @@
+SEPA SDD (Sepa Direct Debit) 1.0
+-----------------------------------
+Author: 	Congressus, The Netherlands
+Date:		14-05-2013
+Description:	A PHP class to create Sepa Direct Debit XML Files
+-----------------------------------
+
+1. INSTALLATION
+
+SEPA SDD requires PHP 5, no other libraries are required.
+
+To install, copy the SEPASDD.php class to a folder on the webserver and include it as follows:
+
+```php
+require_once([path_from_webroot_to_folder]/SEPASDD.php);
+```
+
+2. CONFIGURATION
+
+SEPA SSD requires a config array, which is validated on initiation.
+The following parameters are required:
+
+- name:		    The name of the creditor('s organization).
+- IBAN: 	    The creditor's International Bank Account Number.
+- BIC:		    The creditor's Bank Identification Code.
+- batch:	    Whether to process as batch or as individual transactions .
+		        Allowed: "true" or "false".
+- creditor_id:	The creditor's id, contact your bank if you do not know this.
+- currency:	    The currency in which the amounts are defined. 
+		    Allowed: ISO 4217.
+
+Example:
+
+```php
+$config = array("name" => "Test",
+                "IBAN" => "NL50BANK1234567890",
+                "BIC" => "BANKNL2A",
+                "batch" => "true",
+                "creditor_id" => "00000",
+                "currency" => "EUR"
+                );
+```
+
+3. USAGE
+
+3.1 Initialization
+
+Create an instance of the class with an configuration as such:
+
+```php
+try{
+    $SEPASDD = new SEPASDD($config);
+}catch(Exception $e){
+    echo $e->getMessage();
+}
+```
+
+3.2 Create a payment
+
+SEPA SDD uses the addPayment method for creating payments, it requires a payment array.
+The following parameters are required:
+
+- name:			    The debtors name.
+- IBAN: 		    The debtor's International Bank Account Number.
+- BIC:			    The debtor's Bank Identification Code.
+- amount:		    The amount to transfer from debtor to creditor (IN CENTS).
+			        Allowed: integers (NO SEPARATORS) e.g. EUR 10.00 has to be entered as 1000
+- type:			    The type of Direct Debit Transaction
+			        Allowed: FRST (First), RCUR (Recurring), OOFF (One Off), FNAL (Final)
+- collection_date:  The date at which the amount should be collected from the debtor.
+                    Allowed: ISO 8601 (YYYY-MM-DD). This date should be in the future, how far in
+                             the future is dependent on the type of Direct Debit. See the definition.
+- mandate_id:       The ID of the written mandate from the debtor.
+- mandate_date:     The date the mandate was signed.
+                    Allowed: ISO 8601 (YYYY-MM-DD). For mandates before SEPA requirements this is: 2009-11-01.
+- description:      The description of the transaction.
+
+Example:
+
+```php
+$payment = array("name" => "Test von Testenstein",
+                 "IBAN" => "NL50BANK1234567890",
+                 "BIC" => "BANKNL2A",
+                 "amount" => "1000",
+                 "type" => "FRST",
+                 "collection_date" => "2013-07-12",
+                 "mandate_id" => "1234",
+                 "mandate_date" => "2009-11-01",
+                 "description" => "Test Transaction"
+                );                
+```
+
+Then use the addPayment method to add the payment to the file:
+
+Example:
+
+```php
+try{
+    $SEPASDD->addPayment($payment);
+}catch(Exception $e){
+    echo $e->getMessage();
+}
+```
+
+You can use this method multiple times to add more payments.
+
+3.3 Save the file
+
+To save the file, use the "save" method, this will return the XML as a string.
+If you want to save to file, you have to do this yourself.
+
+Example:
+
+```php
+try{
+    $SEPASDD->save();
+}catch(Exception $e){
+    echo $e->getMessage();
+}
+```
+
+After this, please reinitialize the class if you want to create another file.
+
+3.4 Adding custom fields
+
+SEPA SDD has a special method for adding custom fields. This method is called addCustomNode.
+The required arguments are:
+
+- parent_XPATH:     The XPATH selector of the parent.
+- name:             The node/tag name.
+- value:            Its value, default "".
+- attr:             An array containing key => value pairs defining the attributes.
+
+4 LICENSE
+
+MIT LICENSE
+
+ Copyright (c) 2013 Congressus, The Netherlands
+
+ Permission is hereby granted, free of charge, to any person
+ obtaining a copy of this software and associated documentation
+ files (the "Software"), to deal in the Software without
+ restriction, including without limitation the rights to use,
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following
+ conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ OTHER DEALINGS IN THE SOFTWARE. 
+