Payment_Clieop
[ class tree: Payment_Clieop ] [ index: Payment_Clieop ] [ all elements ]
Packages:
Payment_Clieop


Classes:
Payment_Clieop
Payment_Clieop_Transaction
Files:
Clieop.php
creditor.php
debtor.php
Transaction.php

Class: Payment_Clieop

Source Location: /Payment_Clieop-0.2.0/Payment/Clieop.php

Class Overview




Main clieop class




Author(s):






        
        

Version:


    
  
  • $Revision: 304715 $
    • 









Methods
















Inherited Variables





Inherited Methods














Class Details



[line 60]

Main clieop class









[ Top ]








Method Detail



	
	
__construct (Constructor)   [line 151]

	

    

    

		void __construct(
)
    

    


	
		Constructor for class


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
addPayment   [line 166]

	

    

    

		mixed addPayment(
object paymentObject
$paymentObject)
    

    


	
		Adds a payment record to the clieop file


    

  • Return: true on success or PEAR_Error object
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        object paymentObject  
        $paymentObject  
        —
          - Instance of transactionPayment
      

        

    


        
[ Top ]

  

  
  
	
	
alfaFiller   [line 671]

	

    

    

		string alfaFiller(
string
$text, integer
$length)
    

    


	
		Alfa numeric filler


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $text  
        —
          text    - Text which needs to filled up
      

          

        integer  
        $length  
        —
          length    - The length of the required text
      

        

    


        
[ Top ]

  

  
  
	
	
filler   [line 703]

	

    

    

		string filler(
integer
$Length)
    

    


	
		filler


    

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $Length  
        —
          length    - How many filler spaces do we need
      

        

    


        
[ Top ]

  

  
  
	
	
getBatchNumber   [line 263]

	

    

    

		string getBatchNumber(
integer
0)
    

    


	
		property BatchNumber


    

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        0  
        —
          Value    - Number of batches send to day (including this one)
      

        

    


        
[ Top ]

  

  
  
	
	
getFixedDescription   [line 278]

	

    

    

		string getFixedDescription(
string
0)
    

    


	
		property FixedDescription


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        0  
        —
          Value    - Description which will be added to each transaction payment
      

        

    


        
[ Top ]

  

  
  
	
	
getNewLine   [line 655]

	

    

    

		string getNewLine(
string
0)
    

    


	
		property NewLine


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        0  
        —
          Value   - New line character to use in Clieop output (defaults to "\n"; some banks require "\r\n")
      

        

    


        
[ Top ]

  

  
  
	
	
getPrincipalAccountNumber   [line 338]

	

    

    

		string getPrincipalAccountNumber(
string
0)
    

    


	
		property PrincipalAccountNumber


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        0  
        —
          Value    - Account number of principal
      

        

    


        
[ Top ]

  

  
  
	
	
getPrincipalName   [line 323]

	

    

    

		string getPrincipalName(
string
0)
    

    


	
		property PrincipalName


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        0  
        —
          Value    - Name of principal
      

        

    


        
[ Top ]

  

  
  
	
	
getProcessDate   [line 293]

	

    

    

		string getProcessDate(
string
0)
    

    


	
		property ProcessDate


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        0  
        —
          Value    - Date in DDMMYY format, required by some banks. Default is 000000 ('as soon as possible').
      

        

    


        
[ Top ]

  

  
  
	
	
getSenderIdentification   [line 308]

	

    

    

		string getSenderIdentification(
string
0)
    

    


	
		property SenderIdentification


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        0  
        —
          Value    - Identification of sender, free of choice
      

        

    


        
[ Top ]

  

  
  
	
	
getTest   [line 378]

	

    

    

		string getTest(
boolean
0)
    

    


	
		property Test


    

  • Access: public
    • 








        
Parameters:

    

    

          

        boolean  
        0  
        —
          Value    - true = test clieop, false = production clieop
      

        

    


        
[ Top ]

  

  
  
	
	
getTransactionType   [line 353]

	

    

    

		string getTransactionType(
string
0)
    

    


	
		property TransactionType


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        0  
        —
          Value    - transaction type
      

        

    


        
[ Top ]

  

  
  
	
	
numFiller   [line 687]

	

    

    

		string numFiller(
string
$number, integer
$length)
    

    


	
		Numeric filler


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $number  
        —
          number    - number which needs to filled up (Will be converted to a string)
      

          

        integer  
        $length  
        —
          length    - The length of the required number
      

        

    


        
[ Top ]

  

  
  
	
	
setBatchNumber   [line 267]

	

    

    

		void setBatchNumber(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setFixedDescription   [line 282]

	

    

    

		void setFixedDescription(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setNewLine   [line 659]

	

    

    

		void setNewLine(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setPrincipalAccountNumber   [line 342]

	

    

    

		void setPrincipalAccountNumber(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setPrincipalName   [line 327]

	

    

    

		void setPrincipalName(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setProcessDate   [line 297]

	

    

    

		void setProcessDate(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setSenderIdentification   [line 312]

	

    

    

		void setSenderIdentification(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setTest   [line 382]

	

    

    

		void setTest(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setTransactionType   [line 357]

	

    

    

		void setTransactionType(

$Value)
    

    


	
		



        
Parameters:

    

    

          

          
        $Value  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
writeClieop   [line 238]

	

    

    

		mixed writeClieop(
)
    

    


	
		Writes complete clieop file


    

  • Return: string containing clieop batch, or PEAR_Error object
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Sun, 24 Oct 2010 22:30:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright ©  PHP Group 2004.