VOOZH about

URL: https://deepwiki.com/invokable/laravel-boost-phpstorm-copilot/8-api-reference

⇱ API Reference | invokable/laravel-boost-phpstorm-copilot | DeepWiki


Loading...
Last indexed: 28 February 2026 (57ef88)
Menu

API Reference

This section documents the programmatic API for every public and protected symbol defined in the revolution/laravel-boost-phpstorm-copilot package. It covers the three source files that constitute the entire production surface of this package:

Source FilePrimary SymbolRole
src/PhpStormCopilot.php1-187PhpStormCopilotCore agent class; implements detection, MCP installation, and path resolution
src/Concerns/WithWSL.php1-129WithWSLTrait; encapsulates all WSL-specific subprocess and file-write logic
src/PhpStormCopilotServiceProvider.php1-21PhpStormCopilotServiceProviderService provider; registers the agent with the laravel/boost framework at boot

For configuration files (e.g., boost.json, mcp.json schema), see Configuration Reference. For narrative explanations of the installation flow, see Core Implementation.


Package Namespace

All three symbols share the root namespace Revolution\Laravel\Boost. The WithWSL trait is in the sub-namespace Revolution\Laravel\Boost\Concerns.

Revolution\Laravel\Boost
├── PhpStormCopilot (src/PhpStormCopilot.php)
├── PhpStormCopilotServiceProvider (src/PhpStormCopilotServiceProvider.php)
└── Concerns\
 └── WithWSL (src/Concerns/WithWSL.php)

Class and Interface Relationships

Class hierarchy and interface implementation diagram:


Sources: src/PhpStormCopilot.php1-187 src/Concerns/WithWSL.php1-129 src/PhpStormCopilotServiceProvider.php1-21


Method Surface Map

The following diagram maps each method to its owning symbol and its collaborators, bridging the natural-language concepts to concrete method names.


Sources: src/PhpStormCopilot.php119-132 src/Concerns/WithWSL.php16-76 src/PhpStormCopilotServiceProvider.php17-20


Visibility Summary

SymbolMethodVisibilityDefined In
PhpStormCopilotname()publicsrc/PhpStormCopilot.php19-22
PhpStormCopilotdisplayName()publicsrc/PhpStormCopilot.php24-27
PhpStormCopilotuseAbsolutePathForMcp()publicsrc/PhpStormCopilot.php29-32
PhpStormCopilotsystemDetectionConfig(Platform)publicsrc/PhpStormCopilot.php39-67
PhpStormCopilotprojectDetectionConfig()publicsrc/PhpStormCopilot.php74-79
PhpStormCopilotguidelinesPath()publicsrc/PhpStormCopilot.php86-89
PhpStormCopilotskillsPath()publicsrc/PhpStormCopilot.php94-97
PhpStormCopilotmcpConfigKey()publicsrc/PhpStormCopilot.php99-102
PhpStormCopilotmcpConfigPath()publicsrc/PhpStormCopilot.php104-114
PhpStormCopilotinstallFileMcp()protectedsrc/PhpStormCopilot.php119-132
PhpStormCopilottransformSailCommand()publicsrc/PhpStormCopilot.php141-162
PhpStormCopilotremoveEmptyArrays()protectedsrc/PhpStormCopilot.php168-181
PhpStormCopilotisRunningInTestbench()protectedsrc/PhpStormCopilot.php183-186
WithWSLisWSL()protectedsrc/Concerns/WithWSL.php11-14
WithWSLinstallMcpViaWsl()protectedsrc/Concerns/WithWSL.php16-76
WithWSLtransformMcpCommandForWsl()publicsrc/Concerns/WithWSL.php85-128
PhpStormCopilotServiceProviderboot()publicsrc/PhpStormCopilotServiceProvider.php17-20

Sources: src/PhpStormCopilot.php1-187 src/Concerns/WithWSL.php1-129 src/PhpStormCopilotServiceProvider.php1-21


Sub-Pages

Detailed method-by-method documentation is split across three dedicated reference pages:

  • PhpStormCopilot Class API — Complete reference for every method on PhpStormCopilot, including parameter types, return types, and behavior descriptions.
  • WithWSL Trait API — Complete reference for isWSL(), installMcpViaWsl(), and transformMcpCommandForWsl(), including the three branching cases handled by the transform method.
  • PhpStormCopilotServiceProvider API — Reference for boot(), the Boost::registerAgent call, and the auto-discovery entry in composer.json.