CodeIgniter Coding Standard

https://github.com/codeigniter/coding-standard
Admin
CodeIgniter Coding Standard is a PHP coding standards library based on PHP CS Fixer that enforces...
Tokens:17,620
Snippets:347
Trust Score:5.5
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and Run Pre-commit

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Commands to install the pre-commit framework and execute checks.

```bash
pip install pre-commit
pre-commit install
pre-commit run --all-files
```

--------------------------------

### Basic Configuration Setup

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/api-reference/CodeIgniter4.md

Initializes the configuration using default settings for a standard project.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

// Create configuration with defaults
$config = Factory::create(new CodeIgniter4())->forProjects();
```

--------------------------------

### Install and Run Coding Standard

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/overview.md

Commands to install the coding standard via Composer and execute the fixer.

```bash
composer require --dev codeigniter/coding-standard
```

```bash
vendor/bin/php-cs-fixer fix --verbose
```

--------------------------------

### Configure Basic Project Setup

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/overview.md

Initializes the coding standard for a standard project using the CodeIgniter4 factory.

```php
<?php
use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

return Factory::create(new CodeIgniter4())->forProjects();
```

--------------------------------

### Install Coding Standard via Composer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Add the package as a development or regular dependency to your project.

```bash
# As development dependency (recommended)
composer require --dev codeigniter/coding-standard

# Or as regular dependency
composer require codeigniter/coding-standard
```

--------------------------------

### Configure Library Setup with License Header

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/overview.md

Initializes the coding standard for a library, including parameters for the license header generation.

```php
<?php
use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

return Factory::create(new CodeIgniter4())->forLibrary(
    'My Library Name',
    'My Organization',
    'contact@example.com',
    2024,
);
```

--------------------------------

### Run Docker Compose

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Command to start the PHP CS Fixer service via Docker Compose.

```bash
docker-compose up
```

--------------------------------

### Automate Tasks with Makefile

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Provides a Makefile to simplify dependency installation and coding standard maintenance tasks.

```makefile
.PHONY: fix-cs check-cs install clean

# Install dependencies
install:
	composer install

# Fix coding standards
fix-cs:
	vendor/bin/php-cs-fixer fix --verbose

# Check coding standards without fixing
check-cs:
	vendor/bin/php-cs-fixer fix --dry-run --verbose

# Alias for check
lint: check-cs

# Clean cache
clean:
	rm -f .php-cs-fixer.cache

# Run all quality checks
quality: check-cs

# Help
help:
	@echo "Available targets:"
	@echo "  make install       - Install dependencies"
	@echo "  make fix-cs        - Fix coding standards"
	@echo "  make check-cs      - Check coding standards"
	@echo "  make lint          - Alias for check-cs"
	@echo "  make clean         - Clean cache files"
	@echo "  make quality       - Run all quality checks"
```

--------------------------------

### Install CodeIgniter Coding Standard via Composer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Add the package to your project as either a development or regular dependency.

```bash
composer require --dev codeigniter/coding-standard
```

```bash
composer require codeigniter/coding-standard
```

--------------------------------

### Configure Azure Pipelines for PHP-CS-Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Sets up a pipeline on Azure to install dependencies and execute PHP-CS-Fixer checks.

```yaml
trigger:
  - main
  - develop

pr:
  - main
  - develop

pool:
  vmImage: 'ubuntu-latest'

variables:
  phpVersion: '8.2'

steps:
  - task: UsePHPVersion@0
    inputs:
      version: $(phpVersion)

  - script: |
      curl -sS https://getcomposer.org/installer | php
      php composer.phar install
    displayName: 'Install dependencies'

  - script: |
      vendor/bin/php-cs-fixer fix --dry-run --verbose
    displayName: 'Run PHP CS Fixer'
```

--------------------------------

### Integrate PHP-CS-Fixer with CI/CD

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Configuration examples for automating coding standard checks in GitHub Actions and GitLab CI pipelines.

```yaml
name: Coding Standards

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.2'
      
      - name: Install dependencies
        run: composer install
      
      - name: Check coding standards
        run: vendor/bin/php-cs-fixer fix --dry-run --verbose
