PHP Mode for GNU Emacs

This is a major mode development project to support PHP coding in GNU Emacs. This fork builds on the work of:

Turadg Aleahmad (Original Author)
Aaron S. Hawley
Lennart Borgman
Eric James Michael Ritz
Syohei Yoshida

All contributors listed below improved PHP Mode as well.

The current maintainer is:

USAMI Kenta (@zonuexe)

Please submit any bug reports or feature requests by creating issues on the GitHub page for PHP Mode. Alternatively you may also request features via the FeatHub page for the entire PHP suite for GNU Emacs.

Installation

PHP Mode works on Emacs 24.3 or later. PHP Mode may work with older versions of Emacs but this is not guaranteed. Bug reports for problems related to using PHP Mode with older versions of Emacs will most like not be addressed.

The current support policy can be found on the Supported Version page.

(RECOMMENDED) Install from MELPA

With GNU Emacs 24 or later then you can use its package feature (or Cask) to install PHP Mode from MELPA or MELPA Stable.

Install using OS package system

PHP Mode is available from package systems provided by several OSs. This is the easiest way to add PHP to Emacs and can be installed with just sudo apt-get install elpa-php-mode.

The package name on Debian, Ubuntu, and some derived operating systems is elpa-php-mode. The packages provided for these operating systems are stable, but since they are behind the latest version of PHP Mode, consider the possibility of not incorporating the latest PHP feature support and performance improvements.

Also, the php-elisp package provided by Debian 9 (stretch) and Ubuntu 18.10 and earlier is extremely old, so PLEASE DO NOT INSTALL IT.

Manual installation

Please git clone this project or download and unarchive tar or zip file from php-mode releases.

You can choose one of the following A, B, C installation methods.

A: `(load php-mode-autoloads.el)` (RECOMMENDED)

This is an initialization method that achieves the same performance and ease of use as using a package manager.

By moving the downloaded file to the extracted path of the current directory and executing the make command, byte compilation and php-mode-autoloads.el is generated. Just load the file from init.el and you are ready to use.

;; Put follow code into init.el
(when (file-directory-p "~/path/to/php-mode")
  (load "~/path/to/php-mode/php-mode-autoloads.el"))

