Rendersi la vita più facile durante il debug PHP

Molte volte hai bisogno di fare il debug di alcune variabili e funzioni PHP, soprattutto quando devi risolvere problemi in codice scritto da qualcun altro.

So che alcuni sviluppatori usano la funzione error_log qua e là per cercare di capire quali funzioni vengono chiamate.

PHP ci offre una funzione molto utile: debug_backtrace. Usiamola per costruire questa funzione semplicissima ma utile, che ci renderà la vita più facile durante il debug.

 

//Error log function helper
function jose_error_log( $arg ){
    $trace = debug_backtrace();
    $trace1 = $trace[1];
    $trace = array_reverse( $trace );
    $output = '';
    foreach( $trace as $arr ){
        $output .= PHP_EOL.sprintf( 'Called function %s in file %s at line %s',$arr['function'],$arr['file'],$arr['line'] );
    }
    $output .= PHP_EOL.sprintf( '%s debugged at line %s in the function %s: %s',ucfirst( gettype( $arg ) ),$arr['line'],$trace1['function'],print_r( $arg,true ) );
    error_log( $output );
}

 

Immaginiamo che tu debba fare il debug della variabile $arg nella funzione example_function inclusa in your-file.php.

 

function example_function( $arr ){

    $arg = example_another_function( $arr ); //example_another_function is included in file-example.php

    jose_error_log( $arg );

}

 

Usando jose_error_log( $arg ) troverai in wp-content/debug.php un output simile a questo:

Called function example_another_function in file path_example\file-example.php at line 25
Called function example_function in file path_example\your-file.php at line 289
Called function jose_error_log in file path_example\your-file.php at line 1614
String debugged at line 1614 in the function example_function: 1241

 

Sarà molto più semplice controllare quali funzioni sono coinvolte, e la tua vita sarà più facile.

Naturalmente questo metodo non vuole sostituire strumenti di debug più avanzati come Xdebug o simili, ma molte volte non ti serve altro.