```

```yaml
php-cs-fixer:
  image: php:8.2
  script:
    - composer install
    - vendor/bin/php-cs-fixer fix --dry-run --verbose
```

--------------------------------

### Setup PHP CS Fixer Configuration

Source: https://github.com/codeigniter/coding-standard/blob/1.x/README.md

Create a .php-cs-fixer.dist.php file at the root of your project to configure the CodeIgniter Coding Standard.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

return Factory::create(new CodeIgniter4())->forProjects();

```

--------------------------------

### Jenkins Declarative Pipeline Configurations

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Declarative Jenkinsfile examples for executing PHP CS Fixer, including support for JUnit reporting.

```groovy
pipeline {
    agent any

    stages {
        stage('Install Dependencies') {
            steps {
                sh 'composer install'
            }
        }

        stage('PHP CS Fixer') {
            steps {
                sh 'vendor/bin/php-cs-fixer fix --dry-run --verbose'
            }
        }
    }

    post {
        failure {
            echo 'PHP CS Fixer found violations!'
        }
    }
}
```

```groovy
pipeline {
    agent any

    stages {
        stage('Install') {
            steps {
                sh 'composer install'
            }
        }

        stage('Check Formatting') {
            steps {
                catchError(buildResult: 'UNSTABLE', stageResult: 'FAILURE') {
                    sh 'vendor/bin/php-cs-fixer fix --dry-run --verbose --diff'
                }
            }
        }
    }

    post {
        always {
            archiveArtifacts artifacts: '.php-cs-fixer.cache', allowEmptyArchive: true
        }
    }
}
```

--------------------------------

### Update package and autoloader

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Run these commands to resolve class not found errors by ensuring dependencies are installed and the autoloader is optimized.

```bash
composer install
composer dump-autoload -o
```

--------------------------------

### Add License Headers to PHP Files

Source: https://github.com/codeigniter/coding-standard/blob/1.x/README.md

Configure the coding standard to automatically add license headers to your PHP files. Provide library name, author name, email, and starting year.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

return Factory::create(new CodeIgniter4())->forLibrary(
    'CodeIgniter 4 framework',
    'CodeIgniter Foundation',
    'admin@codeigniter.com',
    2021,
);

```

--------------------------------

### Configure Overriding Rules and Options

Source: https://github.com/codeigniter/coding-standard/blob/1.x/README.md

Modify the PhpCsFixer\Config instance by providing overriding rules or options. This example disables caching.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

return Factory::create(new CodeIgniter4(), [], [
    'usingCache' => false,
])->forProjects();

```

--------------------------------

### Order class elements

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces a specific sequence for class members, starting with traits, followed by constants, properties, and methods.

```php
class MyClass {
    use Trait;
    private $prop;
    public function method() {}
}
```

--------------------------------

### Define Dockerfile for PHP CS Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

A Dockerfile configuration to install dependencies and execute PHP CS Fixer in a CLI environment.

```dockerfile
FROM php:8.2-cli

WORKDIR /app

# Install Composer
COPY --from=composer:latest /usr/bin/composer /usr/bin/composer

# Copy files
COPY . .

# Install dependencies
RUN composer install

# Run PHP CS Fixer
CMD ["vendor/bin/php-cs-fixer", "fix", "--dry-run", "--verbose"]
```

--------------------------------

### Create a configuration instance

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/configuration.md

Initialize the configuration using the Factory class with the CodeIgniter4 standard.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

// Create with default configuration
$config = Factory::create(new CodeIgniter4())->forProjects();
```

--------------------------------

### Configure for Library with License Headers

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Use the forLibrary method to include license headers in your project files.

```php
<?php

declare(strict_types=1);

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

return Factory::create(new CodeIgniter4())->forLibrary(
    'Your Library Name',
    'Your Organization Name',
    'contact@example.com',
    2024,  // Starting year for license
);
```

--------------------------------

### Create PHP CS Fixer Configuration

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Initialize the fixer by creating a .php-cs-fixer.dist.php file in the project root.

```php
<?php

declare(strict_types=1);

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

return Factory::create(new CodeIgniter4())->forProjects();
```

--------------------------------

### Full Featured Configuration

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Combine custom finders, rule overrides, and caching options into a single configuration.

```php
<?php

