elgentos / magento2-convert

elgentos/magento2-convert

Elgentos_Convert for Magento 2

magento2-module Compatibility: 2.4.7-2.4.9 Code Quality: Info Tests: N/A Security: Pass

Dan you optimize this documentation

Elgentos Convert

This is a module to connect Magento 2 to Convert.

Installation

Composer

To install this module you run:

composer require elgentos/magento2-convert
bin/magento setup:di:compile
bin/magento setup:upgrade

Configuration

When the module is required in composer and installed through the setup we need to configure the store config settings.

Navigate:

  • Go to the Magento Backend
  • Press Stores
  • Press Settings -> Configuration
  • Press Extensions (Depending on Magento version) -> Elgentos -> Convert

Now you are in the settings for the module. Here you have 2 options:

  • Enabled (Yes / No) - This determines if the functionality is active.
  • Convert JS URL (URL obtained from Convert) - This is the URL used to load the Javascript from Convert

Page Types

To set the _conv_page_type value you can use our prepared block convert.page-type.
This is a example where we set the page type as Foo Bar.

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceBlock name="convert.page-type">
            <arguments>
                <argument name="_conv_page_type" xsi:type="string">Foo Bar</argument>
            </arguments>
        </referenceBlock>
    </body>
</page>

By using this layout in the correct handles you can configure the which page type is used in wich location.

Events

By Javascript

If you want to push a event to conv we have a function prepared that you can use:

convQPush(12345);

This is usable over the entire page and is loaded wherever you have the script loaded.
If the module is not enabled in the store config this function will not brake your application.
It will create a fake function in order that the application does not brake.

By XML

This triggers a event to convert when the page is loaded. You can create a layout file on any handle you want.

This is a example to trigger a event when the user opens the cart in the layout file checkout_cart_index.xml:

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceContainer name="head.additional">
            <block
                    name="convert.event.view_cart"
                    template="Elgentos_Convert::event.phtml"
                    ifconfig="elgentos_convert/general/enabled"
            >
                <arguments>
                    <argument name="event_id" xsi:type="number">12345</argument>
                </arguments>
            </block>
        </referenceContainer>
    </body>
</page>

No changelog yet

The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.

Versions
Version Stability QA Status Compatibility Released
1.0.1 stable Pass Magento 2.4.7-2.4.9 Details 2023-10-18 12:42:27
1.0.0 stable Not tested Not yet tested Details 2023-10-04 16:04:58

No dependencies declared

This package's composer.json doesn't declare any required, suggested, replaced, or conflicting packages.

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.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Pass Pass
2.4.8 Pass Pass
2.4.9 Pass Pass

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.

Static analysis results
Tool Status Findings Summary
PHPCS Pass 0
PHPMD Pass 0
Cpd Pass 0
Composer validate Info 1 valid; 1 advisory note (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.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Pass Pass
2.4.8 Pass Pass
2.4.9 Pass Pass

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

Unit tests results by Magento and PHP version
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

Integration tests

Integration tests results by Magento and PHP version
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.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0

No license declared

This package's composer.json doesn't declare a license, homepage, or authors. Check the source repository for terms of use.

More from elgentos

View vendor
Make it pay

Turn 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.