doomemacs/modules/lang/php/README.org

#+TITLE: :lang php

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)
+ [[../../editor/file-templates/templates/php-mode][File templates]]
+ [[https://github.com/hlissner/doom-snippets/tree/master/php-mode][Snippets]]

#+begin_quote
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.
#+end_quote

* Table of Contents :TOC:
- [[#install][Install]]
  - [[#php][PHP]]
  - [[#dependencies][Dependencies]]

* Install
** PHP
To get started with PHP, you'll need ~php~ (5.3+) and ~composer~:

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

#+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes")
brew tap homebrew/homebrew-php
brew install php71  # or php53, php54, php55
brew install composer
#+END_SRC

*** Arch Linux
#+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")
sudo pacman --needed --noconfirm -S php composer  # or php53, php54, php55
#+END_SRC

*** openSUSE
#+BEGIN_SRC sh :dir /sudo::
sudo zypper install php-composer
#+END_SRC

** Dependencies
The features in this module optionally depend on the following php packages:

+ ~boris~ (REPL)
+ ~phpctags~ (better code completion)
+ ~phpunit~ (unit test commands)

#+BEGIN_SRC sh
composer global require \
    d11wtq/boris \
    phpunit/phpunit \
    techlivezheng/phpctags
#+END_SRC

Ensure that ~\~/.composer/vendor/bin~ is in ~PATH~:

#+BEGIN_SRC sh
# place this in your profile file, like ~/.bash_profile or ~/.zshenv
export PATH="~/.composer/vendor/bin:$PATH"
#+END_SRC
Standardize module READMEs 2017-08-22 02:07:07 +08:00			`#+TITLE: :lang php`
Update READMEs & add new ones 2017-05-26 02:08:50 +08:00
			`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)`
:boom: Remove :feature category :feature was a "catch-all" category. Many of its modules fit better in other categories, so they've been moved: - feature/debugger -> tools/debugger - feature/evil -> editor/evil - feature/eval -> tools/eval - feature/lookup -> tools/lookup - feature/snippets -> editor/snippets - feature/file-templates -> editor/file-templates - feature/workspaces -> ui/workspaces More potential changes in the future: - A new :term category for terminal emulation modules (eshell, term and vterm). - A new :os category for modules dedicated to os-specific functionality. The :tools macos module would fit here, but so would modules for nixos and arch. - A new :services category for web-service integration, like wakatime, twitter, elfeed, gist and pastebin services. 2019-04-22 07:59:44 +08:00			`+ [[../../editor/file-templates/templates/php-mode][File templates]]`
Move emacs-snippets -> doom-snippets The repo was renamed upstream. 2019-07-14 20:43:45 +08:00			`+ [[https://github.com/hlissner/doom-snippets/tree/master/php-mode][Snippets]]`
Update READMEs & add new ones 2017-05-26 02:08:50 +08:00
			`#+begin_quote`
Standardize module READMEs 2017-08-22 02:07:07 +08:00			`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.`
Update READMEs & add new ones 2017-05-26 02:08:50 +08:00
			`Save a programmer today. Stop a friend from choosing PHP as their first language.`
			`#+end_quote`

Standardize module READMEs 2017-08-22 02:07:07 +08:00			`* Table of Contents :TOC:`
			`- [[#install][Install]]`
			`- [[#php][PHP]]`
			`- [[#dependencies][Dependencies]]`

			`* Install`
			`** PHP`
Update READMEs & add new ones 2017-05-26 02:08:50 +08:00			`To get started with PHP, you'll need ~php~ (5.3+) and ~composer~:`

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

			`#+BEGIN_SRC sh :tangle (if (doom-system-os 'macos) "yes")`
			`brew tap homebrew/homebrew-php`
			`brew install php71 # or php53, php54, php55`
			`brew install composer`
			`#+END_SRC`

			`*** Arch Linux`
			`#+BEGIN_SRC sh :dir /sudo:: :tangle (if (doom-system-os 'arch) "yes")`
			`sudo pacman --needed --noconfirm -S php composer # or php53, php54, php55`
			`#+END_SRC`

Add openSUSE prerequisite instructions These instructions were tested on openSUSE Tumbleweed and openSUSE Leap 15.1. There are some modules left that are not documented yet, but this already improves the sitution for common openSUSE users. 2019-08-27 16:50:37 +08:00			`*** openSUSE`
			`#+BEGIN_SRC sh :dir /sudo::`
			`sudo zypper install php-composer`
			`#+END_SRC`

Update READMEs & add new ones 2017-05-26 02:08:50 +08:00			`** Dependencies`
Standardize module READMEs 2017-08-22 02:07:07 +08:00			`The features in this module optionally depend on the following php packages:`
Update READMEs & add new ones 2017-05-26 02:08:50 +08:00
			`+ ~boris~ (REPL)`
			`+ ~phpctags~ (better code completion)`
			`+ ~phpunit~ (unit test commands)`

			`#+BEGIN_SRC sh`
			`composer global require \`
			`d11wtq/boris \`
			`phpunit/phpunit \`
			`techlivezheng/phpctags`
			`#+END_SRC`

			`Ensure that ~\~/.composer/vendor/bin~ is in ~PATH~:`

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