declare(strict_types=1);

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;
use PhpCsFixer\Finder;

$finder = Finder::create()
    ->files()
    ->in([__DIR__])
    ->exclude(['build', 'vendor'])
    ->append([__FILE__]);

$overrides = [
    'declare_strict_types' => true,
];

$options = [
    'finder' => $finder,
    'usingCache' => true,
    'cacheFile' => '.php-cs-fixer.cache',
];

return Factory::create(new CodeIgniter4(), $overrides, $options)->forLibrary(
    'My Project',
    'My Organization',
    'support@example.com',
    2024,
);
```

--------------------------------

### Configure with Custom Finder

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Define specific directories or files to be processed by the fixer.

```php
<?php

declare(strict_types=1);

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;
use PhpCsFixer\Finder;

$finder = Finder::create()
    ->files()
    ->in([__DIR__])
    ->exclude(['build', 'vendor', 'node_modules'])
    ->append([__FILE__]);

$options = [
    'finder' => $finder,
];

return Factory::create(new CodeIgniter4(), [], $options)->forProjects();
```

--------------------------------

### Build and Run Docker Container

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Commands to build the Docker image and execute the fixer against the current directory.

```bash
docker build -t php-cs-fixer .
docker run --rm -v $(pwd):/app php-cs-fixer
```

--------------------------------

### Display File Size Reference

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/INDEX.md

A summary of file sizes and line counts for the project documentation.

```text
total 144K
  11K README.md
  28K configuration.md (largest)
  13K integration-guide.md
  8.1K overview.md
  6.6K quick-start.md (smallest)
  24K rule-categories.md
  42K rule-reference.md (most comprehensive)
  169 lines api-reference/CodeIgniter4.md
```

--------------------------------

### Project Directory Structure

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/overview.md

Visual representation of the project file hierarchy and configuration files.

```text
coding-standard/
├── src/
│   └── CodeIgniter4.php              # Main ruleset class
├── tests/
│   └── CodeIgniter4Test.php          # Test suite
├── .php-cs-fixer.dist.php            # Example configuration
├── phpstan.dist.neon                 # Static analysis config
├── phpunit.dist.xml                  # Test configuration
├── composer.json                     # Package definition
├── CHANGELOG.md                      # Version history
├── CONTRIBUTING.md                  # Contribution guidelines
├── LICENSE                           # MIT license
└── README.md                         # User documentation
```

--------------------------------

### Library Configuration with License Header

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/api-reference/CodeIgniter4.md

Configures the ruleset specifically for a library, including metadata for license headers.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

// Create configuration for a library with license header
$config = Factory::create(new CodeIgniter4())->forLibrary(
    'My Library Name',
    'My Organization',
    'contact@example.com',
    2024,
);
```

--------------------------------

### Commit Configuration to Version Control

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Add and commit the configuration file to your repository.

```bash
git add .php-cs-fixer.dist.php
git commit -m "Add PHP CS Fixer configuration"
```

--------------------------------

### Configure Vim/Neovim with ALE

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Vim configuration to integrate PHP CS Fixer with the ALE plugin.

```vim
let g:ale_php_cs_fixer_executable = 'vendor/bin/php-cs-fixer'
let g:ale_fixers = {
    \ 'php': ['php_cs_fixer'],
    \ }
let g:ale_fix_on_save = 1
```

--------------------------------

### Configure with Rule Overrides

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Customize specific coding rules by passing an array of overrides.

```php
<?php

declare(strict_types=1);

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

$overrides = [
    'declare_strict_types' => true,
    'single_line_comment_style' => false,
    'phpdoc_summary' => false,
];

return Factory::create(new CodeIgniter4(), $overrides)->forProjects();
```

--------------------------------

### Document Formatting Commands in README

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Markdown snippets for documenting formatting and checking commands in project documentation.

```markdown
## Code Formatting

We use PHP CS Fixer with the CodeIgniter standard.

Format your code:
```bash
vendor/bin/php-cs-fixer fix
```

Check without fixing:
```bash
vendor/bin/php-cs-fixer fix --dry-run
```
```

--------------------------------

### Configure Pre-commit Framework

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Define the local hook configuration for the pre-commit framework.