;; Any code below is *unnecessary*
;; (require 'php-mode)
;; (add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
;; (add-to-list 'auto-mode-alist '("\\.php\\'" . php-mode))

B: `(autoload 'php-mode)`

This is for advanced users who want to reduce the slight increase in reading when Emacs starts.

Also in this case, it is recommended to byte compile with make.

;; Put follow code into init.el
(autoload 'php-mode (expand-file-name "~/path/to/php-mode/php-mode") "\
Major mode for editing PHP code.

\\{php-mode-map}

\(fn)" t nil)

(add-to-list 'auto-mode-alist '("\\.\\(?:php\\|phtml\\)\\'" . php-mode))

;; Any code below is *unnecessary*
;; (add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))
;; (require 'php-mode)

C: `(require 'php-mode)` (NOT RECOMMENDED)

Load php-mode synchronously from a specific path. It will load 10 times the size of the code compared to method A, and how much the startup time will depend on the performance of your machine's CPU and file system.

(require 'php-mode "~/path/to/php-mode/php-mode")
(add-to-list 'load-path (expand-file-name "~/path/to/php-mode"))

Reporting Bugs

When reporting a bug please run the function M-x php-mode-debug and include its output in your bug report. This helps up reproduce any problem you may have.

Experimental and In-Progress Features

CC Mode, CEDET, EDE, and Semantic

In 2013 Daniel Haxney began rewriting parts of PHP Mode in terms of Emacs' built-in CC Mode. This laid the foundation for incorporating some of the inherit IDE-ish features of Emacs, such as CEDET, EDE, and Semantic. Support for these tools continues to improve thanks to the work of Andrea Turso, Steven Rémot, Joris Steyn, and others. If you wish to test, contribute to, or simply experiment with such features then this thread is a good place to start.

PHP 7 Support

PHP 7 has been released. PHP Mode supports the following features and changes from PHP 7:

Type-hints for return values in functions and methods receive syntax highlighting in the same way as type-hints for function and method parameters.
PHP Mode treats yield from as keyword in the same way it already does for a sole yield.
It recognizes strict_types as a special declaration in the same way as ticks.

Features

New Keywords

Now PHP Mode supports syntax highlighting for new keywords which PHP 5.4 introduced, e.g. those related to traits, such as insteadof. Also supported are the older keywords clone and default.

Constants

Syntax highlighting includes every magic constant and predefined constant listed on the official PHP site. However, some constants from specific extensions are not currently included.

Traits, Interfaces, and Namespaces

Traits, interfaces, and namespaces now appear under Imenu listings. Fontification behaves properly for namespaces as well, so that code like namespace Foo\Bar\Baz no longer looks like a warning. This is also true for namespace aliases, e.g. use <namespace> as <alias>; currently the aliased name is not listed in Imenu, but future versions will address this.

Treatment of Underscores

PHP Mode treats underscores as ‘symbol constituents’ (in Emacs terminology) so that you can use keys like M-f and M-b to move through the individual parts of a variable name like $foo_bar_baz.

Chained Method Calls

PHP Mode can align method calls over multiple lines anchored around the -> operator, e.g.:

$object->foo()
       ->bar()
       ->baz();

This behaviour is off by default, but you can customize the variable php-lineup-cascaded-calls to enable this.

Note: Alignment will only work if you use one of the php-mode coding styles or inherit one of the styles.

Nested Array Formatting

Nested function calls and array() structures now look better by default (or at least in my opinion). Here is an example of the style:

$results = Post::model()->find(
    array(
        'select' => 'title',
        'condition' => 'postID=:postID',
        'params' => array(':postID' => 10),
    )
);

Anonymous Functions

Anonymous functions such as

$greet = function($name) { ... };

will now appear on Imenu; in this case the name will be $greet.

Flymake Support

By customizing the variable php-executable you can enable Flymake mode in order to see warnings and errors in real-time as you write code.

Search Local Documentation

The key command C-c C-f will search the PHP website for documentation on the word under the cursor. However, if you have a local copy of the PHP documentation then PHP Mode will try searching that documentation first. All you need to do is customize the variable php-manual-path and give it the path to your copy of the documentation. If PHP Mode cannot find something locally then it will still fallback on searching the PHP website.

Executing Regions of PHP

The command php-send-region, which is bound to C-c C-r by default, will execute the selected region of PHP code. In conjunction with the Emacs command C-x h you can use this to execute an entire file. Any output will appear in a buffer called *PHP*.

PHPDoc Tag / Annotation Highlighting

PHPDoc is a documentation format similar to JavaDoc.

There are @param, @return, @var... etc in the notation called tag, look at list of tags defined by phpDocumentor2. (These tags are compatible with static type checkers like PhpStorm and Phan.)

In addition, it also partially supports notation called annotation. Annotation has a slightly different grammar from tag, and the example is @Annotation(attr1="vvv", attr2="zzz").

Symfony project and Go! AOP and some projects/frameworks use annotation grammer based on Doctrine Annotations.

/**
 * Summary of Product class
 *
 * @copyright 2112 John Doe
 * @license https://spdx.org/licenses/Apache-2.0.html Apache License 2.0
 * @ORM\Entity
 * @ORM\Table(name="product")
 */
class Product
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\Column(type="string", length=100)
     */
    protected $name;

    /**
     * @ORM\Column(type="decimal", scale=2)
     */
    protected $price;

    /**
     * @ORM\Column(type="text")
     */
    protected $description;
}

The annotations are the lines that begin with the @ character, and PHP Mode will give these special highlighting to help them stand out.

PHP Mode has not fully supported PSR-5: PHPDoc (Draft) yet. We want to support them, but the current implementation still limited. See issue #478 for details.

Coding Styles

By default PHP Mode tries to provide a reasonable style for indentation and formatting, which you can use via the function php-enable-default-coding-style. However, it provides other options suited for particular projects which you may find useful. Other coding styles are available through these functions:

php-enable-pear-coding-style
php-enable-drupal-coding-style
php-enable-wordpress-coding-style
php-enable-symfony2-coding-style
php-enable-psr2-coding-style

They will help format your code for PEAR/PSR-2 projects, or work on Drupal, WordPress, and Symfony2 software, respectively. You may enable any of them by default by running M-x customize-group <RET> php and looking for the ‘PHP Mode Coding Style’ option. You may also enable any of these via a hook, e.g.

(add-hook 'php-mode-hook 'php-enable-default-coding-style)

Symfony2 Style

With this style method call chains can be formatted with indented continuation and a hanging semi-colon:

    $user1
        ->setCreateDate(new \DateTime('2007-05-07 01:34:45'))
        ->setLastDate(new \DateTime('2012-08-18 19:03:02'))
        ->setUsername('jay')
    ;

This style is used widely throughout Symfony2 source code even if it is not explicitly mentioned in their conventions documents.

Extra Constants

If you commonly use a framework or library that defines a set of constants then you may wish to customize the value of php-extra-constants. It is a list of strings that PHP Mode will treat as additional constants, i.e. providing them the same level syntax highlighting that PHP Mode uses for built-in constants.

Web Mode Constants and Keywords

If you use Web Mode then PHP Mode will attempt to use any additional PHP constants and keywords that Web Mode allows you to define.

Avoid HTML Template Compatibility

Many developers use PHP Mode to edit pure PHP scripts (e.g. files with only PHP and no HTML). A basic compatibility layer with HTML has historically been part of PHP Mode but it does not work perfectly and can cause some bad side effects such as slowness and incorrect font locking. Configuring the php-template-compatibility property with a nil will cancel any attempt of HTML compatibility. Web Mode is a great alternative to PHP Mode if you need to work with PHP scripts that do contain HTML and other markup.

Subword Mode

GNU Emacs comes with Subword Mode, a minor mode that allows you to navigate the parts of a camelCase as if they were separate words. For example, PHP Mode treats the variable $fooBarBaz as a whole name by default. But if you enable Subword Mode then Emacs will treat the variable name as three separate words, and therefore word-related commands (e.g. M-f, M-b, M-d) will only affect the camelCase part of the name under the cursor.

If you want to always use Subword Mode for PHP files then you can add this to your Emacs configuration:

(add-hook 'php-mode-hook (lambda () (subword-mode 1)))

The key-binding C-c C-w will also toggle Subword Mode on and off.

Amaka Support

Viewing and editing build scripts for Amaka will automatically enable PHP Mode.

Insert current class/namespace

(with-eval-after-load 'php-mode
  (define-key php-mode-map (kbd "C-c C--") 'php-current-class)
  (define-key php-mode-map (kbd "C-c C-=") 'php-current-namespace))

Other Packages for PHP programming

Completions
- ac-php: company-mode and auto-complete for PHP
Syntax checking
- flycheck: On the fly syntax checker
- flymake-php: flymake for PHP files
Snippet
- php-auto-yasnippets: Dynamically Generated YASnippets for PHP Code
Documentation
- ggtags: eldoc by using GNU global tags
- php-eldoc: eldoc backend for PHP
Testing
- phpunit: phpunit test command tool
Style
- phpcbf: PHP_CodeSniffer for Emacs
Semantic
- ede-php-autoload: Semantic for PHP
Framework
- cake: minor-mode for CakePHP
- cake2: minor-mode for CakePHP2

How to Contribute

Please see CONTRIBUTING.md.

The Wiki

The GitHub project page has a wiki that you should feel free to edit. The wiki lists the features and bugs that are on plan to include in upcoming versions of PHP Mode. It is also a place to add any tips to make the mode more useful.