Alpha Framework 4.0.0 API Documentation

PHPServerUtils
in package

A utility class controlling the build-in HTTP server in PHP.

Tags
since
1.2.2
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2021, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Table of Contents

Methods

start()  : int
Starts a new HTTP server at the hostname and port provided, and returns the process ID (PID) of the service if it was started successfully.
status()  : bool
Checks to see if there is a server running locally under the process ID (PID) provided.
stop()  : void
Stops the server running locally under the process ID (PID) provided.

Methods

start()

Starts a new HTTP server at the hostname and port provided, and returns the process ID (PID) of the service if it was started successfully.

public static start(string $host, int $port, string $docRoot) : int
Parameters
$host : string

The hostname or IP address

$port : int

The port number to use

$docRoot : string

The file path to directory containing the documents we want to serve

Tags
throws
AlphaException
Return values
int

status()

Checks to see if there is a server running locally under the process ID (PID) provided.

public static status(int $PID) : bool
Parameters
$PID : int

The PID of the running server we want to check

Return values
bool

stop()

Stops the server running locally under the process ID (PID) provided.

public static stop(int $PID) : void
Parameters
$PID : int

The PID of the running server we want to stop


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results