PHPackages                             oxid-esales/eshop-facts - 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. oxid-esales/eshop-facts

ActiveLibrary

oxid-esales/eshop-facts
=======================

OXID eShop facts

v1.0.2(9y ago)133.9k3GPL-3.0Shell

Since Oct 27Pushed 7y ago16 watchersCompare

[ Source](https://github.com/OXID-eSales/eshop-facts)[ Packagist](https://packagist.org/packages/oxid-esales/eshop-facts)[ RSS](/packages/oxid-esales-eshop-facts/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (3)DependenciesVersions (4)Used By (3)

OXID eShop facts
================

[](#oxid-eshop-facts)

This component is dedicated to provide primary information/facts about current eShop installation. The information is provided in two ways:

- Printed to `STDOUT` (*triggered with* `VERBOSE=1` *environment variable*);
- Exposed to sub-processes as environment variables.

Output
------

[](#output)

The following information is provided after executing the script:

- `ESHOP_PHP_BIN_PATH` - Full path to PHP binary file which will be used to run scripts through CLI;
- `ESHOP_FACT_BIN_PATH` - Full path of current `oe-eshop-facts` script being executed;
- `ESHOP_FACT_BASEDIR` - Full path to a directory where other fact related script can be found;
- `ESHOP_SOURCE_PATH` - Full path to eShop runtime source and front controllers;
- `ESHOP_BOOTSTRAP_PATH` - Full path to eShop `bootstrap.php` file;
- `ESHOP_CONFIG_PATH` - Full path to eShop `config.inc.php` file;
- `ESHOP_VENDOR_PATH` - Full path to composer's `vendor` directory;
- `ESHOP_VENDOR_BIN_PATH` - Full path to binary files which were installed by defined dependencies inside `composer.json` file;
- `ESHOP_VENDOR_NAME` - Composer vendor name used as identifier for OXID eSales AG;
- `ESHOP_OXID_VENDOR_PATH` - Full path to directory which contains all the packages/components from OXID eSales AG.

Keep in mind that it's possible to override any variable from the list above by providing it as an environment variable, e.g. in order to change the path to PHP binary:

`ESHOP_PHP_BIN_PATH=/usr/local/bin/php ./vendor/bin/oe-eshop-facts`

Input
-----

[](#input)

The following environment variables are accepted:

- `VERBOSE` - Enables verbose mode which prints out all facts to `STDOUT`;
- `ESHOP_VERBOSE_FACTS` - Enables verbose mode only for the current script.

Script execution
----------------

[](#script-execution)

Current `oe-eshop-facts` script can be used for execution of other scripts which are installed by composer packages/components. The given script will have all of the facts accessable from the output section above and provided as environment variables. In order to execute other script just provide it as an command line argument, e.g.

`./vendor/bin/oe-eshop-facts my_custum_script`

Keep in mind that the provided script must be within the same directory as the `oe-eshop-facts` file.

Custom composer commands
------------------------

[](#custom-composer-commands)

Fact script can be used to provide additional commands to composer as it provides all necessary information to reach eShop files, e.g.

To have the following command valid `composer my_custom_script` just add:

```
...
"require": {
  ...
  "oxid-esales/eshop-facts": "dev-master"
},
scripts: {
  "my_custom_script": "oe-eshop-facts my_custom_script"
}
...
```

Potential usages
----------------

[](#potential-usages)

To get better understanding where this component can be used, few examples to explore:

- Integrate 3rd party database migration tools
- Execute eShop internal methods through CLI
    - Regenerate database views
    - Clean eShop specific cache
- Modify eShop's configuration through the help of CLI
- Import/export eShop data through CLI
- Various bulk operations through CLI

###  Health Score

35

—

LowBetter than 79% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~73 days

Total

3

Last Release

3338d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1374817?v=4)[oxid](/maintainers/oxid)[@OxID](https://github.com/OxID)

---

Top Contributors

[![BenjaminJoerger](https://avatars.githubusercontent.com/u/3601583?v=4)](https://github.com/BenjaminJoerger "BenjaminJoerger (4 commits)")[![rezonanc-oxid](https://avatars.githubusercontent.com/u/8058763?v=4)](https://github.com/rezonanc-oxid "rezonanc-oxid (4 commits)")[![tarique-iqbal](https://avatars.githubusercontent.com/u/1391042?v=4)](https://github.com/tarique-iqbal "tarique-iqbal (2 commits)")

### Embed Badge

![Health badge](/badges/oxid-esales-eshop-facts/health.svg)

```
[![Health](https://phpackages.com/badges/oxid-esales-eshop-facts/health.svg)](https://phpackages.com/packages/oxid-esales-eshop-facts)
```

PHPackages © 2026

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