# PHP Coding Style

This is the PHP coding style for the [ILIAS project](https://github.com/ILIAS-eLearning/ILIAS).

## PSR-12 and additions

The ILIAS coding standard is aligned to the widely used and established [PSR-12 standard](https://www.php-fig.org/psr/psr-12/)
of the [PHP Interop Group (PHP-FIG)](https://www.php-fig.org/), extended by the
following additions:

### Property and Variable Names

Names of properties and variables MUST be written in underscore-case:

```php
$foo_bar = 3;
$this->foo_bar = 3;

```

### Type cast

Spaces MUST be added after a type cast.

```php
$foo = (int) '12345';
```

## Code Style Checks and Fixes

The ILIAS code style can be checked/applied with/by different tools.

When working with the `PhpStorm` IDE developers can import the
[PhpStorm Code Style](./code-style-configs/php-storm.xml).

Furthermore multiple [Git Hooks](./git-hooks.md) are provided
to [check or fix the code style](https://github.com/ILIAS-eLearning/DeveloperTools/tree/master/git_hooks/hooks/code-style)
of changed files in a Git commit.

Another possibility to apply the code style checks is to import and run
the [PhpStorm PHP Code Inspection Profile](./inspection-configs/php-storm-php-inspections.xml).
This does not only check the ILIAS Coding Style but applies other inspection
rules to the PHP code base (or parts of it) as well. 

Developers can additionally use the [PHP Coding Standards Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)
to check or fix one or multiple files.

### Checking Code Style

```bash
vendor/composer/vendor/bin/php-cs-fixer fix --dry-run --stop-on-violation --using-cache=no --diff --config=./scripts/PHP-CS-Fixer/code-format.php_cs [FILE]
```
### Fixing Code Style

```bash
vendor/composer/vendor/bin/php-cs-fixer fix --stop-on-violation --using-cache=no --diff --config=./scripts/PHP-CS-Fixer/code-format.php_cs [FILE]
```