Download the PHP package oxid-esales/admin-tools without Composer
On this page you can find all versions of the php package oxid-esales/admin-tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oxid-esales/admin-tools
More information about oxid-esales/admin-tools
Files in oxid-esales/admin-tools
Package admin-tools
Short Description Module with solution examples
License proprietary
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package admin-tools
OXID eShop 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
- 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
- b-7.4.x branch is compatible with b-7.4.x shop compilation branches
- 1.x versions (or b-7.3.x branch) are compatible with latest shop compilation 7.3.x resp. b-7.3.x shop compilation branches
Install and activate
You should run migrations both after installing the module and after each module update:
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
| 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
This assumes you have OXID eShop (at least OXID-eSales/oxideshop_ce: v7.3.0 component, which is part of the 7.3.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
The module extends GraphQL API (OXAPI), allowing cache clearing via API.
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
To clear caches via GraphQL API, a user must be authenticated and have the required permissions.
Authentication Details
- Requires a valid OXAPI JWT token in the
Authorizationheader. - The user must belong to the "gqladmintoolscache" user group.
Example GraphQL Request
Here’s how to clear all caches using GraphQL.
GraphQL Query
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
The module provides ShopController as a service, making it extendable, testable, and reusable.
Example: ShopController
The ShopController is now registered as a service in Shop/Controller/services.yaml:
Development installation on OXID eShop SDK
The installation instructions below are shown for the current SDK for shop 7.4. Make sure your system meets the requirements of the SDK.
-
Ensure all docker containers are down to avoid port conflicts
-
Clone the SDK for the new project
-
Clone the repository to the source directory
- Run the recipe to setup the development environment
You should be able to access the shop via
- Frontend http://localhost.local
- Admin Panel: http://localhost.local/admin
- (credentials: [email protected] / admin)
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:
Commands can be also triggered directly on the container with docker compose, example:
License
OXID Module and Component License, see LICENSE file.
