PHPackages                             iods/module-base - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. iods/module-base

ActiveMagento2-module[Utility & Helpers](/categories/utility)

iods/module-base
================

Base module container for extending and testing general functionality across Magento 2.

0101[1 issues](https://github.com/iods/magento2-base/issues)PHP

Since Jun 26Pushed 2y ago1 watchersCompare

[ Source](https://github.com/iods/magento2-base)[ Packagist](https://packagist.org/packages/iods/module-base)[ RSS](/packages/iods-module-base/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

Magento 2 Base
==============

[](#magento-2-base)

The `Iods_Base` module is a core module container for extending and testing general functionality across Magento 2. This includes some common files needed for registering the module as well as a few components for understanding the overall Magento 2 module structure.

Functionality provided by this module includes:

- A main container for additional modules to utilize, mainly Helpers
- Adminhtml section for configuration support

**This is a private module and is not currently maintained for public use.**

Facts
-----

[](#facts)

- Version: 0.1.1 (Development)
- [Composer Package](https://packagist.org/packages/iods/module-base)
- [Repository on Github](https://github.com/iods/magento2-base)

Getting Started
---------------

[](#getting-started)

#### Download Zip

[](#download-zip)

Download a release.

#### Through Composer

[](#through-composer)

Working on this.

### Requirements

[](#requirements)

- Magento <= 2.4
- [Git](http://git-scm.com)
- [PHP v7.4+](http://php.net)
- [Composer](http://getcomposer.org)

### Known Issues

[](#known-issues)

- Link to any Github issues, or list issues w/ Magento 2 compatibility or Extension compatibility
- Provides main container for other Iods modules to extend from and utilize, including ACL
- Displays `APP_MODE` for developers working in multiple environments with store version and Magento version (quick reference)
- CRUD model for saving data and other packages to extend from
- System configuration entry with frontend display
- Installation scripts to install tables and insert sample data for the module
- Un-installation scripts to properly remove the extension
- Adminhtml UiComponent Form and Grids with admin entry management
- Fixes some Magento 2 issues w/ Plugins and Observers
- Cron for clearing X
- Report check and notify
- adds some helpers for other modules to use

Related Projects / Tickets / Stories
------------------------------------

[](#related-projects--tickets--stories)

If you use your module internally, try to add links to related documentation covered in projects or tickets.

- [\#00000](https://yourProjectManagementSystem.com/yourTicketNumber) - Task Title goes here
- [\#00001](https://yourProjectManagementSystem.com/yourTicketNumber) - Task Title goes here
- [\#00002](https://yourProjectManagementSystem.com/yourTicketNumber) - Task Title goes here
- [\#00003](https://yourProjectManagementSystem.com/yourTicketNumber) - Task Title goes here
- [\#00004](https://yourProjectManagementSystem.com/yourTicketNumber) - Task Title goes here
- [\#00005](https://yourProjectManagementSystem.com/yourTicketNumber) - Task Title goes here

### Installation

[](#installation)

Includes a series of step-by-step examples for installation and configuration.

```
$ composer require iods/module-performance
$ bin/magento module:enable Iods_Performance
$ bin/magento setup:upgrade
$ bin/magento cache:flush

$ bin/magento config:set dev/js/minify_files 1 -l
$ bin/magento config:set dev/js/merge_files 1 -l
$ bin/magento config:set dev/css/minify_files 1 -l
$ bin/magento config:set dev/css/merge_css_files 0 -l
$ bin/magento config:set dev/template/minify_html 1 -l
$ bin/magento deploy:mode:set production

```

Deployment
----------

[](#deployment)

Add additional notes about how to deploy this on a live system

Built With
----------

[](#built-with)

- [Your Framework](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
- [Your Dependency Management](https://maven.apache.org/) - Dependency Management
- [Other Tools, you use](https://rometools.github.io/rome/) - Any Kind of Generator for example

Magento 2
---------

[](#magento-2)

### Components

[](#components)

Explain how you made you module. Did you make use of Plugins or Observers? Where is the entry point of the module.

- Minify HTML code
- Lazy load Iframes, Images
- Defer/preload CSS files by using javascript/browser preload
- Minify inline CSS, Javascript
- Move javascript to footer
- Defer javascript codes
- Adding https/2 push
- Preload fonts

### Extensions

[](#extensions)

Explain how to extend your module.

```
Give an example

```

### Configurations

[](#configurations)

Give an overview of the given configurations.

You have to disable merge css if you want to use CSS modifier functions.

SectionGroupFieldDescriptionwebdefaultcms\_home\_pageSelect the CMS Home Pagewebdefaultcms\_no\_routeSelect the 404 Pagewebdefaultcms\_no\_cookiesSelect the No Cookies PageDevelopment
-----------

[](#development)

### Structure

[](#structure)

How does it work? What components in the module exist. What is different. Link to devdocs.

Finishing w/ an example of system information of demo of the module for your team.

### Extensibility

[](#extensibility)

Includes a series of step-by-step examples for extending the module and code snippets of the extension points.

#### Events

[](#events)

A list of events dispatched by the module.

#### Layouts

[](#layouts)

Does it introduce layouts or layout handles?

### UI Components

[](#ui-components)

Does the module introduce any UI components or the configuration files, where are they?

### Public API

[](#public-api)

Does the module introduce any public API? what services are introduced?

```
\Magento\Sales\Api\InvoiceOrderInterface
  * Create an Invoice
  * Change status and state
```

Packagist Setting
-----------------

[](#packagist-setting)

- [Create account](https://packagist.org/register/)
- Connect with Github account
- [Submit package](https://packagist.org/packages/submit)
    - URL example: `https://github.com/rangerz/magento2-module-template`

### Tests

[](#tests)

Includes a series of step-by-step examples for testing the module.

### Code Styles

[](#code-styles)

Includes any relevant code style information or documentation.

### Configuration

[](#configuration)

Overview of the admin/configuration settings within the module.

groupfielddescriptionwebdefaultexamplewebdefaultexampleadmindefaultexampleSupport
-------

[](#support)

If you have any issues with this project, open an issue on [Github](https://github.com/iods/magento2-bones/issues)

- [Git](http://git-scm.com)
- [PHP v8.1+](http://php.net)
- [Magento CE 2.4+](http://magento.com)
- [Composer](http://getcomposer.org)

Developer
---------

[](#developer)

- **Rye Miller** - *Initial work* - [GitHub](http://github.com/iods/), [Homepage](https://ryemiller.io)

See also the list of [contributors](https://github.com/iods/magento2-performance/contributors) who participated in this project.

Versioning
----------

[](#versioning)

For transparency into the release cycle and in striving to maintain backward compatibility, this project is maintained under [the Semantic Versioning guidelines](http://semver.org/).

Support
-------

[](#support-1)

If you have any issues with this module, open an issue on [Github](https://github.com/iods/magento2-base/issues)

Versioning
----------

[](#versioning-1)

For transparency into the release cycle and in striving to maintain backward compatibility, this project is maintained under [the Semantic Versioning guidelines](http://semver.org/).

License
-------

[](#license)

This project/code is released under [the MIT license](https://github.com/iods/magento2-base/LICENSE).

Copyright
---------

[](#copyright)

(c) 2022 Rye Miller

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity24

Early-stage or recently created project

 Bus Factor1

Top contributor holds 84.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/8f37d433173db656dacd1b143e2e927a49c43793ca1493fe9b1efa1649f22231?d=identicon)[iods](/maintainers/iods)

---

Top Contributors

[![iods](https://avatars.githubusercontent.com/u/1226065?v=4)](https://github.com/iods "iods (50 commits)")[![rmiller-corra](https://avatars.githubusercontent.com/u/151565830?v=4)](https://github.com/rmiller-corra "rmiller-corra (9 commits)")

---

Tags

magento2magento2-module

### Embed Badge

![Health badge](/badges/iods-module-base/health.svg)

```
[![Health](https://phpackages.com/badges/iods-module-base/health.svg)](https://phpackages.com/packages/iods-module-base)
```

###  Alternatives

[league/object-mapper

Converts structured data into strict objects.

357.9k2](/packages/league-object-mapper)[bugloos/fault-tolerance-bundle

Fault Tolerance Bundle

111.1k](/packages/bugloos-fault-tolerance-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)