Download the PHP package esyoil-gmbh/collmex without Composer
On this page you can find all versions of the php package esyoil-gmbh/collmex. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download esyoil-gmbh/collmex
More information about esyoil-gmbh/collmex
Files in esyoil-gmbh/collmex
Informations about the package collmex
Collmex API PHP SDK
This library provides a wrapper for the Collmex API. It's not complete yet, some record types (and maybe some features) are missing.
Please create a pull request if you have implemented a new type/feature or create issues for bugs/feature requests.
There is (or least should be…) a Type class for every Collmex record type
("Satzart"). Currently only the base types (MESSAGE
, LOGIN
,
NEW_OBJECT_ID
) and a few normal record types are implemented:
ABO_GET
ACC_BAL
ACCBAL_GET
ACCDOC
ACCDOC_GET
BILL_OF_MATERIAL_GET
CMXABO
CMXBOM
CMXDLV
CMXEPF
CMXINV
CMXKND
CMXMGD
CMXORD-2
CMXPOD
CMXPRD
CMXPRI
CMXPRI_CHANGE
CMXSTK
CMXUMS
CUSTOMER_GET
DELIVERY_GET
INVOICE_GET
INVOICE_OUTPUT_SET
MEMBER_GET
OPEN_ITEM
OPEN_ITEMS_GET
PAYMENT_CONFIRMATION
PRICE_GROUP
PRICE_GROUPS_GET
PRODUCT_GET
PRODUCT_PRICE_GET
PRODUCTION_ORDER
PRODUCTION_ORDER_GET
PROJECT_STAFF
PROJECT_STAFF_GET
PURCHASE_ORDER_GET
SALES_ORDER_GET
SHIPMENT_CONFIRM
SHIPMENT_NOTIFICATION_SEND
SHIPMENT_ORDERS_GET
STOCK_AVAILABLE
STOCK_AVAILABLE_GET
STOCK_CHANGE
STOCK_CHANGE_GET
STOCK_GET
TRACKING_NUMBER
Installation
Using Composer, just add it to your composer.json
by running:
If you want to use the included Laravel service provider
CollmexServiceProvider
, add it to the config/app.php
providers array:
Compatibility
The Collmex PHP SDK requires PHP >= 7.1. If you're still using an ancient PHP version, you can install older versions of the Collmex PHP SDK:
- for PHP 7.0 compatibility: use the 0.12.x branch (
composer require mjaschen/collmex:~0.12
) - for PHP 5.6 compatibility: use the 0.11.x branch (
composer require mjaschen/collmex:~0.11
) - for PHP 5.5 compatibility: use the 0.6.x branch (
composer require mjaschen/collmex:~0.6
) - for PHP 5.4 compatibility: use the 0.4.x branch (
composer require mjaschen/collmex:~0.4
) - for PHP 5.3 compatibility: use the 0.3.x branch (
composer require mjaschen/collmex:~0.3
)
New features will only go into the master.
Usage/Examples
Request information from Collmex API
Load a Collmex Customer record:
Create a new Collmex customer record
Create a new Collmex Customer record and get the Collmex customer ID from the response data:
Notes
Collmex expects all strings encoded in code page 1252 (Windows) while the Collmex PHP SDK expects all inputs as UTF-8 and outputs everything as UTF-8. The conversion of string encodings is done transparently with the forceutf8 library before sending a request to the Collmex API and after receiving the response from the API.
Development
Run code checks
To run checks and tests, it's the easiest to use the provided Composer scripts:
- lint PHP files for syntax errors:
composer ci:lint
- run static analysis with Psalm and report
errors:
composer ci:psalm
- run unit tests with PHPUnit:
composer ci:tests
- check the code style with
PHP_CodeSniffer:
composer ci:sniff
To run all checks and tests at once, just use composer ci
.
Of course, it's possible to use the test runners directly, e. g. for PHPUnit:
Psalm:
Autoformat the code
You can use a Composer script to autoformat the code:
Collmex API Documentation
All versions of collmex with dependencies
ext-curl Version *
ext-json Version *
ext-zip Version *
neitanod/forceutf8 Version ^2.0
symfony/finder Version ^4.0 || ^5.0
symfony/http-foundation Version ^4.0 || ^5.0