```yaml
repos:
  - repo: local
    hooks:
      - id: php-cs-fixer
        name: PHP CS Fixer
        entry: vendor/bin/php-cs-fixer fix
        language: system
        types: [php]
        stages: [commit]
```

--------------------------------

### Constructor Definition

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/api-reference/CodeIgniter4.md

The constructor initializes the ruleset with default configurations, including PHP 8.1+ requirements.

```php
public function __construct(): void
```

--------------------------------

### Run PHP-CS-Fixer Commands

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Common CLI commands for fixing code style, previewing changes, and configuring execution.

```bash
vendor/bin/php-cs-fixer fix --verbose
```

```bash
vendor/bin/php-cs-fixer fix --dry-run --verbose
```

```bash
vendor/bin/php-cs-fixer fix src/ --verbose
```

```bash
vendor/bin/php-cs-fixer fix --jobs=4 --verbose
```

```bash
vendor/bin/php-cs-fixer fix --diff --verbose
```

```bash
vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --verbose
```

--------------------------------

### Share Configuration via Git

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Commands to commit the PHP CS Fixer configuration file to version control.

```bash
git add .php-cs-fixer.dist.php
git commit -m "chore: add PHP CS Fixer configuration"
```

--------------------------------

### Configure cache settings

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/configuration.md

Customize PHP CS Fixer cache behavior by passing an options array as the third parameter.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

$options = [
    'usingCache' => true,
    'cacheFile' => '.php-cs-fixer.cache',
];

$config = Factory::create(new CodeIgniter4(), [], $options)->forProjects();
```

--------------------------------

### Execute Makefile Commands

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Common command-line invocations for the provided Makefile.

```bash
make install
make check-cs
make fix-cs
make clean
```

--------------------------------

### Configure VS Code for PHP CS Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Update .vscode/settings.json to point to the local executable and enable auto-formatting.

```json
{
    "php-cs-fixer.executablePath": "${workspaceFolder}/vendor/bin/php-cs-fixer",
    "php-cs-fixer.onsave": true,
    "php-cs-fixer.rules": "@PSR2"
}
```

--------------------------------

### Configure Heredoc Indentation

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Demonstrates the required indentation style for heredoc strings when the indentation rule is enabled.

```php
$text = <<<EOT
    This is indented
    content
    EOT;
```

--------------------------------

### Execute PHP CS Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Run the fixer to apply or verify coding standard changes.

```bash
vendor/bin/php-cs-fixer fix --verbose
```

```bash
vendor/bin/php-cs-fixer fix --dry-run --verbose
```

--------------------------------

### GitHub Actions Workflow for PHP CS Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

CI/CD configurations for running PHP CS Fixer in GitHub Actions.

```yaml
name: PHP CS Fixer

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main, develop]

jobs:
  php-cs-fixer:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.2'
          tools: composer:v2

      - name: Cache Composer packages
        uses: actions/cache@v3
        with:
          path: vendor
          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
          restore-keys: ${{ runner.os }}-php-

      - name: Install dependencies
        run: composer install --no-progress

      - name: Run PHP CS Fixer
        run: vendor/bin/php-cs-fixer fix --dry-run --verbose
```

```yaml
name: PHP CS Fixer Auto-fix

on:
  pull_request:
    branches: [main, develop]

jobs:
  php-cs-fixer:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v3
        with:
          ref: ${{ github.head_ref }}

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.2'
          tools: composer:v2

      - name: Install dependencies
        run: composer install --no-progress

      - name: Run PHP CS Fixer
        run: vendor/bin/php-cs-fixer fix --verbose

      - name: Commit changes
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: 'style: apply PHP CS Fixer formatting'
          commit_user_name: 'PHP CS Fixer Bot'
          commit_user_email: 'bot@example.com'
```

--------------------------------

### Create Manual Git Pre-commit Hook

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

A shell script to run PHP CS Fixer on staged files before committing.

```bash
#!/bin/bash

# Exit on error
set -e

STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '\.php$')

if [ -z "$STAGED_FILES" ]; then
    exit 0
fi

echo "Running PHP CS Fixer on staged files..."

# Fix staged files
for FILE in $STAGED_FILES; do
    if [ -f "$FILE" ]; then
        vendor/bin/php-cs-fixer fix --quiet "$FILE"
        git add "$FILE"
    fi
