Aspose.Barcode for PHP via Java Generation and Recognition API docs

Inherits BaseJavaClass.

Public Member Functions

 __construct ($javaClass)
 
 getVersion ()
 
 setVersion (int $value)
 
 getAmount ()
 
 setAmount (float $value)
 
 getCurrency ()
 
 setCurrency (string $value)
 
 getAccount ()
 
 setAccount (string $value)
 
 getCreditor ()
 
 setCreditor (Address $value)
 
 getReference ()
 
 setReference (string $value)
 
 createAndSetCreditorReference (string $rawReference)
 
 getDebtor ()
 
 setDebtor (Address $value)
 
 getUnstructuredMessage ()
 
 setUnstructuredMessage (string $value)
 
 getBillInformation ()
 
 setBillInformation (string $value)
 
 getAlternativeSchemes ()
 
 setAlternativeSchemes (array $value)
 
 equals (SwissQRBill $obj)
 
 hashCode ()
 
- Public Member Functions inherited from BaseJavaClass
 getJavaClass ()
 
 getJavaClassName ()
 
 isNull ()
 
 printJavaClassName ()
 

Protected Member Functions

 init ()
 
- Protected Member Functions inherited from BaseJavaClass
 setJavaClass ($javaClass)
 

Static Private Member Functions

static convertAlternativeSchemes ($javaAlternativeSchemes)
 

Private Attributes

 $creditor
 
 $debtor
 

Detailed Description

SwissQR bill data

Constructor & Destructor Documentation

◆ __construct()

SwissQRBill::__construct (   $javaClass)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ convertAlternativeSchemes()

static SwissQRBill::convertAlternativeSchemes (   $javaAlternativeSchemes)
staticprivate

◆ createAndSetCreditorReference()

SwissQRBill::createAndSetCreditorReference ( string  $rawReference)

Creates and sets a ISO11649 creditor reference from a raw string by prefixing the String with "RF" and the modulo 97 checksum.

Whitespace is removed from the reference

Exceptions
ArgumentExceptionrawReference contains invalid characters.
Parameters
string$rawReferenceThe raw reference.

◆ equals()

SwissQRBill::equals ( SwissQRBill  $obj)

Determines whether the specified object is equal to the current object.

Parameters
SwissQRBill$objThe object to compare with the current object.
Returns
bool true if the specified object is equal to the current object; otherwise, false.

◆ getAccount()

SwissQRBill::getAccount ( )

Gets the creditor's account number.

Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number.

Value: The creditor account number.

◆ getAlternativeSchemes()

SwissQRBill::getAlternativeSchemes ( )

Gets ors sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.

Returns
array The alternative payment schemes.

◆ getAmount()

SwissQRBill::getAmount ( )

Gets the payment amount.

Valid values are between 0.01 and 999,999,999.99.

Value: The payment amount.

◆ getBillInformation()

SwissQRBill::getBillInformation ( )

Gets the additional structured bill information.

Returns
string The structured bill information.

◆ getCreditor()

SwissQRBill::getCreditor ( )

Gets the creditor address.

Returns
Address The creditor address.

◆ getCurrency()

SwissQRBill::getCurrency ( )

Gets the payment currency.

Valid values are "CHF" and "EUR".

Value: The payment currency.

◆ getDebtor()

SwissQRBill::getDebtor ( )

Gets the debtor address.

The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok.

return Address The debtor address.

◆ getReference()

SwissQRBill::getReference ( )

Gets the creditor payment reference.

The reference is mandatory for SwissQR IBANs, i.e.IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx.

If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting.

Returns
string The creditor payment reference.

◆ getUnstructuredMessage()

SwissQRBill::getUnstructuredMessage ( )

Gets the additional unstructured message.

Returns
string The unstructured message.

◆ getVersion()

SwissQRBill::getVersion ( )

Gets the version of the SwissQR bill standard. Value: The SwissQR bill standard version.

◆ hashCode()

SwissQRBill::hashCode ( )

Gets the hash code for this instance.

Returns
int A hash code for the current object.

◆ init()

SwissQRBill::init ( )
protected

Reimplemented from BaseJavaClass.

◆ setAccount()

SwissQRBill::setAccount ( string  $value)

Sets the creditor's account number.

Account numbers must be valid IBANs of a bank of Switzerland or Liechtenstein. Spaces are allowed in the account number.

Parameters
string$valueValue: The creditor account number.
Exceptions
BarcodeException

◆ setAlternativeSchemes()

SwissQRBill::setAlternativeSchemes ( array  $value)

Gets ors sets the alternative payment schemes.

A maximum of two schemes with parameters are allowed.

Parameters
array$valueThe alternative payment schemes.

◆ setAmount()

SwissQRBill::setAmount ( float  $value)

Sets the payment amount.

Valid values are between 0.01 and 999,999,999.99.

Value: The payment amount.

◆ setBillInformation()

SwissQRBill::setBillInformation ( string  $value)

Sets the additional structured bill information.

Parameters
stringThe structured bill information.

◆ setCreditor()

SwissQRBill::setCreditor ( Address  $value)

Sets the creditor address.

Parameters
Address$valueThe creditor address.
Exceptions
BarcodeException

◆ setCurrency()

SwissQRBill::setCurrency ( string  $value)

Sets the payment currency.

Valid values are "CHF" and "EUR".

Value: The payment currency.

◆ setDebtor()

SwissQRBill::setDebtor ( Address  $value)

Sets the debtor address.

The debtor is optional. If it is omitted, both setting this field to null or setting an address with all null or empty values is ok.

Parameters
AddressThe debtor address.

◆ setReference()

SwissQRBill::setReference ( string  $value)

Sets the creditor payment reference.

The reference is mandatory for SwissQR IBANs, i.e.IBANs in the range CHxx30000xxxxxx through CHxx31999xxxxx.

If specified, the reference must be either a valid SwissQR reference (corresponding to ISR reference form) or a valid creditor reference according to ISO 11649 ("RFxxxx"). Both may contain spaces for formatting.

Parameters
string$valueThe creditor payment reference.

◆ setUnstructuredMessage()

SwissQRBill::setUnstructuredMessage ( string  $value)

Sets the additional unstructured message.

Parameters
string$valueThe unstructured message.

◆ setVersion()

SwissQRBill::setVersion ( int  $value)

Sets the version of the SwissQR bill standard. Value: The SwissQR bill standard version.

Member Data Documentation

◆ $creditor

SwissQRBill::$creditor
private

◆ $debtor

SwissQRBill::$debtor
private