Xdebug php install windows

Installation

For packages that have the PHP version in the package name, such as in php81-php-xdebug3 , you can substitute the PHP version with the one that matches the PHP version that you are running.

Installing with PECL #

You can install Xdebug through PECL on Linux & macOS with Homebrew.

  • macOS:
    • Xcode’s command line tools (run: xcode-select —install ).
    • PHP installed through Homebrew.
    • GCC and associated libraries.
    • PHP development headers (see Compile below).

    On Apple M1 hardware, programs can either be compiled for the native M1/ARM64 architecture, or for the emulated x86_64 architecure. Sometimes there is a mismatch with the default and PECL will fail, or Xdebug won’t load with a message such as:

    PHP Warning: Failed loading Zend extension 'xdebug.so' (tried: /opt/homebrew/lib/php/pecl/20190902/xdebug.so (dlopen(/opt/homebrew/lib/php/pecl/20190902/xdebug.so, 9): no suitable image found. Did find: /opt/homebrew/lib/php/pecl/20190902/xdebug.so: mach-o, but wrong architecture /opt/homebrew/lib/php/pecl/20190902/xdebug.so: stat() failed with errno=22), /opt/homebrew/lib/php/pecl/20190902/xdebug.so.so (dlopen(/opt/homebrew/lib/php/pecl/20190902/xdebug.so.so, 9): image not found)) in Unknown on line 0

    You can verify what your PHP’s architecture is with:

    If that says arm64e , then you need to run:

    arch -arm64 sudo pecl install xdebug

    And if it’s x86_64 , then you need to run:

    arch -x86_64 sudo pecl install xdebug

    You should ignore any prompts to add «extension=xdebug.so» to php.ini — this will cause problems.

    In some cases pecl will change the php.ini file to add a configuration line to load Xdebug. You can check whether it did by running php -v . If Xdebug shows up with a version number, than you’re all set and you can configure Xdebug’s other functions, such as Step Debugging, or Profiling.

    1 On macOS, you should have PHP installed with Homebrew.

    Installing on Windows #

    There are a few precompiled modules for Windows, they are all for the non-debug version of PHP. You can get those at the download page. Follow these instructions to get Xdebug installed.

    Installation From Source #

    Obtain #

    You can download the source of the latest stable release 3.2.2.

    Alternatively you can obtain Xdebug from GIT:

    git clone git://github.com/xdebug/xdebug.git

    This will checkout the latest development version which is currently 3.2.0dev. This development branch might not always work as expected, and may have bugs.

    Compile #

    There is a wizard available that provides you with the correct file to download, and which paths to use.

    You compile Xdebug separately from the rest of PHP. You need access to the scripts phpize and php-config . If your system does not have phpize and php-config , you will need to install the PHP development headers.

    Debian users can do that with:

    And RedHat and Fedora users with:

    It is important that the source version matches the installed version as there are slight, but important, differences between PHP versions. Once you have access to phpize and php-config , take the following steps:

    1. If you downloaded a tarball, unpack it: tar -xzf xdebug-3.2.2.tgz You should not unpack the tarball inside the PHP source code tree. Xdebug is compiled separately, all by itself, as stated above.
    2. Change into the source directory:
      1. tarball: cd xdebug-3.2.2
      2. GIT clone: cd xdebug

      Configure PHP #

      1. Find out which PHP ini file to modify. Run a script with the following to find all configuration files that PHP has loaded:
      PHP 7.4.10 (cli) (built: Aug 18 2020 09:37:14) ( NTS DEBUG ) Copyright (c) The PHP Group Zend Engine v3.4.0, Copyright (c) Zend Technologies with Zend OPcache v7.4.10-dev, Copyright (c), by Zend Technologies with Xdebug v3.0.0-dev, Copyright (c) 2002-2020, by Derick Rethans

      With Xdebug loaded, you can now enable individual features, such as Step Debugging, or Profiling.

      • Activation and Triggers This video explains how to activate, through triggers and other method’s Xdebug’s step debugger, profiler, and tracer.
      • Xdebug 3: Diagnostics This video teaches you how to troubleshoot your Xdebug setup. It explains how to find out how Xdebug is configured, which settings have been made, and what it is attempting to do regarding its different features.
      • Xdebug 3: Modes This video introduces Xdebug 3’s modes — the new way to configure which parts of Xdebug you have enabled.

      Settings #

      string xdebug.log = #

      Configures Xdebug’s log file.

      Xdebug will log to this file all file creations issues, Step Debugging connection attempts, failures, and debug communication.

      Enable this functionality by setting the value to a absolute path. Make sure that the system user that PHP runs at (such as www-data if you are running with Apache) can create and write to the file.

      The file is opened in append-mode, and will therefore not be overwritten by default. There is no concurrency protection available.

      The log file will include any attempt that Xdebug makes to connect to an IDE:

      [2693358] Log opened at 2020-09-02 07:19:09.616195 [2693358] [Step Debug] INFO: Connecting to configured address/port: localhost:9003. [2693358] [Step Debug] ERR: Could not connect to debugging client. Tried: localhost:9003 (through xdebug.client_host/xdebug.client_port). [2693358] [Profiler] ERR: File '/foo/cachegrind.out.2693358' could not be opened. [2693358] [Profiler] WARN: /foo: No such file or directory [2693358] [Tracing] ERR: File '/foo/trace.1485761369' could not be opened. [2693358] [Tracing] WARN: /foo: No such file or directory [2693358] Log closed at 2020-09-02 07:19:09.617510

      It includes the opening time ( 2020-09-02 07:19:09.616195 ), the IP/Hostname and port Xdebug is trying to connect to ( localhost:9003 ), and whether it succeeded ( Connected to client ). The number in brackets ( [2693358] ) is the Process ID.

      It includes: [2693358] process ID in brackets 2020-09-02 07:19:09.616195 opening time

      INFO: Connecting to configured address/port: localhost:9003. ERR: Could not connect to debugging client. Tried: localhost:9003 (through xdebug.client_host/xdebug.client_port).
      ERR: File '/foo/cachegrind.out.2693358' could not be opened. WARN: /foo: No such file or directory
      ERR: File '/foo/trace.1485761369' could not be opened. WARN: /foo: No such file or directory
      Step Debugger Communication

      The debugging log can also log the communication between Xdebug and an IDE. This communication is in XML, and starts with the

      The fileuri attribute lists the entry point of your application, which can be useful to compare to breakpoint_set commands to see if path mappings are set-up correctly.

      You can read about DBGP — A common debugger protocol specification at its dedicated documation page.

      The xdebug.log_level setting controls how much information is logged.

      Many Linux distributions now use systemd, which implements private tmp directories. This means that when PHP is run through a web server or as PHP-FPM, the /tmp directory is prefixed with something akin to:

      /tmp/systemd-private-ea3cfa882b4e478993e1994033fc5feb-apache.service-FfWZRg

      This setting can additionally be configured through the XDEBUG_CONFIG environment variable.

      integer xdebug.log_level = 7 #

      Configures which logging messages should be added to the log file.

      The log file is configured with the xdebug.log setting.

      The following levels are supported:

      Level Name Example
      0 Criticals Errors in the configuration
      1 Errors Connection errors
      3 Warnings Connection warnings
      5 Communication Protocol messages
      7 Information Information while connecting
      10 Debug Breakpoint resolving information

      Criticals, errors, and warnings always show up in the diagnostics log that you can view by calling xdebug_info().

      This setting can additionally be configured through the XDEBUG_CONFIG environment variable.

      string xdebug.mode = develop #

      This setting controls which Xdebug features are enabled.

      This setting can only be set in php.ini or files like 99-xdebug.ini that are read when a PHP process starts (directly, or through php-fpm). You can not set this value in .htaccess and .user.ini files, which are read per-request, nor through php_admin_value as used in Apache VHOSTs and PHP-FPM pools.

      The following values are accepted:

      off Nothing is enabled. Xdebug does no work besides checking whether functionality is enabled. Use this setting if you want close to 0 overhead. develop Enables Development Helpers including the overloaded var_dump(). coverage Enables Code Coverage Analysis to generate code coverage reports, mainly in combination with PHPUnit. debug Enables Step Debugging. This can be used to step through your code while it is running, and analyse values of variables. gcstats Enables Garbage Collection Statistics to collect statistics about PHP’s Garbage Collection Mechanism. profile Enables Profiling, with which you can analyse performance bottlenecks with tools like KCacheGrind. trace Enables the Function Trace feature, which allows you record every function call, including arguments, variable assignment, and return value that is made during a request to a file.

      You can enable multiple modes at the same time by comma separating their identifiers as value to xdebug.mode: xdebug.mode=develop,trace .

      XDEBUG_MODE environment variable

      You can also set Xdebug’s mode by setting the XDEBUG_MODE environment variable on the command-line; this will take precedence over the xdebug.mode setting, but will not change the value of the xdebug.mode setting.

      Some web servers have a configuration option to prevent environment variables from being propagated to PHP and Xdebug.

      For example, PHP-FPM has a clear_env configuration setting that is on by default, which you will need to turn off if you want to use XDEBUG_MODE .

      Make sure that your web server does not clean the environment, or specifically allows the XDEBUG_MODE environment variable to be passed on.

      Functions #

      xdebug_info( string $category = null ) : mixed #

      Show and retrieve diagnostic information

      This function presents APIs to retrieve information about Xdebug itself. Which information gets returned, or displayed, depends on which arguments, or none at all, are given.

      $category =

      The HTML output includes which mode is active, what the settings are, and diagnostic information in case there are problems with debugging connections, opening of files, etc.

      Each warning and error in the diagnostics log also links through to the Description of errors documentation page.

      $category = ‘mode’ (New in Xdebug 3.1)

      The function returns an array of all the enabled modes, whether through xdebug.mode or the XDEBUG_MODE environment variable.

      Example:

      Returns:

      array(3) < [0] =>string(5) "debug" [1] => string(7) "develop" [2] => string(5) "trace" >

      $category = 'extension-flags' (New in Xdebug 3.1)

      The function returns an array of all the compile flags that were enabled when running ./configure as part of Xdebug's compilation process.

      The only flag that is available, is the compression flag. If this flag is enabled, then the xdebug.use_compression setting is available, and enabled by default.

      Profiling and Function Trace will create GZip compressed files if the xdebug.use_compression setting is turned on (the default).

      Example:

      Returns:

      array(1) < [0] =>string(11) "compression" >

      This site and all of its contents are Copyright © 2002-2023 by Derick Rethans.
      All rights reserved.

      Источник

      Читайте также:  Изменить высоту блока html
Оцените статью