PhpTools.nvim

Elevate your PHP development in Neovim with PhpTools - bringing you one step closer to PHPStorm-like functionality.

phptools-faster.mp4

Features

• Generate undefined methods and classes
• Create classes, traits, interfaces, and enums with proper namespacing
• Run Composer scripts
• Generate namespaces for files
• Create getters and setters
• Create PHP entities (Class, Interface, Enum, Trait) with namespaces
• Toggles common words / or fallbacks
• Refactor with common structures and control flow statements

Detailed Usage

PhpMethod

Command: :Php Method

Generates undefined methods. Works with:

• Object methods: $router->resolve();
• Static methods: Router::resolve();
• Instantiated methods: (new Router)->resolve();
• Enum declaration: Router::findroot()

If the class doesn't exist, it will also generate the class.

PhpClass

Command: :Php Class

Creates undefined classes, traits, interfaces, or enums. Supports:

• Class instantiation: new Router();
• Class declaration: class Router extends|implements Route
• Trait usage: use TraitName;
• Enum declaration: Router::findroot()

Generates the entity with proper namespace and creates a use statement for the current file.

PhpScripts

Command: :Php Scripts

Runs Composer scripts defined in your composer.json file.

PhpNamespace

Command: :Php Namespace

Generates the appropriate namespace for the current file based on its location in the project structure.

PhpGetSet

Command: :Php GetSet

When the cursor is on a property declaration (e.g., public array $routes = [];), it generates getter, setter, or both for that property.

PhpCreate

Command: :Php Create

Allows you to create a new PHP entity (Class, Interface, Enum, or Trait) in the current file, complete with the correct namespace.

To use these commands effectively, map them to convenient keybindings as shown in the installation section. This will allow quick access to PhpTools functionality while coding.

PhpToggle

PhpTools.nvim includes a powerful toggle feature that enhances your PHP development workflow. This feature allows you to quickly switch between related keywords, operators, and values with simple key presses.

Features:

1. Word Toggling: Easily cycle through related PHP keywords and types.

   • Examples:
     • public <-> protected <-> private
     • self <-> static
     • true <-> false
     • require <-> include
     • abstract <-> final
     • class <-> interface <-> trait <-> enum
     • string <-> int <-> float <-> bool <-> array
     • array_map <-> array_filter <-> array_reduce

2. Operator Toggling: Quickly switch between related operators.

   • Examples:
     • == <-> ===
     • != <-> !==
     • > <-> >=
     • < <-> <=
     • && <-> ||
     • ++ <-> --
     • -> <-> =>

3. Custom Toggles: Add your own custom toggle groups to suit your specific needs.

Usage:

• In normal mode, place your cursor on a word or operator and press:

  • <C-a> to cycle forward through toggles
  • <C-x> to cycle backward through toggles

• If the word or operator under the cursor isn't part of a toggle group, it will increment or decrement numbers as usual.

PhpRefactor

Command: :Php Refactor

Quickly surround your PHP code with common structures and control flow statements.

Usage:

1. Select the text you want to surround in visual/visualline mode

2. Execute the :Php Refactor command

3. Choose from the available options:

   • if: Wraps the selection in an if statement
   • for: Creates a for loop around the selection
   • foreach: Surrounds the selection with a foreach loop
   • while: Wraps the selection in a while loop
   • do-while: Puts the selection inside a do-while loop
   • try-catch: Encloses the selection in a try-catch block
   • function: Creates a function around the selection
   • method: Wraps the selection in a method

Example:

// Before (with 'echo "Hello, World!";' selected)
echo "Hello, World!";

// After choosing 'if' from Php Refactor
if (condition) {
    echo "Hello, World!";
}




## Installation

Using [lazy.nvim](https://github.com/folke/lazy.nvim):

```lua
{
    'ccaglak/phptools.nvim',
    keys = {
        { "<leader>lm", "<cmd>Php Method<cr>"},
        { "<leader>lc", "<cmd>Php Class<cr>"},
        { "<leader>ls", "<cmd>Php Scripts<cr>"},
        { "<leader>ln", "<cmd>Php Namespace<cr>"},
        { "<leader>lg", "<cmd>Php GetSet<cr>"},
        { "<leader>lf", "<cmd>Php Create<cr>"},
    },
    dependencies = {
        "nvim-lua/plenary.nvim"
    },
    config = function()
      require('phptools').setup({
        custom_toggles = {
        -- { "foo", "bar", "baz" },
        -- Add more custom toggle groups here
        }
        ui = false, -- Set to true if not using a UI enhancement plugin
      })
      vim.keymap.set('v', '<leader>lr', function()
            require("phptools.refactor").refactor()
        end, { desc = 'PhpRefactor' })
    end
}

Requires

• pleanery.nvim
• nvim-treesitter (:TSInstall php json)
• recommended stevearc/dressing.nvim but optional (read config)

Features to be added

• custom templates
• append to codeactions
• custom template per directory base :? in Controller directory, controller template is generated
• run tests (run all, filter, file, line)

Known bugs

• Let me know if you have any edge cases

Check Out

• Laravel Goto Blade/Components larago.nvim.
• PHP Namespace Resolver namespace.nvim.

Inspired

• by PHPStorm

License MIT