Download the PHP package statix/server without Composer
On this page you can find all versions of the php package statix/server. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download statix/server
More information about statix/server
Files in statix/server
Package server
Short Description A object oriented wrapper around PHP's built in server
License MIT
Informations about the package server
Statix Server
Statix Server is a PHP package that provides a simple way to configure and start a local PHP server for your web development needs.
Requirements
- PHP 8 minumum
Installation
You can install the package via composer:
View on packagist: https://packagist.org/packages/statix/server
Basic Usage
To get started, require the vendor autoload script and create an instance of the Server
class. After setting any configuration options, call the start
method to start the server.
Configuration
You can configure the several options with the server, such as the host, the port, the root directory and more. Please read more below for a detailed explanation of each configuration method.
Passing configuration via the constructor or Server::new()
You may pass most configuration options via the constructor. For example we are setting the host
, port
and root
options in the code below.
The complete list of configuration items that can be passed via the constructor can be found below.
Setting configuration via named methods
You also have the option of calling named methods to set the configuration options as shown below.
Capturing the output from the server process
If you want to show the output from the server process as it recieves and handles requests, you may call the output
method and pass a callback function that will be called and passed any output of the process.
Running the process in the background
You may find it useful to run the server process in the background, you may call runInBackground()
. The process will run as long as the parent script is running.
Checking whether the process is running
You may check whether or not the server is currently running by calling the isRunning
method.
Stopping the server
You may stop the process running the sever by calling the stop command on an instance of the server class. If the server is not currently running this method will return null
otherwise it will return an array container first the process exit code and second the process exit text. Note this command can only be called when the server is running in the background.
Restarting the server
You can restart the server by calling the restart
method on an instance of the server class. An example of why you might need to restart the server is detecting when your .env
file is changed, you could restart the server and ensure the env vars are loaded.
Contributing
Installation
-
Clone repo
- Install php dependencies
Testing
We use Pest PHP for the test suite, please ensure before pushing changes you confirm there are no breaking changes by running the command below. Additionally, tests for new features are highly encouraged, changes will be considered without tests but it will increase the time to accept / merge.
Style
We use Laravel Pint to automatically standardize code styling, before pushing changes please run pint
using the command below.