gulp-connect-php

REQUIRES NODE 4 OR GREATER

Start a PHP-server

This is pretty much a gulp version of @sindresorhus's grunt-php and acts as a basic version drop-in replacement for gulp-connect, though please note not all features from gulp-connect are supported with gulp-connect-php. I am open to supporting other features and pull requests that implement them.

Uses the built-in server in PHP 5.4.0+.

Install

1$ npm install --save-dev gulp-connect-php

Usage

As a Singleton

1var gulp = require('gulp'),
2    connect = require('gulp-connect-php');
3
4gulp.task('connect', function() {
5	connect.server();
6});
7
8gulp.task('default', ['connect']);

As an Instance

1var gulp = require('gulp'),
2    connect = require('gulp-connect-php');
3
4let server = new connect();
5
6gulp.task('connect', function() {
7	server.server();
8});
9gulp.task('disconnect', function() {
10	server.closeServer();
11});
12
13gulp.task('default', ['connect', 'disconnect']);

Examples

Use it with Browser Sync

1var gulp = require('gulp'),
2    connect = require('gulp-connect-php'),
3    browserSync = require('browser-sync');
4
5gulp.task('connect-sync', function() {
6  connect.server({}, function (){
7    browserSync({
8      proxy: '127.0.0.1:8000'
9    });
10  });
11
12  gulp.watch('**/*.php').on('change', function () {
13    browserSync.reload();
14  });
15});

Advanced Option Manipulation

1gulp.task('connect', function() {
2  connect.server({
3    configCallback: function _configCallback(type, collection) {
4      // If you wish to leave one of the argument types alone, simply return the passed in collection.
5      if (type === connect.OPTIONS_SPAWN_OBJ) { // As the constant suggests, collection is an Object.
6
7        // Lets add a custom env var. Good for injecting AWS_RDS config variables.
8        collection.env = Object.assign({
9          MY_CUSTOM_ENV_VAR: "env_var_value"
10        }, process.env);
11
12        return collection;
13      } else if (type === connect.OPTIONS_PHP_CLI_ARR) { // As the constant suggests, collection is an Array.
14        let newArgs = [
15          '-e',                     // Generate extended information for debugger/profiler.
16          '-d', 'memory_limit=2G'   // Define INI entry, Up memory limit to 2G.
17        ];
18
19        // Ensure our argument switches appear before the rest.
20        return newArgs.concat(collection);
21      }
22    }
23  }, function _connected_callback() {
24    console.log("PHP Development Server Connected.");
25  });
26});
27
28gulp.task('disconnect', function() {
29	connect.closeServer();
30});
31
32gulp.task('default', ['connect', 'disconnect']);

Windows (via Batch file)

Windows Batch file execution via a %PATH% specified batchfile is possible, but some considerations are required.

1. The batch file must be on your %PATH% and executable with permissions of the invoker.
2. You must pass the parameter set off to the PHP process.
3. We have no -real- way of detecting an error state at this point.
4. You must use the 'Advanced Option Maniulation' scheme and set the shell option on spawn(...).

Scenario

• PHP is located at C:\Users\mainuser\Applications\PHP\7.0.17-NTS-VC14\php.exe.
• The batch file is located at C:\Users\mainuser\MyProject\strap\php.bat.
• I have set %PATH% manually to C:\Users\mainuser\MyProject\strap\;%PATH%.

Contents of php.bat

1@echo off
2
3REM We specify the whole path to PHP since the working directory is that of gulp...
4REM unless we also changed that in our gulp callback.
5
6C:\Users\mainuser\Applications\PHP\7.0.17-NTS-VC14\php.exe %*

Contents of our gulp task

1gulp.task('connect', function _gulp_connect_task() {
2  connect.server({
3    configCallback: function _configCallback(type, collection) {
4      if (type === connect.OPTIONS_SPAWN_OBJ) {
5        // Windows Batch files are NOT executable on their own. This will start a shell
6        // session then execute.
7        collection.shell = true;
8        return collection;
9      }
10    }
11  }, function _connected_callback() {
12    console.log("PHP Development Server Connected.");
13  });
14});
15
16gulp.task('default', ['connect']);

Options

port

Type: number
Default: 8000

The port on which you want to access the webserver. Task will fail if the port is already in use.

hostname

Type: string
Default: '127.0.0.1' (usually same as localhost)

The hostname the webserver will use.

Use 0.0.0.0 if you want it to be accessible from the outside.

base

Type: string
Default: '.'

From which folder the webserver will be served. Defaults to the directory of the gulpfile.

open

Type: boolean
Default: false

Open the server in the browser when the task is triggered.

router

Type: string

Optionally specify the path to a router script that is run at the start of each HTTP request. If this script returns false, then the requested resource is returned as-is. Otherwise the script's output is returned to the browser.

Example router script:

1<?php
2// router.php
3if (preg_match('/\.(?:png|jpg|jpeg|gif)$/', $_SERVER["REQUEST_URI"])) {
4	return false;    // serve the requested resource as-is
5} else {
6	echo "<p>Thanks for using gulp-connect-php :)</p>";
7}
8?>

bin

Type: string
Default: 'php'

Path to the PHP binary. Useful if you have multiple versions of PHP installed.

ini

Type: string
Default: Built-in php.ini

Path to a custom php.ini config file.

stdio

Type: string
Default: 'inherit'

Node's stdio parameter, set it to 'ignore' to suppress all the logging into console of the php server process.

configCallback

Type: function (type, collection) : collection

Prototype:

• type - String, either OPTIONS_SPAWN_OBJ or OPTIONS_PHP_CLI_ARR.

• collection - Array or Object, the initial version of the collection specified by type.

  Return: Optionally modified version of collection.

Default: 'null' (Which is replaced with a no-op call that returns an unmodified version of the collection parameter)

Allows the caller to modify the spawn options object and or the PHP command line arguments (array) before the PHP development server is invoked.

debug

Type: boolean Default: 'false'

Enables debugging of the spawn call and its parameters.

Building

This package comes with a NPM run-script command called prepack. This is intended to be run before the packaging and pushing to NPM, however it is also what builds the Node 4.X compatibility script index-compat.js. Without it the default package.json will not execute properly.

License

MIT © Micah Blu