PHP Namespace Helper

PHP Namespace Helper can import and expand your class. You can also sort your imported classes by line length or in alphabetical order.

Updated for compatibility with VS Code 1.85.0 and above

Features

• Import PHP classes with namespace
• Expand class references with their full namespace
• Sort imports by length, alphabetically, or in natural order
• Generate namespace for PHP files
• Highlight unimported classes with red background

Commands

Search these commands by the title on command palette.

[
  {
    title: "Import Class",
    command: "phpNamespaceHelper.import",
  },
  {
    title: "Import All Classes",
    command: "phpNamespaceHelper.importAll",
  },
  {
    title: "Expand Class",
    command: "phpNamespaceHelper.expand",
  },
  {
    title: "Sort Imports",
    command: "phpNamespaceHelper.sort",
  },
  {
    title: "Generate namespace for this file",
    command: "phpNamespaceHelper.generateNamespace",
  },
];

Settings

You can override these default settings according to your needs.

{
    "phpNamespaceHelper.exclude": "**/node_modules/**",  // Exclude glob pattern while finding files
    "phpNamespaceHelper.showMessageOnStatusBar": false,  // Show message on status bar instead of notification box
    "phpNamespaceHelper.autoSort": true,                 // Auto sort after imports
    "phpNamespaceHelper.sortOnSave": true,               // Auto sort when a file is saved
    "phpNamespaceHelper.sort": "length",                 // Sort method (length, natural, alphabet)
    "phpNamespaceHelper.sortOrder": "ASC",               // Sort order for natural method
    "phpNamespaceHelper.command": "php",                 // php command path
    "phpNamespaceHelper.leadingSeparator": true,         // Expand class with leading namespace separator
    "phpNamespaceHelper.namespacePrefix": "",            // Add a prefix for all generated namespaces
    "phpNamespaceHelper.highlightUnimportedClasses": true // Highlight unimported classes with red background
    "phpNamespaceHelper.sortOnSave": false,              // Auto sort when a file is saved
    "phpNamespaceHelper.sortAlphabetically": false,      // Sort imports in alphabetical order instead of line length
    "phpNamespaceHelper.sortNatural": false,             // Sort imports using a 'natural order' algorithm
    "phpNamespaceHelper.leadingSeparator": true,         // Expand class with leading namespace separator
}

Keybindings

You can override these default keybindings on your keybindings.json.

[
  {
    command: "phpNamespaceHelper.import",
    key: "ctrl+alt+i",
    when: "editorTextFocus",
  },
  {
    command: "phpNamespaceHelper.importAll",
    key: "ctrl+alt+a",
    when: "editorTextFocus",
  },
  {
    command: "phpNamespaceHelper.expand",
    key: "ctrl+alt+e",
    when: "editorTextFocus",
  },
  {
    command: "phpNamespaceHelper.sort",
    key: "ctrl+alt+s",
    when: "editorTextFocus",
  },
  {
    command: "phpNamespaceHelper.generateNamespace",
    key: "ctrl+alt+g",
    when: "editorTextFocus",
  },
];

Color Customization

You can customize the background color for unimported classes by adding the following to your settings.json:

"workbench.colorCustomizations": {
    "phpNamespaceHelper.unimportedClassBackground": "#ff0000" // Change to your preferred color
}

Available color themes:

• Dark theme default: #5a1d1d (dark red)
• Light theme default: #ffd6d6 (light red)
• High contrast default: #ff0000 (bright red)

Author

• @vdhoangson

License

Copyright (c) 2023 vdhoangson