Class RESTful_Server

RESTful_Server

Methods summary

`public`	# `__construct( $uri_needle = "/" )`
`public`	# `__destruct( )`
`public`	# `free( )`
`public &`	# `getLogger( )`
`public`	# `writeTrace( $s, $header = "" )`
`public`	# `getRAW( )` get the header and content from request get the header and content from request
`public array &`	# `getHeaders( )` if null memvar "m_errormsg" should be checked if null memvar "m_errormsg" should be checked Returns array
`public string`	# `getContent( )` if null memvar "m_errormsg" should be checked if null memvar "m_errormsg" should be checked Returns string
`public array &`	# `getParameterFromURI( )` return uri parameters (require mod_rewrite, see also config.inc.php) - if null memvar "m_errormsg" should be checked return uri parameters (require mod_rewrite, see also config.inc.php) - if null memvar "m_errormsg" should be checked Returns array
`public array &`	# `getParameterFromGET( )` return GET parameters - if null memvar "m_errormsg" should be checked return GET parameters - if null memvar "m_errormsg" should be checked Returns array
`public array &`	# `getParameterFromPOST( )` return POST parameters - if null memvar "m_errormsg" should be checked return POST parameters - if null memvar "m_errormsg" should be checked Returns array
`public array`	# `authenticate( string $realm = 'protected RESTful web service', mixed $abortHtml = null )` request the client to authenticate and return the user and password as array, if no authentication is send by client the function return HTTP Error 401 to the client and abort the script. To abort after checking the user and passwort use the method "unauthorized" request the client to authenticate and return the user and password as array, if no authentication is send by client the function return HTTP Error 401 to the client and abort the script. To abort after checking the user and passwort use the method "unauthorized" Parameters `$realm` `$abortHtml` string or html_Component Returns array
`public`	# `unauthorized( string $realm = 'protected RESTful web service', mixed $abortHtml = null )` return HTTP Error 401 to the client and abort the script return HTTP Error 401 to the client and abort the script Parameters `$realm` `$abortHtml`
`public string`	# `createAuthToken( string $salt = '', string $algo = 'sha256' )` create a hashed authentification token for the consumer to map it with a ressource owner, this token could be stored in database to authentificate following REST requests (for more see the restful.server.complex.sample.php) create a hashed authentification token for the consumer to map it with a ressource owner, this token could be stored in database to authentificate following REST requests (for more see the restful.server.complex.sample.php) Parameters `$salt` `$algo` for more see the php function "hash_algos" Returns string
`public static array`	# `createAPIKey( string $username, integer $id_user = null, $algo = 'sha256' )` create/return a secure API/consumer key and secret (could be used for the GUI on Host-Side) create/return a secure API/consumer key and secret (could be used for the GUI on Host-Side) Parameters `$username` `$id_user` `$algo` Returns array with key and secret
`public boolean`	# `checkAccessToken( string $accessToken, string $authToken, string $accessTokenSecret, string $timestamp, string $nonce, string $algo = 'sha1', string & $validAccessToken = null )` check the consumer/api/app/user/access token/key is valid (for more see the restful.server.complex.sample.php) check the consumer/api/app/user/access token/key is valid (for more see the restful.server.complex.sample.php) Parameters `$accessToken` (hash-based message authentication code (HMAC) of the timestamp followed by the api_key and nonce encrypted by your secret) `$authToken` (also known as api key or consumer key) `$accessTokenSecret` `$timestamp` UTC formated DateTime like "Thu, 26 Jul 2012 14:53:44 UTC" `$nonce` `$algo` for more see the php function "hash_algos" `$validAccessToken` return the vaild access token calculated by the method Returns boolean
`public array`	# `getOAuthAuthorizationHeader( )` return the OAuth 1.0 Authorization-Header as array return the OAuth 1.0 Authorization-Header as array Returns array
`public boolean`	# `checkOAuthAuthorization( string $consumer_secret, string $token_secret = '', string & $validOAuth = null )` OAuth 1.0 check consumer / token is valid for access OAuth 1.0 check consumer / token is valid for access Parameters `$consumer_secret` `$token_secret` could be empty if only consumer authentification is required `$validOAuth` return the vaild OAuth signature calculated by the method Returns boolean
`public boolean`	# `retContent( string $content, string $content_type = 'text/xml', string $chunkOverXBytes = '5M', string $chunkBandwidth = '1Mbit/s' )` send back content (to return an error you can combine it with the function "header_http_error") send back content (to return an error you can combine it with the function "header_http_error") Parameters `$content` `$content_type` `$chunkOverXBytes` `$chunkBandwidth` Returns boolean
`public boolean`	# `retPOST( mixed $post )` send back urlencoded content send back urlencoded content Parameters `$post` Returns boolean

Methods inherited from RESTful

createAccessToken(), createOAuthSignature()

Properties summary

`private array`	`$m_para_uri`	# `array()`
`private array`	`$m_para_get`	# `array()`
`private`	`$m_logger`	# `null`
`private string`	`$m_content`	# `""`
`private array`	`$m_headers`	# `array()`
`private string`	`$m_obj_guid`	# `""`
`private array`	`$m_oauth`	# `array()`
`public mixed`	`$m_trace_delAfter` size before trace file will set to zero size before trace file will set to zero	# `"1024K"`
`public string`	`$m_trace_path` path for trace file path for trace file	# `""`
`public string`	`$m_trace_file` filename of tracefile filename of tracefile	# `""`
`public string`	`$m_errormsg` error message error message	# `""`
`public boolean`	`$m_validate_headers` validate the headers of request if true and set the memvar "m_errormsg", if method "getRAW" failed validate the headers of request if true and set the memvar "m_errormsg", if method "getRAW" failed	# `true`
`public mixed`	`$m_gz_level` gz compression level, possibe values 0 - 9 \| auto gz compression level, possibe values 0 - 9 \| auto	# `0`
`public boolean`	`$m_gz_small_data` compress small data compress small data	# `false`
`public string`	`$m_gz_small_data_size` data smaller this size will nerver compressed data smaller this size will nerver compressed	# `"4K"`
`public string`	`$m_trace_critical_section_id` enable critical section for write trace files enable critical section for write trace files	# `null`
`public string`	`$m_trace_critical_section_path` path to share the critical section for write trace files path to share the critical section for write trace files	# `"./"`
`public integer`	`$m_trace_critical_section_maxlock_ms` max lock time for zombie processes max lock time for zombie processes	# `1000`
`public integer`	`$m_trace_critical_section_sleep_ms` sleep for retry enter critical section sleep for retry enter critical section	# `10`
`public boolean`	`$m_trace_sqlite` write the trace to a SQLite file instead of a text file write the trace to a SQLite file instead of a text file	# `false`

Classes

Interfaces

Traits

Functions

Class RESTful_Server

Methods summary

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from RESTful

Properties summary