done

echo "PHP CS Fixer completed"
```

--------------------------------

### Apply Rule Overrides

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/overview.md

Customizes the configuration by passing an array of rule overrides to the factory.

```php
<?php
use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

$overrides = [
    'declare_strict_types' => true,
    'single_line_comment_style' => false,
];

return Factory::create(new CodeIgniter4(), $overrides)->forProjects();
```

--------------------------------

### Custom Configuration Options

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/api-reference/CodeIgniter4.md

Provides additional options such as disabling caching or setting parallel processing limits.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

// Disable caching and customize other options
$options = [
    'usingCache' => false,
    'parallel' => 4,
];

$config = Factory::create(new CodeIgniter4(), [], $options)->forProjects();
```

--------------------------------

### Enforce no blank lines after class opening

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures there are no blank lines immediately following the opening brace of a class definition.

```php
class MyClass {
    private $prop;
}
```

--------------------------------

### Run with Parallel Processing

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Command to improve performance by using multiple jobs.

```bash
vendor/bin/php-cs-fixer fix --jobs=4
```

--------------------------------

### Configure VS Code Workspace Settings

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Settings to enable automatic formatting on save using the php-cs-fixer extension.

```json
{
    "[php]": {
        "editor.formatOnSave": true,
        "editor.defaultFormatter": "junstyle.php-cs-fixer"
    },
    "php-cs-fixer.executablePath": "${workspaceFolder}/vendor/bin/php-cs-fixer",
    "php-cs-fixer.onsave": true
}
```

--------------------------------

### Fix Permission Denied Error

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Command to grant execution permissions to the PHP CS Fixer binary.

```bash
chmod +x vendor/bin/php-cs-fixer
```

--------------------------------

### Apply Custom Options

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/overview.md

Configures execution options such as caching and parallel processing for the coding standard.

```php
<?php
use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

$options = [
    'usingCache' => false,
    'parallel' => 4,
];

return Factory::create(new CodeIgniter4(), [], $options)->forProjects();
```

--------------------------------

### Require blank line after namespace

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces a blank line immediately following the namespace declaration.

```php
namespace MyApp;

class MyClass {}
```

--------------------------------

### Configure Sublime Text for PHP CS Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Set the executable path in the Sublime Text package settings.

```json
{
    "php_cs_fixer_executable_path": "./vendor/bin/php-cs-fixer"
}
```

--------------------------------

### Require blank lines before namespace

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces exactly two blank lines before the namespace declaration.

```php
<?php


namespace MyApp;
```

--------------------------------

### Configure Pre-commit Hook

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Automate code fixing before commits using a Git hook.

```bash
#!/bin/bash

STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '\.php$')

if [ -z "$STAGED_FILES" ]; then
    exit 0
fi

for FILE in $STAGED_FILES; do
    vendor/bin/php-cs-fixer fix --quiet "$FILE"
    git add "$FILE"
done
```

```bash
chmod +x .git/hooks/pre-commit
```

--------------------------------

### Configure with Caching Disabled

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Disable caching for CI/CD environments by setting the usingCache option to false.

```php
<?php

declare(strict_types=1);

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

$options = [
    'usingCache' => false,
];

return Factory::create(new CodeIgniter4(), [], $options)->forProjects();
```

--------------------------------

### Use short list() syntax

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the use of the short array destructuring syntax.

```php
[$a, $b] = func();
```

--------------------------------

### Order imports alphabetically

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Sorts imports alphabetically and groups them by type: classes, functions, and constants.

```php
use Class1;
use Class2;
use function func1;
use const CONST1;
```

--------------------------------

### Require blank line after opening tag

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces a blank line immediately following the PHP opening tag.

```php
<?php

namespace MyApp;
```

--------------------------------

### GitLab CI Pipeline Configurations

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Basic and cached pipeline configurations for running PHP CS Fixer in GitLab CI.

```yaml
stages:
  - quality

php-cs-fixer:
  stage: quality
  image: php:8.2
  before_script:
    - curl -sS https://getcomposer.org/installer | php
    - php composer.phar install
  script:
    - vendor/bin/php-cs-fixer fix --dry-run --verbose
```

