PHPackages oxid-esales/admin-tools - 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. oxid-esales/admin-tools ActiveOxideshop-module[Utility & Helpers](/categories/utility) oxid-esales/admin-tools ======================= Module with solution examples v1.1.0(6mo ago)02.2k↓22.2%proprietaryPHPPHP ^8.2CI passing Since Apr 15Pushed 2mo ago1 watchersCompare [ Source](https://github.com/OXID-eSales/admin-tools-module)[ Packagist](https://packagist.org/packages/oxid-esales/admin-tools)[ RSS](/packages/oxid-esales-admin-tools/feed)WikiDiscussions b-7.5.x Synced 1mo ago READMEChangelogDependencies (18)Versions (10)Used By (0) OXID eShop Admin-Tools Module ============================= [](#oxid-eshop-admin-tools-module) [![Development](https://github.com/OXID-eSales/admin-tools-module/actions/workflows/trigger.yaml/badge.svg?branch=b-7.5.x)](https://github.com/OXID-eSales/admin-tools-module/actions/workflows/trigger.yaml)[![Latest Version](https://camo.githubusercontent.com/1a48f417cbc091d67f18f9ecb8643a4c38e7c61ce9e76c10a138edbe9503d47e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f4f5849442d6553616c65732f61646d696e2d746f6f6c732d6d6f64756c653f6c6f676f3d636f6d706f736572266c6162656c3d6c617465737426696e636c7564655f70726572656c656173657326636f6c6f723d6f72616e6765)](https://packagist.org/packages/oxid-esales/admin-tools-module)[![PHP Version](https://camo.githubusercontent.com/aadea1d6d9442d841606de31429452fe6cf4290d54a60e44aaf1a02847d73714/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6f7869642d6573616c65732f61646d696e2d746f6f6c732d6d6f64756c65)](https://github.com/oxid-esales/admin-tools-module) [![Quality Gate Status](https://camo.githubusercontent.com/86f871ce03bcda436936230c30efd7b8bf14fcacac89d510c9b60352f019f658/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d4f5849442d6553616c65735f61646d696e2d746f6f6c732d6d6f64756c65266d65747269633d616c6572745f737461747573)](https://sonarcloud.io/dashboard?id=OXID-eSales_admin-tools-module)[![Coverage](https://camo.githubusercontent.com/b4943bd4a96df2436cfa496b20cb14d7dd6a2e94c0e95dc40be1bb796d76451f/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d4f5849442d6553616c65735f61646d696e2d746f6f6c732d6d6f64756c65266d65747269633d636f766572616765)](https://sonarcloud.io/dashboard?id=OXID-eSales_admin-tools-module)[![Technical Debt](https://camo.githubusercontent.com/dc3140397361a3b68b15963c095119a278203bc3ed1974dd2b4243187d8bb0d1/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d4f5849442d6553616c65735f61646d696e2d746f6f6c732d6d6f64756c65266d65747269633d7371616c655f696e646578)](https://sonarcloud.io/dashboard?id=OXID-eSales_admin-tools-module) This module adds admin tools to the OXID eShop Admin Backoffice, allowing admins to select and clear specific or all subshop caches via a dropdown in the header. Features -------- [](#features) - Provides an admin toolbar dropdown for cache management. - Allows selective or complete cache removal. - Optionally integrates with OXAPI GraphQL for cache clearing via API. - Includes **ShopController as a service** for better modularity. Branch Compatibility -------------------- [](#branch-compatibility) - v1.2.0 (or b-7.5.x branch) is compatible with latest shop compilation 7.5.x resp. b-7.5.x shop compilation branches - v1.1.0 (or b-7.4.x branch) is compatible with latest shop compilation 7.4.x resp. b-7.4.x shop compilation branches - v1.0.0 (or b-7.3.x branch) is compatible with latest shop compilation 7.3.x resp. b-7.3.x shop compilation branches ### Install and activate [](#install-and-activate) ``` # Install desired version of oxid-esales/admin-tools for OXID 7.5. $ composer require oxid-esales/admin-tools:dev-b-7.5.x ``` You should run migrations both after installing the module and after each module update: ``` $ ./vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_admintools ``` ``` # Activate the module # $ ./vendor/bin/oe-console oe:module:activate oe_admintools ``` Cache Clearing Options ---------------------- [](#cache-clearing-options) This module provides **multiple cache clearing mechanisms**. The available options can be accessed via **Admin UI** or **OXAPI GraphQL**. ### Available Cache Removal Types [](#available-cache-removal-types) **Cache Type****Description****Template Cache**Removes compiled **Twig template files**.**Internal Cache**Clears OXID eShop’s **internal caching mechanism**.**Container Cache**Clears the **dependency injection container cache** (Symfony-based).**Module Caches**Clears caches related to **installed modules**.**All Caches**Performs a **complete cache reset** (combining all above caches).Usage ----- [](#usage) This assumes you have OXID eShop (at least `OXID-eSales/oxideshop_ce: v7.5.0` component, which is part of the `7.5.0` compilation) up and running. Admin Panel Usage - Go to the Admin Backoffice. - Locate the Cache Clear Dropdown in the header. - Select the cache type you want to clear. - Click Clear Cache. OXAPI Integration ----------------- [](#oxapi-integration) The module extends **GraphQL API (OXAPI)**, allowing cache clearing via API. ``` # Install and activate compatible version of oxid-esales/graphql-base for OXID 7.5. # $ composer require oxid-esales/graphql-base:dev-b-7.5.x $ ./vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_base $ ./vendor/bin/oe-console oe:module:activate oe_graphql_base ``` ### Available GraphQL Queries [](#available-graphql-queries) **Query Name****Functionality**`clearTemplateCache`Clears template-related cache.`clearInternalCache`Clears internal system cache.`clearContainerCache`Clears DI container cache.`clearModuleCaches`Clears module-related cache.`clearCaches`Clears all caches at once.### OXAPI Authentication Requirements [](#oxapi-authentication-requirements) To clear caches via GraphQL API, a user **must be authenticated** and have the required permissions. ### **Authentication Details** [](#authentication-details) - Requires a **valid OXAPI JWT token** in the `Authorization` header. - The user must belong to the **"gqladmintoolscache"** user group. ### **Example GraphQL Request** [](#example-graphql-request) Here’s how to **clear all caches** using GraphQL. #### **GraphQL Query** [](#graphql-query) ``` query { clearCaches } ``` Only a logged in user with sufficient OXAPI permission will be permitted to call these queries. 'Logged in' means valid OXAPI JWT with sufficient permissions is sent in Authorization Bearer Header. User in question must be a member of 'gqladmintoolscache' usergroup. Controller as a Service ----------------------- [](#controller-as-a-service) The module provides **ShopController as a service**, making it **extendable, testable, and reusable**. ### **Example: ShopController** [](#example-shopcontroller) The **ShopController** is now registered as a **service** in `Shop/Controller/services.yaml`: ``` services: OxidEsales\AdminTools\CacheClear\Shop\Controller\ShopController: tags: - { name: 'oxid.controller', controller_key: 'admintoolscacheclear' } public: true ``` Development installation on OXID eShop SDK ========================================== [](#development-installation-on-oxid-eshop-sdk) The installation instructions below are shown for the current [SDK](https://github.com/OXID-eSales/docker-eshop-sdk)for shop 7.5. Make sure your system meets the requirements of the SDK. 1. Ensure all docker containers are down to avoid port conflicts 2. Clone the SDK for the new project ``` echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_ ``` 2. Clone the repository to the source directory ``` git clone --recurse-submodules https://github.com/OXID-eSales/admin-tools-module.git --branch=b-7.5.x ./source ``` 3. Run the recipe to setup the development environment ``` ./source/recipes/setup-development.sh ``` You should be able to access the shop via - Frontend - Admin Panel: - (credentials: / admin) ### Running tests locally [](#running-tests-locally) Check the "scripts" section in the `composer.json` file for the available commands. Those commands can be executed by connecting to the php container and running the command from there, example: ``` make php composer tests-coverage ``` Commands can be also triggered directly on the container with docker compose, example: ``` docker compose exec -T php composer tests-coverage ``` License ------- [](#license) OXID Module and Component License, see [LICENSE file](LICENSE). ### Health Score 44 — FairBetter than 92% of packages Maintenance77 Regular maintenance activity Popularity21 Limited adoption so far Community13 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 50% 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. ### Release Activity Cadence Every ~98 days Total 3 Last Release 194d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1374817?v=4)[oxid](/maintainers/oxid)[@OxID](https://github.com/OxID) --- Top Contributors [![hkreuter](https://avatars.githubusercontent.com/u/3692295?v=4)](https://github.com/hkreuter "hkreuter (15 commits)")[![RahatHameed](https://avatars.githubusercontent.com/u/11661532?v=4)](https://github.com/RahatHameed "RahatHameed (11 commits)")[![michaelkeiluweit](https://avatars.githubusercontent.com/u/2961521?v=4)](https://github.com/michaelkeiluweit "michaelkeiluweit (1 commits)")[![NikolaIvanovski](https://avatars.githubusercontent.com/u/8055347?v=4)](https://github.com/NikolaIvanovski "NikolaIvanovski (1 commits)")[![TitaKoleva](https://avatars.githubusercontent.com/u/22682166?v=4)](https://github.com/TitaKoleva "TitaKoleva (1 commits)")[![tkcreateit](https://avatars.githubusercontent.com/u/42207462?v=4)](https://github.com/tkcreateit "tkcreateit (1 commits)") --- Tags OXIDmoduleseshop ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP\_CodeSniffer Type Coverage Yes ### Embed Badge ![Health badge](/badges/oxid-esales-admin-tools/health.svg) ``` [![Health](https://phpackages.com/badges/oxid-esales-admin-tools/health.svg)](https://phpackages.com/packages/oxid-esales-admin-tools) ``` ### Alternatives [ddoe/wysiwyg-editor-module Summernote WYSIWYG Editor for OXID eShop. 19981.7k2](/packages/ddoe-wysiwyg-editor-module)[oxid-esales/gdpr-optin-module This is the GDPR opt-in module for the OXID eShop. 20459.1k2](/packages/oxid-esales-gdpr-optin-module) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)