\ComposerXdebugHandler

__construct()

__construct(\Symfony\Component\Console\Output\OutputInterface  $output) 

Constructor

The $envPrefix is used to create distinct environment variables. It is uppercased and prepended to the default base values. For example 'myapp' would result in MYAPP_ALLOW_XDEBUG and MYAPP_ORIGINAL_INIS.

Parameters

setLogger()

setLogger(\Psr\Log\LoggerInterface  $logger) : $this

Activates status message output to a PSR3 logger

Parameters

Returns

setMainScript()

setMainScript(string  $script) : $this

Sets the main script location if it cannot be called from argv

Parameters

Returns

setPersistent()

setPersistent() : $this

Persist the settings to keep xdebug out of sub-processes

Returns

check()

check() 

Checks if xdebug is loaded and the process needs to be restarted

This behaviour can be disabled by setting the MYAPP_ALLOW_XDEBUG environment variable to 1. This variable is used internally so that restarted process is created only once.

getAllIniFiles()

getAllIniFiles() : array

Returns an array of php.ini locations with at least one entry

The equivalent of calling php_ini_loaded_file then php_ini_scanned_files. The loaded ini location is the first entry and may be empty.

Returns

getRestartSettings()

getRestartSettings() : array|null

Returns an array of restart settings or null

Settings will be available if the current process was restarted, or called with the settings from an existing restart.

Returns

getSkippedVersion()

getSkippedVersion() : string

Returns the xdebug version that triggered a successful restart

Returns

requiresRestart()

requiresRestart(boolean  $isLoaded) : boolean

Returns true if xdebug is loaded, or as directed by an extending class

Parameters

Returns

restart()

restart(string  $command) 

Allows an extending class to access the tmpIni

Parameters

doRestart()

doRestart(string  $command) 

Executes the restarted command then deletes the tmp ini

Parameters

prepareRestart()

prepareRestart() : boolean

Returns true if everything was written for the restart

If any of the following fails (however unlikely) we must return false to stop potential recursion:

• tmp ini file creation
• environment variable creation

Returns

writeTmpIni()

writeTmpIni(array  $iniFiles) : boolean

Returns true if the tmp ini file was written

Parameters

Returns

getCommand()

getCommand() : string

Returns the restart command line

Returns

setEnvironment()

setEnvironment(boolean  $scannedInis, array  $iniFiles) : boolean

Returns true if the restart environment variables were set

No need to update $_SERVER since this is set in the restarted process.

Parameters

Returns

notify()

notify(string  $op, null|string  $data = null) 

Logs status messages

Parameters

mergeLoadedConfig()

mergeLoadedConfig(array  $loadedConfig, array  $iniConfig) : string

Returns default, changed and command-line ini settings

Parameters

Returns

checkMainScript()

checkMainScript() : boolean

Returns true if the script name can be used

Returns

setEnvRestartSettings()

setEnvRestartSettings(string  $envArgs) 

Adds restart settings to the environment

Parameters

syncSettings()

syncSettings(array  $settings) 

Syncs settings and the environment if called with existing settings

Parameters

checkScanDirConfig()

checkScanDirConfig() : boolean

Returns true if there are scanned inis and PHP is able to report them

php_ini_scanned_files will fail when PHP_CONFIG_FILE_SCAN_DIR is empty. Fixed in 7.1.13 and 7.2.1

Returns