MediaWikiPhanConfig\ConfigBuilder Class Reference

Inheritance diagram for MediaWikiPhanConfig\ConfigBuilder:

Public Member Functions
	setRawOptions (array $options)
	Sets an array of raw phan options.
	make ()
	setFileList (array $list)
	addFiles (string ... $files)
	setExcludedFileList (array $list)
	excludeFiles (string ... $files)
	setExcludeFileRegex (string $regex)
	setDirectoryList (array $list)
	addDirectories (string ... $dirs)
	setExcludedDirectoryList (array $list)
	excludeDirectories (string ... $dirs)
	setMinimumSeverity (int $minSev)
	allowMissingProperties (bool $yn)
	allowScalarImplicitCasts (bool $yn)
	allowNullCastsAsAnyType (bool $yn)
	enableDeadCodeDetection (bool $yn)
	shouldDeadCodeDetectionPreferFalseNegatives (bool $yn)
	setProgressBarMode (int $mode)
	setSuppressedIssuesList (array $list)
	suppressIssueTypes (string ... $types)
	addGlobalsWithTypes (array $globals)
	readClassAliases (bool $yn)
	enableRedundantConditionDetection (bool $yn)
	setMinimumPHPVersion (string $version)
	Set the minimum PHP version that the codebase should support.
	setTargetPHPVersion (string $version)
	Set the PHP version to be checked against for forward-compatibility warnings.
	addPlugins (array $plugins)
	Adds one or more built-in plugins.
	addCustomPlugins (array $plugins)
	Adds one or more custom plugins.
	enableTaintCheck (string $curDir, string $vendorPath)

Public Attributes
const	PROGRESS_BAR_DISABLED = 0
const	PROGRESS_BAR_STANDARD = 1
const	PROGRESS_BAR_LONG = 2

Protected Member Functions
	getTaintCheckPluginName ()

Member Function Documentation

addCustomPlugins()

MediaWikiPhanConfig\ConfigBuilder::addCustomPlugins

(

array

$plugins

)

Adds one or more custom plugins.

Parameters

string[]

$plugins

Returns

self

addDirectories()

MediaWikiPhanConfig\ConfigBuilder::addDirectories

(

string ...

$dirs

)

Parameters

string

...$dirs

Returns

$this

addFiles()

MediaWikiPhanConfig\ConfigBuilder::addFiles

(

string ...

$files

)

Parameters

string

...$files

Returns

$this

addGlobalsWithTypes()

MediaWikiPhanConfig\ConfigBuilder::addGlobalsWithTypes

(

array

$globals

)

Parameters

array

$globals

[ 'global_name' => 'union_type' ]

Returns

$this

addPlugins()

MediaWikiPhanConfig\ConfigBuilder::addPlugins

(

array

$plugins

)

Adds one or more built-in plugins.

Parameters

string[]

$plugins

Returns

self

allowMissingProperties()

MediaWikiPhanConfig\ConfigBuilder::allowMissingProperties

(

bool

$yn

)

Parameters

bool

$yn

Returns

$this

allowNullCastsAsAnyType()

MediaWikiPhanConfig\ConfigBuilder::allowNullCastsAsAnyType

(

bool

$yn

)

Parameters

bool

$yn

Returns

$this

allowScalarImplicitCasts()

MediaWikiPhanConfig\ConfigBuilder::allowScalarImplicitCasts

(

bool

$yn

)

Parameters

bool

$yn

Returns

$this

enableDeadCodeDetection()

MediaWikiPhanConfig\ConfigBuilder::enableDeadCodeDetection

(

bool

$yn

)

Parameters

bool

$yn

Returns

$this

enableRedundantConditionDetection()

MediaWikiPhanConfig\ConfigBuilder::enableRedundantConditionDetection

(

bool

$yn

)

Parameters

bool

$yn

Returns

$this

excludeDirectories()

MediaWikiPhanConfig\ConfigBuilder::excludeDirectories

(

string ...

$dirs

)

Parameters

string

...$dirs

Returns

$this

excludeFiles()

MediaWikiPhanConfig\ConfigBuilder::excludeFiles

(

string ...

$files

)

Parameters

string

...$files

Returns

$this

make()

MediaWikiPhanConfig\ConfigBuilder::make

(

)

Returns

array

readClassAliases()

MediaWikiPhanConfig\ConfigBuilder::readClassAliases

(

bool

$yn

)

Parameters

bool

$yn

Returns

$this

setDirectoryList()

MediaWikiPhanConfig\ConfigBuilder::setDirectoryList

(

array

$list

)

Parameters

array

$list

Returns

$this

setExcludedDirectoryList()

MediaWikiPhanConfig\ConfigBuilder::setExcludedDirectoryList

(

array

$list

)

Parameters

array

$list

Returns

$this

setExcludedFileList()

MediaWikiPhanConfig\ConfigBuilder::setExcludedFileList

(

array

$list

)

Parameters

array

$list

Returns

$this

setExcludeFileRegex()

MediaWikiPhanConfig\ConfigBuilder::setExcludeFileRegex

(

string

$regex

)

Parameters

string

$regex

Returns

$this

setFileList()

MediaWikiPhanConfig\ConfigBuilder::setFileList

(

array

$list

)

Parameters

array

$list

Returns

$this

setMinimumPHPVersion()

MediaWikiPhanConfig\ConfigBuilder::setMinimumPHPVersion

(

string

$version

)

Set the minimum PHP version that the codebase should support.

Parameters

string

$version

Returns

$this

setMinimumSeverity()

MediaWikiPhanConfig\ConfigBuilder::setMinimumSeverity

(

int

$minSev

)

Parameters

int

$minSev

Returns

$this

setProgressBarMode()

MediaWikiPhanConfig\ConfigBuilder::setProgressBarMode

(

int

$mode

)

Parameters

int

$mode

One of the PROGRESS_BAR_* constants

Returns

$this

setRawOptions()

MediaWikiPhanConfig\ConfigBuilder::setRawOptions

(

array

$options

)

Sets an array of raw phan options.

This should generally be avoided, in favour of the setters below.

Parameters

array

$options

Returns

self

setSuppressedIssuesList()

MediaWikiPhanConfig\ConfigBuilder::setSuppressedIssuesList

(

array

$list

)

Parameters

array

$list

Returns

$this

setTargetPHPVersion()

MediaWikiPhanConfig\ConfigBuilder::setTargetPHPVersion

(

string

$version

)

Set the PHP version to be checked against for forward-compatibility warnings.

Parameters

string

$version

Returns

$this

shouldDeadCodeDetectionPreferFalseNegatives()

MediaWikiPhanConfig\ConfigBuilder::shouldDeadCodeDetectionPreferFalseNegatives

(

bool

$yn

)

Parameters

bool

$yn

Returns

$this

suppressIssueTypes()

MediaWikiPhanConfig\ConfigBuilder::suppressIssueTypes

(

string ...

$types

)

Parameters

string

...$types

Returns

$this

---

The documentation for this class was generated from the following file:

• src/ConfigBuilder.php