Yioop_V9.5_Source_Code_Documentation

__call()

Magic method __call is called whenever an unknown method is called for this class. In this case, we check if the method name corresponds to a lower case HTTP command. In which case, we check that the arguments are a two element array with a route and a callback function and add the appropriate route to a routing table.

Parameters

$method : string

HTTP command to add $route_callack for in routing table

$route_callback : array<string|int, mixed>

a two element array consisting of a routing pattern and a callback function. In the route pattern

• acts as a wildcare. {var_name} in a path can be used to set up a $_GET field for the match. Example $routes: /foo match requests to /foo /foo*goo matches against paths like /foogoo /foodgoo /footsygoo /thread/{thread_num} would match /thread/5 and would set up a variable $_GET['thread_num'] = 5 as well as $_REQUEST['thread_num'] = 5 The second element of the $route_callback should be a callable function to be called in the event that the route pattern is matched

Return values

__construct()

Sets the base path used for determining request routes. Sets precision for timed events and sets up timer heap and other field variables

Parameters

$base_path : string = ""

used to determine portion of path to ignore when checking if a route matches against the current request. If it is left blank, then a base path will be computed using the $_SERVER script name variable.

Return values

addRoute()

Generic function for associating a function $callback to be called when a web request using $method method and with a uri matching $route occurs.

Parameters

$method : string

the name of a web request method for example, "GET"

$route : string

request pattern to match

$callback : callable

function to be called if the incoming request matches with $method and $route

Return values

clearFileCache()

Deletes the files stored in the RAM FileCache

Return values

clearTimer()

Deletes a timer for the list of active timers. (@see setTimer)

Parameters

$timer_id : int

the id of the timer to remove

Return values

fileGetContents()

Reads in the file $filename and returns its contents as a string.

Parameters

$filename : string

name of file to get contents of

$force_read : bool = false

whether to force the file to be read from persistent storage rather than the cache

Return values

filePutContents()

Writes $data to the persistent file with name $filename. Saves a copy in the RAM cache if there is a copy already there.

Parameters

$filename : string

name of file to write to persistent storages

$data : string

string of data to store in file

Return values

getSessions()

Used to export info (but not change) about running sessions

Return values

header()

Adds a new HTTP header to the list of header that will be sent with HTTP response. If the value of $header begins with HTTP/ then it is assumed that $header is the response message not a header. In this case, the value of $header will become the response message, replacing any existing messages if present. This function defaults to PHP's built-in header() function when this script is run from a non-CLI context.

Parameters

$header : string

HTTP header or message to send with HTTP response

Return values

isCli()

Returns whether this class is being used from the command-line or in a web server/cgi setting

Return values

listen()

Starts an Atto Web Server listening at $address using the configuration values provided. It also has this server's event loop. As web requests come in $this->process is called to handle them. This input and output tcp streams used by this method are non-blocking. Detecting traffic is done using stream_select(). This maps to Unix-select calls, which seemed to be the most cross-platform compatible way to do things.

Parameters

$address : int

address and port to listen for web requests on

$config_array_or_ini_filename : mixed = false

either an associative array of configuration parameters or the filename of a .ini with such parameters. Things that can be set are mainly fields that might typically show up in the $_SERVER superglobal. See the $default_server_globals variable below for some of them. The SERVER_CONTENT field can be set to an array of stream context field values and these can be used to configure the server to handle SSL/TLS (one of the examples in the examples folder.)

Return values

middleware()

Adds a middle ware callback that should be called before any processing on the request is done.

Parameters

$callback : callable

function to be called before processing of request

Return values

moveUploadedFile()

Used to move a file that was uploaded from a form on the client to the desired location on the server. In non-CLI mode this calls PHP's built-in move_uploaded_file() function

Parameters

$filename : string

tmp_name in $_FILES of the uploaded file

$destination : string

where on server the file should be moved to

Return values

process()

Cause all the current HTTP request to be processed according to the middleware callbacks and routes currently set on this WebSite object.

Return values

processInternalRequest()

Used to handle local web page/HTTP requests made from a running WebSite script back to itself. For example, if while processing a Website ROUTE, one wanted to do curl request for another local page.

Parameters

$url : string

local page url requested

$include_headers : bool = false

whether to include HTTP response headers in the returned results as if it had be a real web request

$post_data : array<string|int, mixed> = null

variables (if any) to be used in an internal HTTP POST request.

Return values

sessionStart()

Starts a web session. This involves sending a HTTP cookie header with a unique value to identify the client. When this client returns the cookie, session data is looked up. When run in CLI mode session data is stored in RAM. When run under a different web server, this method defaults to PHP's built-in function session_start().

Parameters

$options : array<string|int, mixed> = []

field that can be set are mainly related to the session cookie: 'name' (for cookie name), 'cookie_path', 'cookie_lifetime' (in seconds from now), 'cookie_domain', 'cookie_secure', 'cookie_httponly'

Return values

setCookie()

Sends an HTTP cookie header as part of the HTTP response. If this method is run from a non-CLI context then this function defaults to PHP's built-in function setcookie();

Parameters

$name : string

name of cookie

$value : string = ""

value associated with cookie

$expire : int

Unix timestamp for when the cookie expires

$path : string = ""

request path associated with the cookie

$domain : string = ""

request domain associated with the cookie

$secure : string = false

whether the cookie should only be sent if HTTPS in use

$httponly : bool = false

whether or not the cookie is available only over HTTP, and not available to client-side Javascript

Return values

setTimer()

Sets up a repeating or one-time timer that calls $callback every or after $time seconds

Parameters

$time : float

time in seconds (fractional seconds okay) after which $callback should be called. Or interval between calls if this is a repeating timer.

$callback : callable

a function to be called after now + $time

$repeating : bool = true

whether $callback should be called every $time seconds or just once.

Return values

subsite()

Used to add all the routes and callbacks of a WebSite object to the current WebSite object under paths matching $route.

Parameters

$route : string

request pattern to match

$subsite : WebSite

WebSite object to add sub routes from

Return values

trigger()

Calls any callbacks associated with a given $method and $route provided that recursion in method route call is not detected.

Parameters

$method : string

the name of a web request method for example, "GET"

$route : string

request pattern to match

Return values