PHP

Configuration - .deepsource.toml

This section covers configuration specific to the php analyzer. Please make sure you read the general configuration guide first.

name

• Type: String
• Presence: mandatory
• Description: Shortcode of the analyzer.
• Example:

name = "php"

enabled

• Type: Boolean
• Presence: optional
• Description: Toggle whether this analyzer should be run.
• Example:

enabled = true

meta

• Type: Table
• Presence: optional
• Description: Any supported metadata to pass to the analyzer.
• Example:

[analyzers.meta]
  bootstrap_files = ["config/bootstrap.php"]

bootstrap_files

• Type: Array
• Presence: optional
• Description: List of files that your project is using to define global constants, custom autoloader, class aliases, etc. This will help reduce the false positives.
• Example:

bootstrap_files = ["config/bootstrap.php"]

skip_doc_coverage

• Type: Array

• Presence: optional

• Description: Specify which artifacts to skip when calculating documentation coverage.

• Available Values: class, magic and nonpublic

  • class - Ignore docstrings of class definitions
  • magic - Ignore docstrings of magic methods
  • nonpublic - Ignore docstrings for non-public(protected and private) methods

• Default Value: ["magic"]

• Example:

skip_doc_coverage = ["class", "magic", "nonpublic"]

Sample config

version = 1

test_patterns = [
  "**/tests/**"
]

exclude_patterns = [
  "vendor/**",
  "**/examples/**"
]

[[analyzers]]
name = "php"
enabled = true

  [analyzers.meta]
  bootstrap_files = ["config/bootstrap.php"]
  skip_doc_coverage = ["class", "magic", "nonpublic"]

📘

We currently support PHP 7 and 8.