Overview

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • AgentUtils
  • PHPServerUtils
  • Request
  • Response
  • Overview
  • Namespace
  • Class
  • Tree

Class PHPServerUtils

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

Namespace: Alpha\Util\Http
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> 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. </pre>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.2.2
Located at Util/Http/PHPServerUtils.php
Methods summary
public static integer
# start( string $host, integer $port, string $docRoot )

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.

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.

Parameters

$host
string $host The hostname or IP address
$port
int $port The port number to use
$docRoot
string $docRoot The file path to directory containing the documents we want to serve

Returns

integer
The PID of the new server

Throws

Alpha\Exception\AlphaException
AlphaException
public static
# stop( integer $PID )

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

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

Parameters

$PID
int $PID The PID of the running server we want to stop
public static boolean
# status( integer $PID )

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

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

Parameters

$PID
int $PID The PID of the running server we want to check

Returns

boolean
True if there is a server process running under the PID, false otherwise
Alpha Framework 2.0.4 API Documentation API documentation generated by ApiGen 2.8.0