```yaml
php-cs-fixer:
  stage: quality
  image: php:8.2
  cache:
    paths:
      - vendor/
  before_script:
    - curl -sS https://getcomposer.org/installer | php
    - php composer.phar install
  script:
    - vendor/bin/php-cs-fixer fix --dry-run --verbose
  only:
    - merge_requests
    - pushes
```

--------------------------------

### Configure TravisCI for PHP-CS-Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Defines the environment and execution steps for running PHP-CS-Fixer in a TravisCI pipeline.

```yaml
language: php

php:
  - 8.2
  - 8.3

install:
  - composer install

script:
  - vendor/bin/php-cs-fixer fix --dry-run --verbose
```

--------------------------------

### Migrate random functions with random_api_migration

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Replaces legacy random functions with modern mt_ versions.

```php
mt_rand()
```

--------------------------------

### Add Formatting to Contributing Guidelines

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Markdown snippet for CONTRIBUTING.md to enforce coding standards before pull requests.

```markdown
## Code Style

This project uses PHP CS Fixer with the CodeIgniter coding standard.

Before submitting a pull request, ensure your code is formatted:

```bash
composer run-script format
```

Or with PHP CS Fixer directly:

```bash
vendor/bin/php-cs-fixer fix
```

All code must pass the coding standards check:

```bash
vendor/bin/php-cs-fixer fix --dry-run --verbose
```

The CI/CD pipeline will automatically check your code and fail if it doesn't match the standard.
```

--------------------------------

### Make Git Hook Executable

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Command to ensure the manual hook script has execution permissions.

```bash
chmod +x .git/hooks/pre-commit
```

--------------------------------

### Format return type declarations with return_type_declaration

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures no space exists before the return type declaration.

```php
: string
```

--------------------------------

### Configure Docker Compose for PHP CS Fixer

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

A docker-compose.yml file to manage the PHP CS Fixer service and volume mapping.

```yaml
version: '3.8'

services:
  php-cs-fixer:
    build:
      context: .
      dockerfile: Dockerfile
    volumes:
      - .:/app
    command: vendor/bin/php-cs-fixer fix --verbose
```

--------------------------------

### Convert short closures to arrow functions

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Converts standard short closures into arrow function syntax.

```php
fn($x) => $x * 2
```

--------------------------------

### Use short array syntax

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the use of the short array syntax [] over the legacy array() function.

```php
$array = ['a', 'b', 'c'];  // instead of array('a', 'b', 'c')
```

--------------------------------

### Add space after include statements

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures a space exists between the include keyword and the file path.

```php
include 'file.php';
```

--------------------------------

### Exclude directories from processing

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Configure the Finder instance to ignore specific directories to prevent processing too many files.

```php
$finder = Finder::create()
    ->files()
    ->in([__DIR__])
    ->exclude(['vendor', 'node_modules', 'build', '.git'])
```

--------------------------------

### Enforce space after case

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensure there is a space after the case or default keyword.

```php
case 1:
```

--------------------------------

### Set control structure continuation position

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures continuation keywords like 'else' appear on the same line as the closing brace.

```php
if ($a) {
} else if ($b) {
    // else if on same line
}
```

--------------------------------

### Check string length against empty string

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Use an empty string comparison instead of checking string length.

```php
$str === ''
```

--------------------------------

### Format function declarations

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Defines the standard spacing and structure for function declarations.

```php
function myFunction($param1, $param2)
{
    // code
}
```

--------------------------------

### Use logical operators

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Prefers symbolic logical operators over word-based operators.

```php
$a && $b
```

--------------------------------

### Control brace positioning

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Defines placement rules for opening braces based on code structure (control structures, functions, or classes).

```php
// Control structures: same line
if ($condition) {
    // code
}

// Functions: next line
public function myFunction()
{
    // code
}

// Classes: next line
class MyClass
{
    // code
}
```

--------------------------------

### Require blank line between import groups

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces a blank line between different groups of use statements.

```php
use Framework
Database;

use My
Custom
Class;
```

--------------------------------

### Align binary operators

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures consistent spacing and alignment around binary operators like =, =>, ||, and .=.

