doomemacs/modules/lang/php/README.org

lang/php

• Description
  • Maintainers
  • Module Flags
  • Plugins
• Prerequisites
  • PHP
    • MacOS
    • Arch Linux
    • openSUSE
  • Dependencies
• Features
• Configuration
• Troubleshooting

Description

This module adds support for PHP 5.3+ (including PHP7).

• ctags-based code completion (company-php and phpctags)
• eldoc support (ac-php and php-extras)
• REPL (php-boris)
• Code refactoring commands (php-refactor-mode)
• Unit-test commands (phpunit)
• Support for laravel and composer projects (with project-specific snippets)
• File templates
• Snippets

PHP was the first programming language I got paid to code in, back in the Cretaceous period (2003). My sincerest apologies go out to all the programmers who inherited my earliest PHP work. I know you're out there, writhing in your straitjackets.

Save a programmer today. Stop a friend from choosing PHP as their first language.

Maintainers

This module has no dedicated maintainers.

Module Flags

• +hack Add support for the Hack dialect of PHP by Facebook.
• +lsp Enable LSP support through phpactor or intelephense. Requires the :tools lsp module and the phpactor server to be installed on your system.

Plugins

• async
• php-boris
• php-extras
• php-mode
• php-refactor-mode
• phpunit

• +hack

  • hack-mode

• +lsp

  • phpactor
  • company-phpactor

• :editor format

  • php-cs-fixer

Prerequisites

PHP

To get started with PHP, you'll need php (5.3+) and composer.

Note for +lsp:

1. In order to make full use of phpactor server, php (7.3+) is recommended.
2. If you use intelephense, node and npm are needed.

MacOS

PHP 5.5 comes prepackaged with newer versions of MacOS. These instructions are provided for reference:

brew tap homebrew/homebrew-php
brew install php71  # or php53, php54, php55
brew install composer

# If you use intelephense:
brew install node
brew install npm

Arch Linux

sudo pacman --needed --noconfirm -S php composer  # or php53, php54, php55

# If you use intelephense:
sudo pacman -S nodejs npm

openSUSE

sudo zypper install php-composer

# If you use intelephense:
sudo zypper install nodejs npm

Dependencies

This module has no required dependencies, but it has a couple optional ones.

• boris (REPL)
• phpctags (better code completion)
• phpunit (unit test commands)
• php-cs-fixer and @prettier/plugin-php (for code formatting)

composer global require \
    d11wtq/boris \
    phpunit/phpunit \
    techlivezheng/phpctags \
    friendsofphp/php-cs-fixer

# Needed by php-cs-fixer, otherwise you'll get "Couldn't resolve parser
# 'php'" errors
npm install -g @prettier/plugin-php

You must ensure that \~/.composer/vendor/bin is in PATH, so these executables are visible to Emacs:

# place this in your profile file, like ~/.bash_profile or ~/.zshenv
export PATH="~/.composer/vendor/bin:$PATH"

You may also need to regenerate your envvar file by running doom env on the command line.

To use intelephense instead of , run M-x lsp-install-server and choose iph to install lsp-intelephense.

TODO Features

TODO Configuration

TODO Troubleshooting