magesetu / module-common

1.0.0 2026-08-05 14:56 UTC

Requires

• php: >=8.3
• magento/framework: >=2.4.8

Apache-2.0

Published on Packagist.org on 2026-09-15 12:49 UTC

README

MageSetu Common is a base Magento 2 module that provides shared backend structure and reusable utilities for other MageSetu extensions. It is not a standalone storefront or commerce feature module; instead, it helps sibling modules follow a consistent admin experience and implementation pattern.

What this module provides

This package currently focuses on shared infrastructure for MageSetu modules:

• a common admin ACL resource for permissions
• a top-level admin menu entry for MageSetu modules
• a shared configuration tab under Stores > Configuration
• dependency injection preferences for reusable interfaces
• reusable backend utilities for outbound HTTP calls, configuration scope resolution, and cURL-based transport helpers

Requirements

Requirement	Version
PHP	>= 8.3
Magento Open Source / Commerce	>= 2.4.8

Installation

If you are installing this module in a Magento 2 project with Composer, run:

composer require magesetu/module-common
php bin/magento module:enable MageSetu_Common
php bin/magento setup:upgrade
php bin/magento cache:flush

Configuration and usage

This module does not expose merchant-facing settings or a separate end-user feature by itself. Its main value is as a foundation for other MageSetu modules.

If you are building a child module, use the shared conventions defined here:

• use the ACL resource MageSetu_Common::manage for your module permissions
• use MageSetu_Common::main as the parent admin menu node
• place your configuration sections under the shared magesetu_common tab
• inject the provided interfaces instead of wiring concrete classes directly

Example:

use MageSetu\Common\Api\HttpClientInterface;

class MyService
{
    public function __construct(private readonly HttpClientInterface $httpClient)
    {
    }
}

Reusable utilities

The repository documentation describes the shared utilities in more detail:

• Shared HTTP client
• Configuration scope resolver
• Extended cURL client

Documentation

For implementation details and extension guidelines, see the documentation hub:

• Documentation index
• Admin ACL hierarchy
• Admin menu architecture
• System configuration tab
• Dependency injection configuration

Disclaimer

Warning

Use this module at your own risk. This module is provided "as is" without warranty of any kind, either express or implied. The developers are not responsible for any data loss, API rate limit overages, financial charges, server downtime, or other issues resulting from the use or installation of this software.

License

This project is licensed under the Apache 2.0 License. See LICENSE for details.