```php
$a = 1;
$b = 2;
$c = 3;  // Aligned
```

--------------------------------

### Format class definition

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Standardizes the layout of class declarations including inheritance and interface implementation.

```php
class MyClass extends ParentClass implements
    InterfaceOne,
    InterfaceTwo
{
    // code
}
```

--------------------------------

### Format multiline comments

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Standardizes the opening and closing syntax for multiline comments.

```php
/*
 * Proper multiline comment
 */
```

--------------------------------

### Use post-increment style

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the use of post-increment operators over pre-increment.

```php
$i++
```

--------------------------------

### Require blank line before control statements

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces a blank line before specific control statements like case or return.

```php
switch ($x) {
    case 1:
        echo 'one';

        return;
}
```

--------------------------------

### Empty Loop Body Braces

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Requires braces for empty loop bodies.

```php
while ($condition) {
}
```

--------------------------------

### Clear Cache and Disable Caching

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Commands and configuration to resolve issues related to the PHP CS Fixer cache.

```bash
rm .php-cs-fixer.cache
vendor/bin/php-cs-fixer fix
```

```php
$options = ['usingCache' => false];
return Factory::create(new CodeIgniter4(), [], $options)->forProjects();
```

--------------------------------

### Convert comments to PHPDoc

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Automatically transforms standard comments into PHPDoc blocks.

```php
// Convert to:
/** Description */
```

--------------------------------

### Echo Tag Syntax

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the use of short echo tags.

```php
<?= $variable ?>
```

```php
<?php echo $variable; ?>
```

--------------------------------

### Require control structure braces

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Mandates the use of curly braces for all control structures.

```php
if ($condition) {
    // Always braces required
}
```

--------------------------------

### Lowercase static references

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures static reference keywords are written in lowercase.

```php
self::method()
```

--------------------------------

### Increase PHP memory limit

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Use this command to bypass memory limit restrictions during the execution of the fixer.

```bash
php -d memory_limit=-1 vendor/bin/php-cs-fixer fix
```

--------------------------------

### Use exponentiation operator with pow_to_exponentiation

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Replaces the pow() function with the ** operator.

```php
2 ** 3
```

--------------------------------

### Update Coding Standard Package

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/integration-guide.md

Command to update the coding standard package to the latest version via Composer.

```bash
composer update codeigniter/coding-standard
```

--------------------------------

### Use compound assignment operators

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the use of shorthand assignment operators.

```php
$x += 1
```

--------------------------------

### Override individual coding rules

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/configuration.md

Pass an array of rule overrides as the second parameter to the factory creation method.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

$overrides = [
    'declare_strict_types' => true,
    'single_line_comment_style' => false,
];

$config = Factory::create(new CodeIgniter4(), $overrides)->forProjects();
```

--------------------------------

### Enforce method argument spacing

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures proper indentation and spacing for method arguments when spanning multiple lines.

```php
myFunction(
    $arg1,
    $arg2,
    $arg3,
);
```

--------------------------------

### Format attribute blocks

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces specific formatting for PHP attributes.

```php
#[Route('/api', name: 'api')]
```

```php
#[Attribute]
```

--------------------------------

### Elseif Keyword Usage

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the use of the elseif keyword over else if.

```php
elseif
```

```php
else if
```

--------------------------------

### Configure class element separation

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Controls the vertical spacing between class constants, properties, and methods.

```php
class MyClass {
    const CONST1 = 1;
    const CONST2 = 2;
    private $prop1;
    private $prop2;

    public function method1() {}

    public function method2() {}
}
```

--------------------------------

### Empty Loop Condition Style

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the use of while for infinite loops.

```php
while (true) { }
```

```php
for (;;) { }
```

--------------------------------

### Override conflicting rules

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/quick-start.md

Define an array of rules to disable specific configurations that conflict with other tools.

```php
$overrides = [
    'rule_that_conflicts' => false,
];
```

--------------------------------

### Lowercase PHP keywords

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures language keywords are written in lowercase.

```php
if, else, class
```

--------------------------------

### Enforce method chaining indentation

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Requires consistent indentation for chained method calls.

```php
$obj->method1()
    ->method2()
    ->method3();
