BootstrapHelperFunctions.php

Go to the documentation of this file.

<?php
function wfDetectLocalSettingsFile( ?string $installationPath = null ): string {
    if ( defined( 'MW_CONFIG_FILE' ) ) {
        return MW_CONFIG_FILE;
    }
 
    $installationPath ??= wfDetectInstallPath();
 
    // We could look for LocalSettings.yaml and LocalSettings.json,
    // and use them if they exist. But having them in a web accessible
    // place is dangerous, so better not to encourage that.
    // In order to use LocalSettings.yaml and LocalSettings.json, they
    // will have to be referenced explicitly by MW_CONFIG_FILE.
    $configFile = getenv( 'MW_CONFIG_FILE' ) ?: "LocalSettings.php";
    // Can't use str_contains because for maintenance scripts (update.php, install.php),
    // this is called *before* Setup.php and vendor (polyfill-php80) are included.
    if ( strpos( $configFile, '/' ) === false ) {
        $configFile = "$installationPath/$configFile";
    }
 
    define( 'MW_CONFIG_FILE', $configFile );
    return $configFile;
}
 
function wfDetectInstallPath(): string {
    if ( !defined( 'MW_INSTALL_PATH' ) ) {
        $IP = getenv( 'MW_INSTALL_PATH' );
        if ( $IP === false ) {
            $IP = dirname( __DIR__ );
        }
        define( 'MW_INSTALL_PATH', $IP );
    }
 
    return MW_INSTALL_PATH;
}
 
function wfIsWindows() {
    return PHP_OS_FAMILY === 'Windows';
}
 
function wfIsCLI() {
    return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
}