https://github.com/abcaeffchen/sepautilities
SepaUtilities provides useful methods for validating and sanitizing inputs used in SEPA files supporting PHP >= 8.1.
https://github.com/abcaeffchen/sepautilities
php sanitizer sepa
Last synced: 6 months ago
JSON representation
SepaUtilities provides useful methods for validating and sanitizing inputs used in SEPA files supporting PHP >= 8.1.
- Host: GitHub
- URL: https://github.com/abcaeffchen/sepautilities
- Owner: AbcAeffchen
- License: lgpl-3.0
- Created: 2014-10-16T16:19:14.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-02-12T15:31:07.000Z (8 months ago)
- Last Synced: 2025-04-04T21:09:43.211Z (6 months ago)
- Topics: php, sanitizer, sepa
- Language: PHP
- Homepage:
- Size: 22.5 MB
- Stars: 31
- Watchers: 7
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE_LOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
SepaUtilities
===============
[](https://github.com/AbcAeffchen/SepaUtilities/actions/workflows/php.yml)
[](https://packagist.org/packages/abcaeffchen/sepa-utilities)
[](https://packagist.org/packages/abcaeffchen/sepa-utilities)
[](https://packagist.org/packages/abcaeffchen/sepa-utilities)
[](https://gitter.im/AbcAeffchen/SepaUtilities?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## General
SepaUtilities is a PHP class to check and sanitize inputs used in SEPA files
such as IBAN numbers, creditor identifiers, names and other text.
## PHP Versions
SepaUtilities supports PHP >= 8.1.
## Installation
### Composer
You can get SepaUtilities via Composer. Just add
```json
{
"require": {
"abcaeffchen/sepa-utilities": "^2.0"
}
}
```
to your composer.json.
### Direct download
If you don't use Composer, you can download `SepaUtilities.php` and just include it into your
PHP files. Make sure you use the namespace `AbcAeffchen\SepaUtilities\`.
## The Utilities
Have a look at the [documentation](http://htmlpreview.github.io/?https://raw.githubusercontent.com/AbcAeffchen/SepaUtilities/master/docs/html/index.html).
### Checks
- `checkIBAN($iban)`: Checks if the IBAN is valid by checking the format and by calculating the checksum and also removes whitespaces and changes all letters to upper case.
- `checkBIC($bic)`: Checks if the BIC is valid by checking the format and also removes whitespaces
and changes all letters to upper case.
- `crossCheckIbanBic($iban, $bic)`: Checks if IBAN and BIC belong to the same country.
- `isNationalTransaction($iban1,$iban2)`: Checks if both IBANs are belong to the same country.
- `checkCharset($str)`: Checks if the string contains only allowed characters.
- `check($field, $input, $options, $version)`: Checks if the input fits the field. This function also does little
format changes, e.g. correcting letter case. Possible field values are (case-insensitive):
- `initgpty`: Initiating Party
- `initgptyid`: Initiating Party ID
- `msgid`: Message ID
- `pmtid`: Payment ID
- `pmtinfid`: Payment Information ID
- `cdtr`: Creditor Name
- `ultmtcdrt`: Ultimate Creditor
- `dbtr`: Debtor Name
- `ultmtdebtr`: Ultimate Debtor
- `ultmtdbtrid`: Ultimate Debtor ID
- `iban`: IBAN
- `bic`: BIC
- `ccy`: Currency
- `btchbookg`: Batch Booking (boolean as string)
- `instdamt`: Instructed Amount
- `rmtinf`: Remittance Information
- `ci`: Creditor Identifier
- `seqtp`: Sequence Type
- `lclinstrm`: Local Instrument
- `ctry`: Two-letter country code, used in postal address
- Subfield of `pstlAdr`
- `adrline`: An address line, or an array of at most two address lines
- `bldgnm`: Building name
- `bldgnb`: Building number
- `twnnm`: Town name
- `twnlctnnm`: Town location name (within a town)
- `dstrctnm`: District name
- `ctrysubdvsn`: country subdivision, e.g. state, region, county
- `pstbx`: Postbox
- `pstcd`: Postal code
- `dept`: Department
- `subdept`: Subdepartment
- `strtnm`: Street name
- `flr`: Floor
- `room`: Room
The `$options` take an array
### Sanitizing
- `sanitizeLength($input, $maxLen)`: Shortens the string if it is to long.
- `sanitizeShortText($input,$allowEmpty, $flags)`: Sanitizes the the charset and shortens the text if necessary.
- `sanitizeLongText($input,$allowEmpty, $flags)`: Sanitizes the the charset and shortens the text if necessary.
- `replaceSpecialChars($str)`: replaces all characters that are not allowed in sepa files by a
allowed one or removes them. Take a look at this [.xls file](http://www.europeanpaymentscouncil.eu/index.cfm/knowledge-bank/epc-documents/sepa-requirements-for-an-extended-character-set-unicode-subset-best-practices/) for more information
*Notice:* Cyrillic is not supported yet, but greek letters are.
- `sanitize($field, $input, $flags)`: tries to sanitize the input, so it fits the field. Possible fields are
- `cdtr`
- `dbtr`
- `rmtinf`
- `ultmtcdrt`
- `ultmtdebtr`
- `adrline`
### Wrappers
- `checkAndSanitize($field, $input, $flags, $options)`: Checks the input and if it is not valid
it tries to sanitize it.
- `checkAndSanitizeAll(&$inputs, $flags, $options)`: Takes an array of inputs (field => value)
and checks and sanitizes each of the fields. The input array is handed over as reference, so the
result will be direct effect the input array. The return value is true, if everything is ok and
else a string with problematic fields.
### Date functions
- `getDate($date, $inputFormat)`: Returns $date in a SEPA-valid format. You can specify the
input format by using [the table on this site](http://de1.php.net/manual/en/function.date.php).
By default the german date format (DD.MM.YYYY) is used.
- `getDateWithOffset($workdayOffset, $today, $inputFormat)`: Computes the next [TARGET2](http://en.wikipedia.org/wiki/TARGET2#TARGET2_holidays)
day (including today) with respect to an offset.
- `getDateWithMinOffsetFromToday($target, $workdayMinOffset, $inputFormat, $today)`: Returns the
target date, if it has at least the given offset of TARGET2 days form today. Else the earliest date
that respects the offset is returned.
### Patterns
- `HTML_PATTERN_IBAN`
- `HTML_PATTERN_BIC`
- `PATTERN_IBAN`
- `PATTERN_BIC`
- `PATTERN_CREDITOR_IDENTIFIER`
- `PATTERN_SHORT_TEXT`
- `PATTERN_LONG_TEXT`
- `PATTERN_RESTRICTED_IDENTIFICATION_SEPA1`
- `PATTERN_MANDATE_ID`
The `HTML_PATTERN_*` constants can be used as HTML5 pattern attribute. It is user friendlier than
the corresponding `PATTERN_*` as they allow lowercase characters and whitespaces. This is corrected
by the `check` methods.
## Licence
SepaUtilities is licensed under the LGPL v3.0 License.