Visual studio code php tools

PHP Tools for VS Code is a full development integration for the PHP language. The features are provided respecting conventions, stability, simple use, and performance. Please see the product page for more details on devsense.com.

This package extends VS Code with fast code completion, advanced editor features, code fixes, code lenses, code generators, debugger, built-in development web server, test explorer, tests debugger, and workspace-wide code analysis.

Support for vscode.dev

The PHP Tools extension offers support when running on vscode.dev (including github.dev). Read more ...

Editor

• fast code completion powered by workspace-wide type analysis.
• code actions for namespace resolution, getters/setters, adding use, or implementing interfaces.
• generics integrated with the entire IntelliSense functionality.
• signature help guides through the function's parameters and PHP 8 named arguments.
• auto-import corresponding aliases upon completion automatically.
• navigation for workspace-wide go-to-definition, references, and implementations.
• symbol search to quickly list declarations across the workspace.
• code lenses seamlessly show the number of references and other information.
• Go To Implementations lists all derived classes, implemented interfaces, traits, and overridden functions.
• Phar files and their content are integrated into completion and all the navigation features - seamlessly.
• PHPDoc generator when /** is typed, automatic completion of keywords, diagnostics, and quick fixes.
• PHPStorm metadata notation is automatically processed.
• PHP manual in all major languages is seamlessly integrated into the editor.
• code formatting for ranges, documents, and blocks. Formats contained HTML/JS/CSS as well.
• detailed tooltips revealing localized descriptions, colored headers, and URLs to the documentation.
• rename refactoring safely renames any symbol with rename preview across the workspace.
• highlighting occurrences of a symbol under the cursor.
• breadcrumbs and outlines for fast and easy navigation within a file.
• PHP/HTML/JS/CSS mixed codes are colored and editable all together with code completion.
• code folding for code blocks, declarations, comments, and user regions.
• unnecessary import check dims unused use and provides a Quick Fix to clean it up.
• linked editing support for local variables allowing to refactor names seamlessly.
• composer.json IntelliSense, diagnostics, commands, and code actions through Composer extension.

Debugging

• built-in web server gets started as you start debugging.
• debugger making use of Xdebug. Provides value editing, debug console, tooltips, and more.
• debugging adornments allows seeing the values you need right in the editor next to the corresponding line.
• DBGp Proxy support built-in.
• multiple sessions allow debugging from more VS Code instances, and more than one program.
• breakpoints and log-points are must-have features for tracing your program.
• debug watch tooltips for safe inspection of the debug session.
• value editing allows you to watch and change values during debugging.
• compound launch allowing to start one or more servers at once. (read more)
• remote server support with optional path mappings.

Code Analysis

• extensive problems analysis continuously reports problems across the entire workspace.
• provides quick fixes for fast and common errors and typos in user code.
• respects PHPStorm metadata to improve the type analysis.
• configurable to enable or disable specific warnings within specific directories.
• hundreds of semantic rules based on type analysis and PHP internals.
• deprecation warnings to highlight obsolete library' or user code.
• compatibility checks warn when using constructs from the future version of PHP.
• generics with the respect to Psalm/PHPStan annotations are handled.

Testing

• test explorer that visualizes, runs PHPUnit tests and organizes test results.
• debugging of selected test cases within a single click.
• code lens above test functions to quickly run and debug a single test.
• margin with the latest test results right in the code next to the test function.
• preTask and postTask allowing to run a VS Code task before/after a test run.

Code Help and Completion

Take advantage of type-based, blazing-fast code completion, signature help, and colorful tooltips within VS Code. The editor is context-aware, lists available symbols with detailed information, performs type analysis, and completes selected options. It also auto-completes the dollar character for variables and even provides a URL to online documentation when possible.

The integrated manual of all PHP symbols is localized for the major languages - English, Japanese, Spanish, French, Portuguese, German, Russian, or Chinese.

Code Actions

Quickly refactor and generate code using code actions. This feature gives you quick fixes for the code that is right at your cursor, at your hand. Generate PHPDoc, property getters and setters, implementation of interfaces, abstracts, and more.

Debug

Run the integrated built-in server, debug a script, or connect to a local or remote server. Debug is provided through Xdebug extension and provides you with all you need. Easy to use with the respect to VS Code conventions. See and manage breakpoints, watch expressions, locals, the call stack, or change variables value. Tooltips reveal the expression's value as well, including subsequent listing through large arrays.

Continuous Code Validation

Reveal troublesome issues and problems without testing, and even before running the code. The built-in type analysis and code validation will check the entire project in seconds, and it gets updated as you type. Problems are listed in the Problems window and underlined right in the code editor.

Navigation

The editor provides you with Go to definition, Find all references, and browse through all the symbols within the current document and the workspace. It takes advantage of the type analysis and context-aware search, quickly navigating even through extremely large projects.

Rename Refactoring

Safely find and rename variables, classes, interfaces, or functions with a single press of a key. The feature takes into account PHPDoc comments, possible indirect variables, or dynamic code constructs.

Code Formatting

The formatter makes the code look clean and unified. It understands your conventions, keeps multiline expressions as you wrote them, adjusts the comment blocks, pretty prints the expressions and nicely purifies the rest. Code is formatted automatically when you finish the statement or a code block.

Testing

PHPUnit tests within the project are detected and automatically listed in the Test View panel. You can run and debug all the tests, a suite, or just a single one. All the listed tests are marked with the succeeded icon with details of the test run. Failures are inlined in the code with the corresponding diff. See the testing documentation for more details.

Documentary Comments are generated upon typing /** above functions, classes, properties, constants, variables, and namespaces. The editor provides full code completion, tooltips, highlighting, searching references, and refactoring through PHPDoc.

Optionally, snippets can be customized using settings php.docblock.***Snippet, taking advantage of variables, i.e.:

"php.docblock.classSnippet": {
    "@author": "John",
    "@copyright": "(c) $CURRENT_YEAR"
}

This feature requires "editor.formatOnType": true setting to be enabled.

• Home page
• Documentation
• PHP Tools for Microsoft Visual Studio

Notices

The extension is based on MIT licensed code and is subject to the following notice:

MIT License Copyright (c) 2015 - present Microsoft Corporation All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The embedded language feature is based on work of Ben Mewburn and is subject to following notice:

Copyright (c) Ben Robert Mewburn Licensed under the ISC Licence.

The software's debug protocol library is based on MIT licensed code and is subject to following notices:

VS Code - Node Debug

Copyright (c) Microsoft Corporation All rights reserved. MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

MIT License Copyright (c) 2016 Felix Frederick Becker Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software's test explorer is based on MIT licensed code and is subject to following notices:

The MIT License (MIT) Copyright (c) 2018 Holger Benl Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

PHPUnit

Copyright (c) 2001-2018, Sebastian Bergmann . All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Sebastian Bergmann nor the names of his contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ini-parser

The MIT License (MIT) Copyright (c) 2008 Ricardo Amores Hernández

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Can I code PHP in Visual Studio Code?

What is the best PHP extension for Visual Studio Code?