This project updates PHP Mode for GNU Emacs with features to make it more friendly to use with PHP 5.4 and later. 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.
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.
With GNU Emacs 24 or later then you can use its package feature to install PHP Mode from MELPA. The Marmalade package repository only has the original PHP Mode from 2004. Therefore we recommend you use MELPA to install PHP Mode. If you simply do not wish to use the package manager, then all you need to do is download the php-mode.el file, place it inside your load-path, and optionally add (require 'php-mode) to your Emacs configuration to automatically enable PHP Mode whenever you open a PHP file.
Additionally, you can add skeleton/php-ext.el to your load-path to enable the templates.
(eval-after-load 'php-mode
'(require 'php-ext))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.
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 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 fromas keyword in the same way it already does for a soleyield. -
It recognizes
strict_typesas a special declaration in the same way asticks.
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.
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 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.
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.
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 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 such as
$greet = function($name) { ... };will now appear on Imenu; in this case the name will be $greet.
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.
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.
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 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.
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-stylephp-enable-drupal-coding-stylephp-enable-wordpress-coding-stylephp-enable-symfony2-coding-stylephp-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)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.
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.
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.
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.
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.
Viewing and editing build scripts for Amaka will automatically enable PHP Mode.
(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))- 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
- Testing
- phpunit: phpunit test command tool
- Style
- phpcbf: PHP_CodeSniffer for Emacs
- Semantic
- ede-php-autoload: Semantic for PHP
- Framework
All contributions to PHP Mode are welcome. But please try to do the following when sending improvements or bug fixes:
-
Add your name to the list of ‘Contributors’ in this
README.mdfile if it is not there already. If you have a GitHub page and/or personal site then please feel free to link your name to it so people can see your other work. -
If your contribution addresses an issue on the GitHub project page then include a single line like
GitHub-Issue: #16with the appropriate issue number. -
Make sure to update the constant
php-mode-modifiedonly if you patch affectsphp-mode.el, which means this step is unnecessary for patches related to unit tests. -
However, please do not modify
php-mode-version-number. The maintainers will decide what constitutes a bump in the version number. -
Open the
php-mode-test.elfile and run all of the tests to ensure they still pass as expected. Sometimes we expect for a test to fail, and those unit tests have the appropriate configuration so their failure will not raise any warnings. You can usemake testscript to run all tests from a terminal, which is also useful in conjunction withgit bisect run. -
Send us a pull request here on GitHub.
-
Please make your commit messages as detailed as possible. It is better to be too verbose than to write too little. Look at the commits of the maintainers to see many examples of the level of detail that we feel is ideal. Please never assume that your patch is so simple that future developers will be able to understand the reason for the change without comment. And that is important: your commit message should always strive to answer "Why" the patch exists, "What" does it accomplish? The maintainers will sometimes write detailed commit messages for pull-requests by other developers, but please do not rely on us to do this consistently.
If you are fixing a bug related to a GitHub issue, then first of all, thank you for the help improving PHP Mode. Second, there is a tests/ directory which contains PHP scripts for issues (although not all of them). Please consider adding a test script to that directory that documents the expected behavior and provides code that allows others to see if said behavior works properly. Then create a unit test within php-mode-test.el using ERT. Please try to follow the format of the existing tests.
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.
The “emacs-php” mailing list is a place to discuss PHP Mode as well as all other PHP-related packages for Emacs. You can find the mailing list at:
We encourage all users of PHP Mode and developers of any PHP-related packages to feel free to post anything there regarding PHP and Emacs.
PHP Mode uses the GNU General Public License 3.
In chronological order:
- Juanjo
- Torsten Martinsen
- Vinai Kopp
- Sean Champ
- Doug Marcey
- Kevin Blake
- Rex McMaster
- Mathias Meyer
- Boris Folgmann
- Roland
- Rosenfeld
- Fred Yankowski
- Craig Andrews
- John Keller
- Ryan
- Sammartino
- ppercot
- Valentin Funk
- Stig Bakken
- Gregory Stark
- Chris Morris
- Nils Rennebarth
- Gerrit Riessen
- Eric Mc Sween
- Ville Skytta
- Giacomo Tesio
- Urban Müller
- Engelke Eschner
- Lennart Borgman
- Stefan Monnier
- Aaron S. Hawley
- Ian Eure
- Bill Lovett
- Dias Badekas
- David House
- Tom Willemse
- Olaf the Viking
- Maël Nison
- flack
- Michele Bini
- Emanuele Tomasi
- David Maus
- Jakub Jankiewicz
- Marcin Antczak
- 顾伟刚
- zapad
- Carl Groner
- Michael Dwyer
- Daniel Hackney
- Nate Eagleson
- Steve Purcell
- TatriX
- François-Xavier Bois
- James Laver
- Jacek Wysocki
- Jon Dufrense
- Andrei Chițu
- phil-s
- Bence Kalmar
- Elis Axelsson
- Alan Pearce
- Syohei Yoshida
- Joris Steyn
- l3msh0
- Hernawan Fa'iz Abdillah
- Sebastian Wiesner
- Michael Stolovitzsky
- David Arroyo Menéndez
- USAMI Kenta (@zonuexe)
- Tim Landscheidt
- Fabian Wiget
- tangxifan
- Serghei Iakovlev
- Christian Albrecht
- Sebastian Fieber
- Mark A. Hershberger