{"id":18948395,"url":"https://github.com/oxid-esales/eshop-facts","last_synced_at":"2026-03-27T12:30:19.325Z","repository":{"id":57034524,"uuid":"67696530","full_name":"OXID-eSales/eshop-facts","owner":"OXID-eSales","description":"Deprecated, please use oxideshop-facts repository instead.","archived":false,"fork":false,"pushed_at":"2019-01-25T19:06:36.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-01-01T01:26:41.084Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OXID-eSales.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-08T11:19:35.000Z","updated_at":"2019-01-25T19:06:38.000Z","dependencies_parsed_at":"2022-08-23T20:50:45.099Z","dependency_job_id":null,"html_url":"https://github.com/OXID-eSales/eshop-facts","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Feshop-facts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Feshop-facts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Feshop-facts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Feshop-facts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXID-eSales","download_url":"https://codeload.github.com/OXID-eSales/eshop-facts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239946902,"owners_count":19723017,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T13:13:24.348Z","updated_at":"2026-03-27T12:30:19.292Z","avatar_url":"https://github.com/OXID-eSales.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"OXID eShop facts\n================\n\nThis component is dedicated to provide primary information/facts about current\neShop installation. The information is provided in two ways:\n\n* Printed to ``STDOUT`` (*triggered with* ``VERBOSE=1`` *environment variable*);\n* Exposed to sub-processes as environment variables.\n\nOutput\n------\n\nThe following information is provided after executing the script:\n\n* ``ESHOP_PHP_BIN_PATH`` - Full path to PHP binary file which will be used to\n  run scripts through CLI;\n* ``ESHOP_FACT_BIN_PATH`` - Full path of current ``oe-eshop-facts`` script being\n  executed;\n* ``ESHOP_FACT_BASEDIR`` - Full path to a directory where other fact related\n  script can be found;\n* ``ESHOP_SOURCE_PATH`` - Full path to eShop runtime source and front\n  controllers;\n* ``ESHOP_BOOTSTRAP_PATH`` - Full path to eShop ``bootstrap.php`` file;\n* ``ESHOP_CONFIG_PATH`` - Full path to eShop ``config.inc.php`` file;\n* ``ESHOP_VENDOR_PATH`` - Full path to composer's ``vendor`` directory;\n* ``ESHOP_VENDOR_BIN_PATH`` - Full path to binary files which were installed by\n  defined dependencies inside ``composer.json`` file;\n* ``ESHOP_VENDOR_NAME`` - Composer vendor name used as identifier for\n  OXID eSales AG;\n* ``ESHOP_OXID_VENDOR_PATH`` - Full path to directory which contains all the\n  packages/components from OXID eSales AG.\n\nKeep in mind that it's possible to override any variable from the list above\nby providing it as an environment variable, e.g. in order to change the path to\nPHP binary:\n\n``ESHOP_PHP_BIN_PATH=/usr/local/bin/php ./vendor/bin/oe-eshop-facts``\n\nInput\n-----\n\nThe following environment variables are accepted:\n\n* ``VERBOSE`` - Enables verbose mode which prints out all facts to ``STDOUT``;\n* ``ESHOP_VERBOSE_FACTS`` - Enables verbose mode only for the current script.\n\nScript execution\n----------------\n\nCurrent ``oe-eshop-facts`` script can be used for execution of other scripts\nwhich are installed by composer packages/components. The given script will have\nall of the facts accessable from the output section above and provided as\nenvironment variables. In order to execute other script just provide it as an\ncommand line argument, e.g.\n\n``./vendor/bin/oe-eshop-facts my_custum_script``\n\nKeep in mind that the provided script must be within the same directory as\nthe ``oe-eshop-facts`` file.\n\nCustom composer commands\n------------------------\n\nFact script can be used to provide additional commands to composer as it\nprovides all necessary information to reach eShop files, e.g.\n\nTo have the following command valid ``composer my_custom_script`` just add:\n\n.. code::\n\n  ...\n  \"require\": {\n    ...\n    \"oxid-esales/eshop-facts\": \"dev-master\"\n  },\n  scripts: {\n    \"my_custom_script\": \"oe-eshop-facts my_custom_script\"\n  }\n  ...\n\nPotential usages\n----------------\n\nTo get better understanding where this component can be used, few examples to\nexplore:\n\n* Integrate 3rd party database migration tools\n* Execute eShop internal methods through CLI\n\n  * Regenerate database views\n  * Clean eShop specific cache\n\n* Modify eShop's configuration through the help of CLI\n* Import/export eShop data through CLI\n* Various bulk operations through CLI\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Feshop-facts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxid-esales%2Feshop-facts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Feshop-facts/lists"}