Documentation

Serve extends BaseCommand
in package

Launch the PHP development server

Not testable, as it throws phpunit for a loop :-/

Tags
codeCoverageIgnore

Table of Contents

$arguments  : array<string|int, mixed>
$commands  : Commands
$description  : string
$group  : string
$logger  : LoggerInterface
$name  : string
$options  : array<string|int, mixed>
$usage  : string
$arguments  : array<string|int, mixed>
Arguments
$commands  : Commands
Instance of Commands so commands can call other commands.
$description  : string
Description
$group  : string
Group
$logger  : LoggerInterface
The Logger to use for a command
$minPHPVersion  : string
Minimum PHP version
$name  : string
Name
$options  : array<string|int, mixed>
Options
$portOffset  : int
The current port offset.
$tries  : int
The max number of ports to attempt to serve from
$usage  : string
Usage
__construct()  : mixed
BaseCommand constructor.
__get()  : mixed
Makes it simple to access our protected properties.
__isset()  : bool
Makes it simple to check our protected properties.
getPad()  : int
Get pad for $key => $value array output
run()  : void
Run the server
setPad()  : string
Pads our string out so that all titles are the same length to nicely line up descriptions.
showHelp()  : mixed
Show Help includes (Usage, Arguments, Description, Options).
call()  : mixed
Can be used by a command to run other commands.
showError()  : mixed
A simple method to display an error with line/file, in child commands.

Properties

$arguments

public array<string|int, mixed> $arguments

$arguments

Arguments

protected array<string|int, mixed> $arguments = []

$commands

Instance of Commands so commands can call other commands.

protected Commands $commands

$description

Description

protected string $description = 'Launches the CodeIgniter PHP-Development Server.'

$group

Group

protected string $group = 'CodeIgniter'

$minPHPVersion

Minimum PHP version

protected string $minPHPVersion = '7.3'

$name

Name

protected string $name = 'serve'

$options

Options

protected array<string|int, mixed> $options = ['--php' => 'The PHP Binary [default: "PHP_BINARY"]', '--host' => 'The HTTP Host [default: "localhost"]', '--port' => 'The HTTP Host Port [default: "8080"]']

$portOffset

The current port offset.

protected int $portOffset = 0

$tries

The max number of ports to attempt to serve from

protected int $tries = 10

$usage

Usage

protected string $usage = 'serve'

Methods

__get()

Makes it simple to access our protected properties.

public __get(string $key) : mixed
Parameters
$key : string
Return values
mixed

__isset()

Makes it simple to check our protected properties.

public __isset(string $key) : bool
Parameters
$key : string
Return values
bool

getPad()

Get pad for $key => $value array output

public getPad(array<string|int, mixed> $array, int $pad) : int
Parameters
$array : array<string|int, mixed>
$pad : int
Tags
deprecated

Use setPad() instead.

codeCoverageIgnore
Return values
int

run()

Run the server

public run(array<string|int, mixed> $params) : void
Parameters
$params : array<string|int, mixed>

Parameters

Return values
void

setPad()

Pads our string out so that all titles are the same length to nicely line up descriptions.

public setPad(string $item, int $max[, int $extra = 2 ], int $indent) : string
Parameters
$item : string
$max : int
$extra : int = 2

How many extra spaces to add at the end

$indent : int
Return values
string

showHelp()

Show Help includes (Usage, Arguments, Description, Options).

public showHelp() : mixed
Return values
mixed

call()

Can be used by a command to run other commands.

protected call(string $command[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$command : string
$params : array<string|int, mixed> = []
Tags
throws
ReflectionException
Return values
mixed

showError()

A simple method to display an error with line/file, in child commands.

protected showError(Throwable $e) : mixed
Parameters
$e : Throwable
Return values
mixed

Search results