PHPackages oxid-esales/coding-standards - 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. [PSR & Standards](/categories/psr-standards) 4. / 5. oxid-esales/coding-standards ActiveLibrary[PSR & Standards](/categories/psr-standards) oxid-esales/coding-standards ============================ OXID eShop coding standards v3.0.5(7y ago)8173.5k↓42.6%75GPL-3.0-onlyPHP Since Mar 24Pushed 7y ago25 watchersCompare [ Source](https://github.com/OXID-eSales/coding_standards)[ Packagist](https://packagist.org/packages/oxid-esales/coding-standards)[ Docs](https://www.oxid-esales.com/en/home.html)[ RSS](/packages/oxid-esales-coding-standards/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (8)Dependencies (1)Versions (13)Used By (5) OXID Coding Standards ===================== [](#oxid-coding-standards) This repository includes OXID eShop coding standards definition for PHP Codesniffer along with a PHPStorm autoformat config file. The PHP\_CodeSniffer standard will never be 100% accurate, but should be viewed as a strong set of guidelines while contributing to OXID eShop. See OXID eShop coding standards documentation at Requirements ------------ [](#requirements) - Latest Composer version Installation ------------ [](#installation) Coding Standards setup uses composer to get required packages, so make sure to have composer installed and accessible. You can find composer installation guide [here](https://getcomposer.org/download/). ### Selecting where to install coding standards [](#selecting-where-to-install-coding-standards) Coding Standards can be installed directly within shop or to any other directory. However, installation varies slightly depending on selected location. We advise to install it using shop directory. #### Option 1: Selecting shop directory for installation (preferred way) [](#option-1-selecting-shop-directory-for-installation-preferred-way) To install Coding Standards within shop directory, update/create `composer.json` with following values: ``` { "name": "oxid-esales/eshop", "description": "OXID eShop", "type": "project", "keywords": ["oxid", "modules", "eShop"], "homepage": "https://www.oxid-esales.com/en/home.html", "license": [ "GPL-3.0", "proprietary" ], "repositories": { "oxid-esales/coding-standards": { "type": "vcs", "url": "https://github.com/OXID-eSales/coding_standards.git" }, "squizlabs/php_codesniffer": { "type": "vcs", "url": "https://github.com/OXID-eSales/PHP_CodeSniffer.git" } }, "require-dev": { "oxid-esales/coding-standards": "^2.0.0" }, "minimum-stability": "dev", "prefer-stable": true } ``` Installing this way, you can use `phpcsoxid` binary to check your shop directory for standards errors by `shop/path/vendor/bin/phpcsoxid`. Latest development shop version already includes composer.json file in its source, so no changes needs to be made. #### Option 2: Selecting any directory for installation (alternative way) [](#option-2-selecting-any-directory-for-installation-alternative-way) To install Coding Standards to any directory, you need to checkout Coding Standards from Github into desired directory (`git clone https://github.com/OXID-eSales/coding_standards.git`). Installing this way, binaries will be accessible from `coding_standards/bin`. You must manually set what directory you want to check for conding standards errors by giving directory path as argument for oxid phpcs binary, like: `phpcsoxid /path/to/my/shop/`. ### Installing Coding Standards [](#installing-coding-standards) After you selected where you want to install the Coding Standards, follow these steps: 1. Navigate to the directory that you picked for installation. 2. Use composer to setup Coding Standards components (`composer install`). Ensure you do this from within the directory where `composer.json` is located. Running Coding Standards checks ------------------------------- [](#running-coding-standards-checks) To run coding standards checkings, use phpcsoxid binary by: `phpcsoxid` - run phpcs with preconfigured Oxid standard, and show list of errors. `phpcsoxid /some/other/path` - run phpcs with preconfigured Oxid standard on some specific directory *(You must always provide directory for checking if coding standards was not installed by "Option 1" installation method.)* It is possible to use standard codesniffer(phpcs) options too, like: `phpcsoxid --report=summary` Alternatively, it is possible to use original phpcs, but you must configure it by yourself. As example: `phpcs --standard=/path/to/Standard/directory/Oxid/ /path/to/directory/for/checking/standards` ### Health Score 43 — FairBetter than 91% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity40 Moderate usage in the ecosystem Community32 Small or concentrated contributor base Maturity70 Established project with proven stability Bus Factor4 4 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 ~167 days Recently: every ~134 days Total 8 Last Release 2903d ago Major Versions 2.0.0 → v3.0.12016-12-16 v2.x-dev → v3.0.22017-06-02 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1374817?v=4)[oxid](/maintainers/oxid)[@OxID](https://github.com/OxID) --- Top Contributors [![MantasVaitkunas](https://avatars.githubusercontent.com/u/623436?v=4)](https://github.com/MantasVaitkunas "MantasVaitkunas (10 commits)")[![Sieg](https://avatars.githubusercontent.com/u/98882?v=4)](https://github.com/Sieg "Sieg (8 commits)")[![roman-1983](https://avatars.githubusercontent.com/u/3573021?v=4)](https://github.com/roman-1983 "roman-1983 (5 commits)")[![nymo](https://avatars.githubusercontent.com/u/884833?v=4)](https://github.com/nymo "nymo (4 commits)")[![robertblank](https://avatars.githubusercontent.com/u/7868142?v=4)](https://github.com/robertblank "robertblank (3 commits)")[![rezonanc-oxid](https://avatars.githubusercontent.com/u/8058763?v=4)](https://github.com/rezonanc-oxid "rezonanc-oxid (3 commits)")[![alfredbez](https://avatars.githubusercontent.com/u/1001186?v=4)](https://github.com/alfredbez "alfredbez (2 commits)")[![Buratinas](https://avatars.githubusercontent.com/u/2518079?v=4)](https://github.com/Buratinas "Buratinas (2 commits)")[![sauliusstasiukaitis](https://avatars.githubusercontent.com/u/3603014?v=4)](https://github.com/sauliusstasiukaitis "sauliusstasiukaitis (2 commits)")[![sebbbbauer](https://avatars.githubusercontent.com/u/1807282?v=4)](https://github.com/sebbbbauer "sebbbbauer (2 commits)")[![kermie](https://avatars.githubusercontent.com/u/1337898?v=4)](https://github.com/kermie "kermie (1 commits)")[![tarique-iqbal](https://avatars.githubusercontent.com/u/1391042?v=4)](https://github.com/tarique-iqbal "tarique-iqbal (1 commits)")[![vilmal](https://avatars.githubusercontent.com/u/3765393?v=4)](https://github.com/vilmal "vilmal (1 commits)")[![Shiftas](https://avatars.githubusercontent.com/u/3593099?v=4)](https://github.com/Shiftas "Shiftas (1 commits)")[![jarome-artse](https://avatars.githubusercontent.com/u/12874483?v=4)](https://github.com/jarome-artse "jarome-artse (1 commits)")[![smxsm](https://avatars.githubusercontent.com/u/1737182?v=4)](https://github.com/smxsm "smxsm (1 commits)")[![paumas](https://avatars.githubusercontent.com/u/2369888?v=4)](https://github.com/paumas "paumas (1 commits)")[![OXID-Admin](https://avatars.githubusercontent.com/u/10544667?v=4)](https://github.com/OXID-Admin "OXID-Admin (1 commits)") --- Tags developer-toolsoxid-eshopphp-codesnifferstandardsOXIDeshop ### Embed Badge ![Health badge](/badges/oxid-esales-coding-standards/health.svg) ``` [![Health](https://phpackages.com/badges/oxid-esales-coding-standards/health.svg)](https://phpackages.com/packages/oxid-esales-coding-standards) ``` ### Alternatives [phpcompatibility/php-compatibility A set of sniffs for PHP\_CodeSniffer that checks for PHP cross-version compatibility. 2.3k74.3M1.3k](/packages/phpcompatibility-php-compatibility)[automattic/vipwpcs PHP\_CodeSniffer rules (sniffs) to enforce WordPress VIP minimum coding conventions 25510.2M145](/packages/automattic-vipwpcs)[wptrt/wpthemereview PHP\_CodeSniffer rules (sniffs) to verify theme compliance with the rules for theme hosting on wordpress.org 217736.5k29](/packages/wptrt-wpthemereview)[yoast/yoastcs PHP\_CodeSniffer rules for Yoast projects 221.1M29](/packages/yoast-yoastcs)[mayflower/mo4-coding-standard PHP CodeSniffer ruleset implementing the MO4 coding standards extending the Symfony coding standards. 17508.3k5](/packages/mayflower-mo4-coding-standard)[orisai/coding-standard Strict PHP coding standard 19193.5k62](/packages/orisai-coding-standard) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)