config.php

Go to the documentation of this file.

<?php
 
// If xdebug is enabled, we need to increase the nesting level for phan
ini_set( 'xdebug.max_nesting_level', 1000 );
 
return [
    'file_list' => array_merge(
        function_exists( 'register_postsend_function' ) ? [] : [ 'tests/phan/stubs/hhvm.php' ],
        function_exists( 'wikidiff2_do_diff' ) ? [] : [ 'tests/phan/stubs/wikidiff.php' ],
        function_exists( 'tideways_enable' ) ? [] : [ 'tests/phan/stubs/tideways.php' ],
        class_exists( PEAR::class ) ? [] : [ 'tests/phan/stubs/mail.php' ],
        class_exists( Memcached::class ) ? [] : [ 'tests/phan/stubs/memcached.php' ],
        // Per composer.json, PHPUnit 6 is used for PHP 7.0+, PHPUnit 4 otherwise.
        // Load the interface for the version of PHPUnit that isn't installed.
        // Phan only supports PHP 7.0+ (and not HHVM), so we only need to stub PHPUnit 4.
        class_exists( PHPUnit_TextUI_Command::class ) ? [] : [ 'tests/phan/stubs/phpunit4.php' ],
        [
            'maintenance/7zip.inc',
            'maintenance/backup.inc',
            'maintenance/cleanupTable.inc',
            'maintenance/CodeCleanerGlobalsPass.inc',
            'maintenance/commandLine.inc',
            'maintenance/importImages.inc',
            'maintenance/sqlite.inc',
            'maintenance/userDupes.inc',
            'maintenance/userOptions.inc',
            'maintenance/language/checkLanguage.inc',
            'maintenance/language/languages.inc',
        ]
    ),
 
    'directory_list' => [
        'includes/',
        'languages/',
        'maintenance/',
        'mw-config/',
        'resources/',
        'skins/',
        'vendor/',
    ],
 
    'exclude_file_list' => [],
 
    "exclude_analysis_directory_list" => [
        'vendor/',
        'tests/phan/stubs/',
        // The referenced classes are not available in vendor, only when
        // included from composer.
        'includes/composer/',
        // Directly references classes that only exist in Translate extension
        'maintenance/language/',
        // External class
        'includes/libs/jsminplus.php',
        // separate repositories
        'skins/',
    ],
 
    'backward_compatibility_checks' => false,
 
    'parent_constructor_required' => [
    ],
 
    'quick_mode' => false,
 
    'should_visit_all_nodes' => true,
 
    'analyze_signature_compatibility' => true,
 
    // Emit all issues. They are then suppressed via
    // suppress_issue_types, rather than a minimum
    // severity.
    "minimum_severity" => 0,
 
    'allow_missing_properties' => false,
 
    'null_casts_as_any_type' => true,
 
    'scalar_implicit_cast' => true,
 
    'ignore_undeclared_variables_in_global_scope' => true,
 
    'dead_code_detection' => false,
 
    'dead_code_detection_prefer_false_negative' => true,
 
    'read_type_annotations' => true,
 
    'stored_state_file_path' => null,
 
    'disable_suppression' => false,
 
    'dump_ast' => false,
 
    'dump_signatures_file' => null,
 
    'expand_file_list' => false,
 
    // Include a progress bar in the output
    'progress_bar' => false,
 
    'progress_bar_sample_rate' => 0.005,
 
    'processes' => 1,
 
    'suppress_issue_types' => [
        // approximate error count: 29
        "PhanCommentParamOnEmptyParamList",
        // approximate error count: 33
        "PhanCommentParamWithoutRealParam",
        // approximate error count: 8
        "PhanDeprecatedClass",
        // approximate error count: 415
        "PhanDeprecatedFunction",
        // approximate error count: 25
        "PhanDeprecatedProperty",
        // approximate error count: 17
        "PhanNonClassMethodCall",
        // approximate error count: 11
        "PhanParamReqAfterOpt",
        // approximate error count: 888
        "PhanParamSignatureMismatch",
        // approximate error count: 7
        "PhanParamSignatureMismatchInternal",
        // approximate error count: 1
        "PhanParamSignatureRealMismatchTooFewParameters",
        // approximate error count: 125
        "PhanParamTooMany",
        // approximate error count: 1
        "PhanParamTooManyCallable",
        // approximate error count: 3
        "PhanParamTooManyInternal",
        // approximate error count: 1
        "PhanRedefineFunctionInternal",
        // approximate error count: 2
        "PhanTraitParentReference",
        // approximate error count: 3
        "PhanTypeComparisonFromArray",
        // approximate error count: 2
        "PhanTypeComparisonToArray",
        // approximate error count: 3
        "PhanTypeInvalidRightOperand",
        // approximate error count: 1
        "PhanTypeMagicVoidWithReturn",
        // approximate error count: 218
        "PhanTypeMismatchArgument",
        // approximate error count: 13
        "PhanTypeMismatchArgumentInternal",
        // approximate error count: 6
        "PhanTypeMismatchDeclaredParam",
        // approximate error count: 111
        "PhanTypeMismatchDeclaredParamNullable",
        // approximate error count: 1
        "PhanTypeMismatchDefault",
        // approximate error count: 5
        "PhanTypeMismatchDimAssignment",
        // approximate error count: 2
        "PhanTypeMismatchDimEmpty",
        // approximate error count: 1
        "PhanTypeMismatchDimFetch",
        // approximate error count: 14
        "PhanTypeMismatchForeach",
        // approximate error count: 56
        "PhanTypeMismatchProperty",
        // approximate error count: 74
        "PhanTypeMismatchReturn",
        // approximate error count: 11
        "PhanTypeMissingReturn",
        // approximate error count: 5
        "PhanTypeNonVarPassByRef",
        // approximate error count: 1
        "PhanUndeclaredClassInCallable",
        // approximate error count: 32
        "PhanUndeclaredConstant",
        // approximate error count: 233
        "PhanUndeclaredMethod",
        // approximate error count: 1224
        "PhanUndeclaredProperty",
        // approximate error count: 3
        "PhanUndeclaredStaticMethod",
        // approximate error count: 11
        "PhanUndeclaredTypeReturnType",
        // approximate error count: 27
        "PhanUndeclaredVariable",
        // approximate error count: 58
        "PhanUndeclaredVariableDim",
    ],
 
    'whitelist_issue_types' => [
        // 'PhanAccessMethodPrivate',
        // 'PhanAccessMethodProtected',
        // 'PhanAccessNonStaticToStatic',
        // 'PhanAccessPropertyPrivate',
        // 'PhanAccessPropertyProtected',
        // 'PhanAccessSignatureMismatch',
        // 'PhanAccessSignatureMismatchInternal',
        // 'PhanAccessStaticToNonStatic',
        // 'PhanCompatibleExpressionPHP7',
        // 'PhanCompatiblePHP7',
        // 'PhanContextNotObject',
        // 'PhanDeprecatedClass',
        // 'PhanDeprecatedFunction',
        // 'PhanDeprecatedProperty',
        // 'PhanEmptyFile',
        // 'PhanNonClassMethodCall',
        // 'PhanNoopArray',
        // 'PhanNoopClosure',
        // 'PhanNoopConstant',
        // 'PhanNoopProperty',
        // 'PhanNoopVariable',
        // 'PhanParamRedefined',
        // 'PhanParamReqAfterOpt',
        // 'PhanParamSignatureMismatch',
        // 'PhanParamSignatureMismatchInternal',
        // 'PhanParamSpecial1',
        // 'PhanParamSpecial2',
        // 'PhanParamSpecial3',
        // 'PhanParamSpecial4',
        // 'PhanParamTooFew',
        // 'PhanParamTooFewInternal',
        // 'PhanParamTooMany',
        // 'PhanParamTooManyInternal',
        // 'PhanParamTypeMismatch',
        // 'PhanParentlessClass',
        // 'PhanRedefineClass',
        // 'PhanRedefineClassInternal',
        // 'PhanRedefineFunction',
        // 'PhanRedefineFunctionInternal',
        // 'PhanStaticCallToNonStatic',
        // 'PhanSyntaxError',
        // 'PhanTraitParentReference',
        // 'PhanTypeArrayOperator',
        // 'PhanTypeArraySuspicious',
        // 'PhanTypeComparisonFromArray',
        // 'PhanTypeComparisonToArray',
        // 'PhanTypeConversionFromArray',
        // 'PhanTypeInstantiateAbstract',
        // 'PhanTypeInstantiateInterface',
        // 'PhanTypeInvalidLeftOperand',
        // 'PhanTypeInvalidRightOperand',
        // 'PhanTypeMismatchArgument',
        // 'PhanTypeMismatchArgumentInternal',
        // 'PhanTypeMismatchDefault',
        // 'PhanTypeMismatchForeach',
        // 'PhanTypeMismatchProperty',
        // 'PhanTypeMismatchReturn',
        // 'PhanTypeMissingReturn',
        // 'PhanTypeNonVarPassByRef',
        // 'PhanTypeParentConstructorCalled',
        // 'PhanTypeVoidAssignment',
        // 'PhanUnanalyzable',
        // 'PhanUndeclaredClass',
        // 'PhanUndeclaredClassCatch',
        // 'PhanUndeclaredClassConstant',
        // 'PhanUndeclaredClassInstanceof',
        // 'PhanUndeclaredClassMethod',
        // 'PhanUndeclaredClassReference',
        // 'PhanUndeclaredConstant',
        // 'PhanUndeclaredExtendedClass',
        // 'PhanUndeclaredFunction',
        // 'PhanUndeclaredInterface',
        // 'PhanUndeclaredMethod',
        // 'PhanUndeclaredProperty',
        // 'PhanUndeclaredStaticMethod',
        // 'PhanUndeclaredStaticProperty',
        // 'PhanUndeclaredTrait',
        // 'PhanUndeclaredTypeParameter',
        // 'PhanUndeclaredTypeProperty',
        // 'PhanUndeclaredVariable',
        // 'PhanUnreferencedClass',
        // 'PhanUnreferencedConstant',
        // 'PhanUnreferencedMethod',
        // 'PhanUnreferencedProperty',
        // 'PhanVariableUseClause',
    ],
 
    'globals_type_map' => [
        'IP' => 'string',
    ],
 
    // Emit issue messages with markdown formatting
    'markdown_issue_messages' => false,
 
    'generic_types_enabled' => true,
 
    // A list of plugin files to execute
    'plugins' => [
    ],
];