Page MenuHomeWickedGov Phorge
Files F5987940

ConfigBuilder.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

ConfigBuilder.php
View Options

<?php
/** @noinspection PhpUnused */
namespace MediaWikiPhanConfig;
use InvalidArgumentException;
class ConfigBuilder {
public const PROGRESS_BAR_DISABLED = 0;
public const PROGRESS_BAR_STANDARD = 1;
public const PROGRESS_BAR_LONG = 2;
/** @var array */
private array $options = [];
/**
* Sets an array of raw phan options. This should generally be avoided, in favour of the setters below.
* @param array $options
* @return self
*/
public function setRawOptions( array $options ): self {
$this->options = array_replace( $this->options, $options );
return $this;
}
/**
* @return array
*/
public function make(): array {
return $this->options;
}
/**
* @param array $list
* @return $this
*/
public function setFileList( array $list ): self {
$this->options['file_list'] = $list;
return $this;
}
/**
* @param string ...$files
* @return $this
*/
public function addFiles( string ...$files ): self {
$this->options['file_list'] = array_merge(
$this->options['file_list'] ?? [],
$files
);
return $this;
}
/**
* @param array $list
* @return $this
*/
public function setExcludedFileList( array $list ): self {
$this->options['exclude_file_list'] = $list;
return $this;
}
/**
* @param string ...$files
* @return $this
*/
public function excludeFiles( string ...$files ): self {
$this->options['exclude_file_list'] = array_merge(
$this->options['exclude_file_list'] ?? [],
$files
);
return $this;
}
/**
* @param string $regex
* @return $this
*/
public function setExcludeFileRegex( string $regex ): self {
$this->options['exclude_file_regex'] = $regex;
return $this;
}
/**
* @param array $list
* @return $this
*/
public function setDirectoryList( array $list ): self {
$this->options['directory_list'] = $list;
return $this;
}
/**
* @param string ...$dirs
* @return $this
*/
public function addDirectories( string ...$dirs ): self {
$this->options['directory_list'] = array_merge(
$this->options['directory_list'] ?? [],
$dirs
);
return $this;
}
/**
* @param array $list
* @return $this
*/
public function setExcludedDirectoryList( array $list ): self {
$this->options['exclude_analysis_directory_list'] = $list;
return $this;
}
/**
* @param string ...$dirs
* @return $this
*/
public function excludeDirectories( string ...$dirs ): self {
$this->options['exclude_analysis_directory_list'] = array_merge(
$this->options['exclude_analysis_directory_list'] ?? [],
$dirs
);
return $this;
}
/**
* @param int $minSev
* @return $this
*/
public function setMinimumSeverity( int $minSev ): self {
$this->options['minimum_severity'] = $minSev;
return $this;
}
/**
* @param bool $yn
* @return $this
*/
public function allowMissingProperties( bool $yn ): self {
$this->options['allow_missing_properties'] = $yn;
return $this;
}
/**
* @param bool $yn
* @return $this
*/
public function allowScalarImplicitCasts( bool $yn ): self {
$this->options['scalar_implicit_cast'] = $yn;
return $this;
}
/**
* @param bool $yn
* @return $this
*/
public function allowNullCastsAsAnyType( bool $yn ): self {
$this->options['null_casts_as_any_type'] = $yn;
return $this;
}
/**
* @param bool $yn
* @return $this
*/
public function enableDeadCodeDetection( bool $yn ): self {
$this->options['dead_code_detection'] = $yn;
return $this;
}
/**
* @param bool $yn
* @return $this
*/
public function shouldDeadCodeDetectionPreferFalseNegatives( bool $yn ): self {
$this->options['dead_code_detection_prefer_false_negative'] = $yn;
return $this;
}
/**
* @param int $mode One of the PROGRESS_BAR_* constants
* @return $this
*/
public function setProgressBarMode( int $mode ): self {
switch ( $mode ) {
case self::PROGRESS_BAR_DISABLED:
$this->options['progress_bar'] = false;
break;
case self::PROGRESS_BAR_STANDARD:
$this->options['progress_bar'] = true;
break;
case self::PROGRESS_BAR_LONG:
$this->options['progress_bar'] = true;
$this->options['long_progress_bar'] = true;
break;
default:
throw new InvalidArgumentException( "Invalid $mode" );
}
return $this;
}
/**
* @param array $list
* @return $this
*/
public function setSuppressedIssuesList( array $list ): self {
$this->options['suppress_issue_types'] = $list;
return $this;
}
/**
* @param string ...$types
* @return $this
*/
public function suppressIssueTypes( string ...$types ): self {
$this->options['suppress_issue_types'] = array_merge(
$this->options['suppress_issue_types'] ?? [],
$types
);
return $this;
}
/**
* @param array $globals [ 'global_name' => 'union_type' ]
* @return $this
*/
public function addGlobalsWithTypes( array $globals ): self {
$this->options['globals_type_map'] = array_merge(
$this->options['globals_type_map'] ?? [],
$globals
);
return $this;
}
/**
* @param bool $yn
* @return $this
*/
public function readClassAliases( bool $yn ): self {
$this->options['enable_class_alias_support'] = $yn;
return $this;
}
/**
* @param bool $yn
* @return $this
*/
public function enableRedundantConditionDetection( bool $yn ): self {
$this->options['redundant_condition_detection'] = $yn;
return $this;
}
/**
* Set the minimum PHP version that the codebase should support.
* @param string $version
* @return $this
*/
public function setMinimumPHPVersion( string $version ): self {
$this->options['minimum_target_php_version'] = $version;
return $this;
}
/**
* Set the PHP version to be checked against for forward-compatibility warnings.
* @param string $version
* @return $this
*/
public function setTargetPHPVersion( string $version ): self {
$this->options['target_php_version'] = $version;
return $this;
}
/**
* Adds one or more built-in plugins.
* @param string[] $plugins
* @return self
*/
public function addPlugins( array $plugins ): self {
$this->options['plugins'] = array_merge(
$this->options['plugins'] ?? [],
$plugins
);
return $this;
}
/**
* Adds one or more custom plugins.
*
* @param string[] $plugins
* @return self
*/
public function addCustomPlugins( array $plugins ): self {
foreach ( $plugins as $plugin ) {
$this->options['plugins'][] = __DIR__ . "/Plugin/$plugin.php";
}
return $this;
}
/**
* @internal
* This should only be used by the config file in this repo.
*
* @param string $curDir
* @param string $vendorPath
* @return $this
*/
public function enableTaintCheck(
string $curDir,
string $vendorPath
): self {
$taintCheckPluginName = $this->getTaintCheckPluginName();
$taintCheckPath = $curDir . "/../../phan-taint-check-plugin/$taintCheckPluginName.php";
if ( !file_exists( $taintCheckPath ) ) {
$taintCheckPath =
"$vendorPath/vendor/mediawiki/phan-taint-check-plugin/$taintCheckPluginName.php";
}
$this->options['plugins'][] = $taintCheckPath;
// Taint-check specific settings. NOTE: don't remove these lines, even if they duplicate some of
// the settings above. taint-check may fail hard if one of these settings goes missing.
$this->options['quick_mode'] = false;
$this->options['suppress_issue_types'] = array_merge(
$this->options['suppress_issue_types'],
[
// We obviously don't want to report false positives
'SecurityCheck-LikelyFalsePositive',
// This one still has a lot of false positives
'SecurityCheck-PHPSerializeInjection',
]
);
return $this;
}
protected function getTaintCheckPluginName(): string {
return 'GenericSecurityCheckPlugin';
}
}

File Metadata

Mime Type
text/x-php
Expires
Sun, Oct 4, 00:37 (2 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
f3/b6/c1025424937132cd045f60bad2d5
Default Alt Text
ConfigBuilder.php (7 KB)

Event Timeline