magepsycho / magento2-custom-shipping

magepsycho/magento2-custom-shipping

Magento 2 Custom Shipping

magento2-module Compatibility: 2.4.7-2.4.9 Code Quality: Fail Tests: N/A Security: Pass OSL-3.0

Magento 2 Custom Shipping

Magento 2 Custom Shipping

Packagist Version
Packagist Downloads
Supported Magento Versions
License

Overview

Magento 2 Custom Shipping is a sample for Shipping module in Magento 2.
You can use this module as a base for developing any custom shipping modules.

🛠️ Installation

Using Composer

Run the commands from the root of the Magento installation

composer require magepsycho/magento2-custom-shipping

Using modman

modman init
modman clone [email protected]:MagePsycho/magento2-custom-shipping.git

Using Zip

  • Download the Zip File
  • Extract & upload the files to /path/to/magento2/app/code/MagePsycho/CustomShipping/

After installation by either means, enable the extension by running following commands (again from root of Magento2 installation):

php bin/magento module:enable MagePsycho_CustomShipping --clear-static-content
php bin/magento setup:upgrade

Click here to read more on module packaging, installation & activation in Magento 2

🚀 Screenshots

Backend Settings

  1. Screentshot - Backend Settings

Checkout Steps 1 - Checkout
2. Checkout Steps 1 - Checkout

Checkout Steps 2 - Summary
3. Checkout Steps 2 - Summary

Contributors

  • Raj KB [Maintainer] Twitter Follow

Your Repository's Stats

To Contribute

Any contribution to the development of Magento 2 Custom Shipping is highly welcome.
The best possibility to provide any code is to open a pull request on GitHub.

Need Support?

If you encounter any problems or bugs, please create an issue on GitHub.

Please visit our store for more FREE / paid extensions OR contact us for customization / development services.

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.5 stable Fail Magento 2.4.7-2.4.9 Details 2022-03-02 05:54:39
1.0.4 stable Not tested Not yet tested Details 2022-02-07 14:05:42
1.0.3 stable Not tested Not yet tested Details 2022-02-06 18:24:06

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 - Static Tests

Checks run directly against the module's source code, independent of any Magento or PHP version: coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity, and a security audit of its declared dependencies. Each runs once.

Static code-quality results
Tool Status Findings Summary
PHPCS Warning 12 12 warnings (ruleset: Magento2) — 9 auto-fixable with phpcbf
PHPMD Pass 0
Cpd Pass 0
Composer validate Info 1 valid; 1 advisory note (composer validate --strict)
Composer audit Pass 0

Code Quality - PHPStan

PHPStan type-checks the module's PHP against a real Magento install (so framework and core-module symbols resolve) at the configured gate level. Because the available symbols differ between releases, it runs separately for each Magento and PHP version. The grid below shows the result for each pairing; select one to see its findings. This never affects compatibility.

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

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
License
OSL-3.0
Homepage
https://www.magepsycho.com/magento-2-custom-shipping.html
Authors

More from magepsycho

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.