elgentos / magento2-apicacheindexmanagement

elgentos/magento2-apicacheindexmanagement

Extension to invalidate caches and reindex indexers through the REST API.

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

Elgentos ApiCacheIndexManagement

Extension to invalidate caches and reindex indexers through the REST API. All routes are POST routes.

Both {ids} and {skus} can be passed as comma-separated strings or arrays.

Cache routes

/V1/cache/flushAll
/V1/cache/flushAllInvalidated
/V1/cache/flush/{cacheType}
/V1/cache/flush/products (parameters; ids / skus)
/V1/cache/flush/categories (parameters; ids / skus)

Possible cacheTypes;

config
layout
block_html
collections
reflection
db_ddl
compiled_config
eav
customer_notification
full_page
config_integration
config_integration_api
config_webservice
translate

There could be more or less cache types, depending on your installation. See bin/magento cache:status for your full list.

Index routes

/V1/index/reindexAll
/V1/index/reindexAllInvalidated
/V1/index/reindex/{indexName} (optional parameters; ids / skus)

Possible indexNames:

design_config_grid                       Design Config Grid
customer_grid                            Customer Grid
catalog_category_product                 Category Products
catalog_product_category                 Product Categories
catalogrule_rule                         Catalog Rule Product
catalog_product_attribute                Product EAV
cataloginventory_stock                   Stock
catalog_product_price                    Product Price
catalogrule_product                      Catalog Product Rule
catalogsearch_fulltext                   Catalog Search

There could be more or less indexes, depending on your installation. See bin/magento indexer:info for your full list.

Note about re-indexing using the {skus} parameter: it is possible to use parameter this in combination with a non-product indexer, such as customer_grid. Doing this will fetch the product IDs belonging to the passed SKUs, and will then reindex the customers with that specific entity ID. This shouldn't introduce any problems, but it's fairly useless.

Possible response codes

Code Message
200 Cache clean successfully / Indexers are reindexed successfully
304 No tags to clean / Already cleaned cache
500 Could not reindex / could not clear cache

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.0 stable Fail Magento 2.4.7-2.4.9 Details 2021-01-28 18:50:31

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 Warning 9 9 warnings (ruleset: Magento2) — 7 auto-fixable with phpcbf
PHPMD Warning 4 4 rule violations (UnusedLocalVariable:3, UnusedFormalParameter:1)
Cpd Pass 0
Composer validate Pass 0

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 4 4
2.4.8 4 4
2.4.9 4 4

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
License
OSL-3.0
Authors

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.