vaimo / module-custobar
vaimo/module-custobar
Custobar magento connector
Custobar_CustoConnector
CustoConnector is used to send usage statistics from the Magento installation to the Custobar API
Release Information
CustoConnector for M2
System Requirements
- PHP 7, 8.1
- Magento 2
NOTE: Module requires that the Magento cron is correctly configured and running
Installation
Add a repositories object to the composer.json
"repositories": [
{
"type": "git",
"url": "https://github.com/Custobar/magento2-plugin"
}
]
Add requirement custobar/custobar_m2_custoconnector
{
"require": {
"custobar/custobar_m2_custoconnector": "dev-master"
}
}
Run php bin/magento module:enable Custobar_CustoConnector and php bin/magento setup:upgrade
After installing
Go to Stores / Settings / Configuration / Custobar / CustoConnector / Configuration to setup the module.
Input the supplied Client identifier and Api key.
At least one Allowed websites to send data from needs to be selected.
You can also add the Custobar tracking script what can be generated at https://clientidentifier.custobar.com/tracking-script/.
Copy and paste the code without the following lines:
// remove these
cstbrConfig.productId = 'place_product_id_here';
cstbrConfig.customerId = 'place_customer_id_here';
Remember to flush Magento's caches after changing the values.
Go to System / Custobar / Custobar Status to view the status or start an initial scheduling.
Magento crons run above the /pub folder so If you are running Magento frontend from the pub folder and get media urls with "pub" and they can't be accessed then update settings:
-
Under Stores / Settings / Configuration / General / Web / Base Urls and Base Urls (Secure):
Change the
Base URL for User Media Filesto:{{unsecure_base_url}}media/Change the
Secure Base URL for User Media Filesto:{{secure_base_url}}media/
Update notices
2.1.1:
- Add compatibility with Magento 2.4.5 & PHP 8.1
2.1.0:
- Fixed issue where entities that were restricted to certain websites still got scheduled for export
for all websites - Added possibility to specify field mappings per store view in admin
- Added possibility to automatically add domain on field mappings
- Fixed issue where applying/expiring special prices would not automatically cause product to be scheduled
for export
2.0.0:
- Module refactored to better follow Magento standards and improve general code quality
- Admin view for logs added
- Tracked models admin config removed and replaced with a more straightforward solution
1.1.1:
- fixes null product issue
- remove urls for product that aren't visible by them self as magento gives a non nice url for them
1.1.0:
-
Maps select/dropdown attribute labels to Custobar correctly
Example
manufacturer>brand -
New fields for Magento\Catalog\Model\Product>products
custobar_child_ids>mage_child_ids and custobar_parent_ids>mage_parent_ids
Update tracked models with (remember to keep your own modifications)
Magento\Catalog\Model\Product>products: name>title; sku>external_id; custobar_minimal_price>minimal_price; custobar_price>price; type_id>mage_type; configurable_min_price>my_configurable_min_price; custobar_attribute_set_name>type; custobar_category>category; custobar_category_id>category_id; custobar_image>image; custobar_product_url>url; custobar_special_price>sale_price; description>description; custobar_language>language; custobar_store_id>store_id; custobar_child_ids>mage_child_ids; custobar_parent_ids>mage_parent_ids, Magento\Customer\Model\Customer>customers: firstname>first_name; lastname>last_name; id>external_id; email>email; custobar_telephone>phone_number; custobar_street>street_address; custobar_city>city; custobar_postcode>zip_code; custobar_country_id>country; custobar_created_at>date_joined; store_id>store_id, Magento\Customer\Model\Address>*Magento\Customer\Model\Customer: customer_id>id, Magento\Sales\Model\Order>sales: custobar_state>sale_state; increment_id>sale_external_id; customer_id>sale_customer_id; custobar_created_at>sale_date; customer_email>sale_email; store_id>sale_shop_id; custobar_discount>sale_discount; custobar_grand_total>sale_total; custobar_payment_method>sale_payment_method; custobar_order_items>magento__items, Magento\Newsletter\Model\Subscriber>events: subscriber_email>email; customer_id>customer_id; custobar_status>type; custobar_date>date; store_id>store_id
No changelog yet
The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.
Requires 1
| Package | Constraint |
|---|---|
| magento/framework | >=100.0.0 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 102 | 8 errors, 94 warnings (ruleset: Magento2) — 25 auto-fixable with phpcbf |
| PHPMD | Warning | 6 | 6 rule violations (TooManyPublicMethods:3, UnusedLocalVariable:1, UnusedFormalParameter:1, ExcessiveMethodLength:1) |
| Cpd | Pass | 0 | |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from Vaimo
View vendorTurn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.