```

--------------------------------

### Use null checks instead of is_null()

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Prefers strict null comparison over the is_null function.

```php
$x === null
```

--------------------------------

### Align multiline comments

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Aligns PHPDoc blocks for better readability.

```php
/**
 * Summary.
 *
 * @param string $name Description
 * @param int    $age  Description
 */
```

--------------------------------

### Lowercase cast names

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures type casting keywords are written in lowercase.

```php
(int)
```

--------------------------------

### Configure operator line breaks

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces placing boolean operators at the beginning of the line.

```php
$a
    && $b
    || $c
```

--------------------------------

### Explicit String Variable Syntax

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Requires explicit syntax for variables within strings.

```php
{$string['key']}
```

--------------------------------

### UTF-8 Encoding Declaration

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures the presence of a UTF-8 encoding declaration.

```php
// -*- coding: utf-8 -*-
```

--------------------------------

### Replace continue with break in switch

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Use break instead of continue within switch statements.

```php
break;
```

--------------------------------

### Normalize declare statement spacing

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Removes unnecessary spaces within declare statements.

```php
declare(strict_types=1);
```

--------------------------------

### Use Elvis operator

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Prefer the Elvis operator for shorthand ternary operations.

```php
$a ?: $b
```

--------------------------------

### Disable yoda-style comparisons

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces standard comparison order instead of yoda-style.

```php
$x === 5
```

--------------------------------

### Trim spaces in arrays

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Remove unnecessary spaces inside array brackets.

```php
[1, 2]
```

--------------------------------

### Format cast operator spacing

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces a single space after cast operators.

```php
(string) $value
```

--------------------------------

### Enforce array indentation

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures consistent indentation for elements within an array.

```php
$array = [
    'key1' => 'value1',
    'key2' => 'value2',
];
```

--------------------------------

### Use colon in switch cases

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforce the use of colons instead of semicolons in switch case statements.

```php
case 1: break;
```

--------------------------------

### Align PHPDoc tags with phpdoc_align

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Configures vertical alignment of PHPDoc tags with a single space.

```php
/**
 * Summary.
 *
 * @param string $name Name description
 * @param int    $id   ID description
 * @return bool Result
 */
```

--------------------------------

### Custom Rule Overrides

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/api-reference/CodeIgniter4.md

Allows overriding specific rules by passing an associative array to the Factory.

```php
<?php

use CodeIgniter\CodingStandard\CodeIgniter4;
use Nexus\CsConfig\Factory;

// Override specific rules
$overrides = [
    'declare_strict_types' => true,
    'single_line_comment_style' => false,
];

$config = Factory::create(new CodeIgniter4(), $overrides)->forProjects();
```

--------------------------------

### Fix implode() argument order

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Enforces the correct argument order for the implode function.

```php
implode(',', $array)
```

--------------------------------

### Explicit Indirect Variable Syntax

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Requires explicit syntax for indirect variables.

```php
${$name}
```

```php
$$name
```

--------------------------------

### Enforce no spaces in union types

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Disallow spaces around the pipe operator in union types.

```php
int|string
```

--------------------------------

### Use null coalescing operator

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Prefer the null coalescing operator over ternary checks for isset.

```php
$a ?? $b
```

--------------------------------

### Enforce string concatenation spacing

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Requires a single space around the string concatenation operator.

```php
$str = 'Hello' . ' world';
```

--------------------------------

### Enforce spaces around ternary operators

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Require spaces around ternary operator symbols.

```php
$a ? $b : $c
```

--------------------------------

### Enforce whitespace after comma in arrays

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Ensures a single space follows commas within array definitions.

```php
[1, 2, 3]
```

--------------------------------

### Ereg to Preg Conversion

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Replaces deprecated ereg functions with preg equivalents.

```php
ereg()
```

```php
preg_match()
```

--------------------------------

### Error Suppression Operator

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Controls the usage of the error suppression operator.

```php
@
```

--------------------------------

### Enforce trailing comma in multiline arrays

Source: https://github.com/codeigniter/coding-standard/blob/1.x/_autodocs/rule-reference.md

Require a trailing comma for elements in multiline arrays.

```php
[
    'a',
    'b',
    'c',  // Trailing comma
]
```
Tokens:
Raw