Class http

Samples:

// GET $args = array(); $http = new http(); $http->m_trace_path = "./";

//Request Arguments from URI if (!$http->getRequestArguments("http://localhost/request.php?test1=Hello&test2=World", $args)) echo "
".$http->m_error."
";

if (!$http->open($args)) echo "
".$http->m_error."
";

if (!$http->sendRequest($args)) echo "
".$http->m_error."
";

$headers = array(); if (!$http->readReplyHeaders($headers)) echo "
".$http->m_error."
";

$body = ""; $content = ""; for(;;) { if(!$http->readReplyBody($content,1000)){ echo "
".$http->m_error."
"; break; } if(strlen($content) == 0){ break; } $body .= $content; }

if (!$http->close()) echo "
".$http->m_error."
";

///////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////

// GET with htaccess $args = array(); $http = new http();

$user = "username"; $pass = "password";

//Request Arguments from URI if (!$http->getRequestArguments("http://".$user.":".$pass."@localhost/request.php?test1=Hello&test2=World", $args)) echo "
".$http->m_error."
";

if (!$http->open($args)) echo "
".$http->m_error."
";

if (!$http->sendRequest($args)) echo "
".$http->m_error."
";

$headers = array(); if (!$http->readReplyHeaders($headers)) // this function automatically calls the "authenticate" function when server sends HTTP 401 back echo "
".$http->m_error."
";

$body = ""; $content = ""; for(;;) { if(!$http->readReplyBody($content,1000)){ echo "
".$http->m_error."
"; break; } if(strlen($content) == 0){ break; } $body .= $content; }

if (!$http->close()) echo "
".$http->m_error."
";

///////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////

// POST $args = array(); $http = new http();

//Request Arguments from URI if (!$http->getRequestArguments("http://localhost/request.php", $args)) echo "
".$http->m_error."
";

if (!$http->open($args)) echo "
".$http->m_error."
";

//Must the parameters manually change, otherwise a GET is sent as default $args["RequestMethod"] = "POST";

// POST fields $args["PostValues"]=array( "post1"=>"Hello", "post2"=>"World" );

//POST files $args["PostFiles"]=array( "userfile"=>array( "Data"=>"This is just a plain text attachment file named attachment.txt .", "Name"=>"attachment.txt", "Content-Type"=>"automatic/name", ), "anotherfile"=>array( "FileName"=>"test.log", "Content-Type"=>"automatic/name", ) );

if (!$http->sendRequest($args)) echo "
".$http->m_error."
";

$headers = array(); if (!$http->readReplyHeaders($headers)) echo "
".$http->m_error."
";

$body = ""; $content = ""; for(;;) { if(!$http->readReplyBody($content,1000)){ echo "
".$http->m_error."
"; break; } if(strlen($content) == 0){ break; } $body .= $content; }

if (!$http->close()) echo "
".$http->m_error."
";

///////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////

// POST with htaccess $args = array(); $http = new http();

$user = "username"; $pass = "password";

//Request Arguments from URI if (!$http->getRequestArguments("http://".$user.":".$pass."@localhost/request.php", $args)) echo "
".$http->m_error."
";

if (!$http->open($args)) echo "
".$http->m_error."
";

//Must the parameters manually change, otherwise a GET is sent as default $args["RequestMethod"] = "POST";

// POST fields $args["PostValues"]=array( "post1"=>"Hello", "post2"=>"World" );

if (!$http->sendRequest($args)) echo "
".$http->m_error."
";

$headers = array(); if (!$http->readReplyHeaders($headers)) // this function automatically calls the "authenticate" function when server sends HTTP 401 back echo "
".$http->m_error."
";

$body = ""; $content = ""; for(;;) { if(!$http->readReplyBody($content,1000)){ echo "
".$http->m_error."
"; break; } if(strlen($content) == 0){ break; } $body .= $content; }

if (!$http->close()) echo "
".$http->m_error."
";

///////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////

//Redirect $args = array(); $http = new http();

//Request Arguments from URI if (!$http->getRequestArguments("http://localhost/request.php?test1=Hello&test2=World", $args)) echo "
".$http->m_error."
";

if (!$http->open($args)) echo "
".$http->m_error."
";

$http->m_follow_redirect = true; $args["location"] = "http://localhost/index.php"; if (!$http->redirect($args)) echo "
".$http->m_error."
";

$body = ""; $content = ""; for(;;) { if(!$http->readReplyBody($content,1000)){ echo "
".$http->m_error."
"; break; } if(strlen($content) == 0){ break; } $body .= $content; }

if (!$http->close()) echo "
".$http->m_error."
";

///////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////

//File Definition if (!$http->getFileDefinition($args["PostFiles"]["userfile"],$definition)) - $definition has "Content-Type", "NAME", "DATA", and "Content-Length" from the file with the info in array given echo "
".$http->m_error."
";

Located at http.lib.php

Methods summary

`public`	# `http( )`
`public`	# `getLogger( )`
`public`	# `writeTrace( $s, $header = "" )`
`public`	# `tokenize( $string, $separator = "" )`
`public`	# `cookieEncode( $value, $name )`
`public`	# `setError( $error )`
`public`	# `setPHPError( $error, & $php_error_message )`
`public`	# `setDataAccessError( $error, $check_connection = 0 )`
`public`	# `getLine( )`
`public`	# `putLine( $line )`
`public`	# `putData( & $data )`
`public`	# `flushData( )`
`public`	# `readChunkSize( )`
`public`	# `readBytes( $length )`
`public`	# `endOfInput( )`
`public`	# `connect( $host_name, $host_port, $ssl )`
`public`	# `disconnect( )`
`public`	# `readReplyHeadersResponse( & $headers )`
`public boolean`	# `getRequestArguments( string $url, & $arguments, $getvars = "" )` parses URL string to get all necessary parameters (protocol, hostname, user, pass, port) parses URL string to get all necessary parameters (protocol, hostname, user, pass, port) Parameters `$url` `$arguments` `$getvars` Returns boolean Reference param array $arguments
`public boolean`	# `open( array $arguments )` opens HTTP connection opens HTTP connection Parameters `$arguments` (HostName, HostPort, ProxyHostName, ProxyHostPort, Protocol, SSLCertificateFile, SSLCertificatePassword, SSLKeyFile, SSLKeyPassword) Returns boolean
`public boolean`	# `close( )` closes HTTP connection closes HTTP connection Returns boolean
`public`	# `pickCookies( boolean & $cookies, $secure )` fills out $cookies array with cookies fills out $cookies array with cookies Parameters `$cookies` $secure `$secure` Reference param array $cookies
`public boolean`	# `getFileDefinition( array $file, & $definition )` fills out array $definition with information (Content-Type, Name, Data and Content-Length) from file vector (ex: used to send file as attachment) fills out array $definition with information (Content-Type, Name, Data and Content-Length) from file vector (ex: used to send file as attachment) Parameters `$file` `$definition` Returns boolean Reference param array $definition
`public boolean`	# `sendRequest( array $arguments )` sends HTTP request for GET/POST or other requests sends HTTP request for GET/POST or other requests Parameters `$arguments` Returns boolean
`public boolean`	# `setCookie( string $name, string $value, string $expires = "" , string $path = "/" , string $domain = "" , boolean $secure = false, boolean $encode = false )` sets Cookie sets Cookie Parameters `$name` `$value` `$expires` `$path` `$domain` `$secure` `$encode` Returns boolean
`public boolean`	# `redirect( & $headers )` redirects the HTTP connection to another URL. $this->m_follow_redirect must be true redirects the HTTP connection to another URL. $this->m_follow_redirect must be true Returns boolean Reference param array $headers
`public boolean`	# `authenticate( boolean & $headers, string $proxy, string & $proxy_authorization, string $user, string $password, $realm, $workstation )` authenticates user either for proxy access or www access authenticates user either for proxy access or www access Parameters `$headers` $proxy `$proxy` $user `$proxy_authorization` $password `$user` $realm `$password` $workstation `$realm` `$workstation` Returns boolean Reference param array $headers param string $proxy_authorization
`public boolean`	# `readReplyHeaders( & $headers )` reads HTTP Request Reply Headers und fills out parameter array reads HTTP Request Reply Headers und fills out parameter array Returns boolean Reference param array $headers
`public boolean`	# `readReplyBody( integer & $body, $length )` reads HTTP Request Reply Body und fills out parameter variable reads HTTP Request Reply Body und fills out parameter variable Parameters `$body` $length `$length` Returns boolean Reference param string $body
`public`	# `saveCookies( string & $cookies, boolean $domain = '', boolean $secure_only = false, $persistent_only = false )` saves cookies saves cookies Parameters `$cookies` $domain `$domain` $secure_only `$secure_only` $persistent_only `$persistent_only` Reference param array $cookies
`public`	# `savePersistentCookies( string & $cookies, boolean $domain = '', $secure_only = false )` saves always cookies as persistent - the same as calling saveCookies with last parameter = true saves always cookies as persistent - the same as calling saveCookies with last parameter = true Parameters `$cookies` $domain `$domain` $secure_only `$secure_only` Reference param array $cookies
`public`	# `getPersistentCookies( string & $cookies, boolean $domain = '', $secure_only = false )` saves always cookies as persistent - the same as calling saveCookies with last parameter = true saves always cookies as persistent - the same as calling saveCookies with last parameter = true Parameters `$cookies` $domain `$domain` $secure_only `$secure_only` Reference param array $cookies
`public boolean`	# `restoreCookies( array $cookies, boolean $clear = true )` restore Cookies (clearing old Cookies or not) restore Cookies (clearing old Cookies or not) Parameters `$cookies` `$clear` Returns boolean

Properties summary

`private`	`$m_logger`	# `null`
`private string`	`$m_state`	# `"Disconnected"`
`private integer`	`$m_use_curl`	# `0`
`private integer`	`$m_connection`	# `0`
`private integer`	`$m_content_length`	# `0`
`private string`	`$m_response`	# `""`
`private integer`	`$m_read_response`	# `0`
`private integer`	`$m_read_length`	# `0`
`private string`	`$m_request_host`	# `""`
`private string`	`$m_next_token`	# `""`
`private integer`	`$m_redirection_level`	# `0`
`private integer`	`$m_chunked`	# `0`
`private integer`	`$m_remaining_chunk`	# `0`
`private integer`	`$m_last_chunk_read`	# `0`
`private array`	`$m_months`	# `array( "Jan"=>"01", "Feb"=>"02", "Mar"=>"03", "Apr"=>"04", "May"=>"05", "Jun"=>"06", "Jul"=>"07", "Aug"=>"08", "Sep"=>"09", "Oct"=>"10", "Nov"=>"11", "Dec"=>"12")`
`private string`	`$m_session`	# `''`
`private integer`	`$m_connection_close`	# `0`
`public string`	`$m_host_name` request host name request host name	# `""`
`public integer`	`$m_host_port` request host port request host port	# `0`
`public string`	`$m_proxy_host_name` proxy host name proxy host name	# `""`
`public integer`	`$m_proxy_host_port` proxy host port proxy host port	# `80`
`public string`	`$m_protocol` request protocol (http or https) request protocol (http or https)	# `"http"`
`public string`	`$m_request_method` request method (POST or GET) request method (POST or GET)	# `"GET"`
`public string`	`$m_user_agent` request user-agent request user-agent	# `""`
`public string`	`$m_authentication_mechanism` request authentication mechanism request authentication mechanism	# `""`
`public string`	`$m_user` user - RM: necessary? Later is this value in m_request_user saved and no more used user - RM: necessary? Later is this value in m_request_user saved and no more used	#
`public string`	`$m_password` password - RM: necessary? Later is this value in m_request_password saved and no more used password - RM: necessary? Later is this value in m_request_password saved and no more used	#
`public string`	`$m_realm` realm - RM: necessary? Later is this value in m_request_realm saved and no more used realm - RM: necessary? Later is this value in m_request_realm saved and no more used	#
`public string`	`$m_workstation` workstation - RM: necessary? Later is this value in m_request_workstation saved and no more used workstation - RM: necessary? Later is this value in m_request_workstation saved and no more used	#
`public string`	`$m_proxy_authentication_mechanism` proxy authentication mechanism - in case a proxy is used proxy authentication mechanism - in case a proxy is used	# `""`
`public string`	`$m_proxy_user` proxy user - RM: necessary? Later is this value in m_proxy_request_user saved and no more used proxy user - RM: necessary? Later is this value in m_proxy_request_user saved and no more used	#
`public string`	`$m_proxy_password` proxy password - RM: necessary? Later is this value in m_proxy_request_password saved and no more used proxy password - RM: necessary? Later is this value in m_proxy_request_password saved and no more used	#
`public string`	`$m_proxy_realm` proxy realm - RM: necessary? Later is this value in m_proxy_request_realm saved and no more used proxy realm - RM: necessary? Later is this value in m_proxy_request_realm saved and no more used	#
`public string`	`$m_proxy_workstation` proxy workstation - RM: necessary? Later is this value in m_proxy_request_workstation saved and no more used proxy workstation - RM: necessary? Later is this value in m_proxy_request_workstation saved and no more used	#
`public string`	`$m_request_uri` request URI request URI	# `""`
`public string`	`$m_request` request command request command	# `""`
`public array`	`$m_request_headers` request headers request headers	# `array()`
`public string`	`$m_request_user` request user for authentication request user for authentication	#
`public string`	`$m_request_password` request password for authentication request password for authentication	#
`public string`	`$m_request_realm` request realm for authentication request realm for authentication	#
`public string`	`$m_request_workstation` request workstation for authentication request workstation for authentication	#
`public string`	`$m_proxy_request_user` proxy user for authentication proxy user for authentication	#
`public string`	`$m_proxy_request_password` proxy password for authentication proxy password for authentication	#
`public string`	`$m_proxy_request_realm` proxy realm for authentication proxy realm for authentication	#
`public string`	`$m_proxy_request_workstation` proxy workstation for authentication proxy workstation for authentication	#
`public string`	`$m_request_body` body body	# `""`
`public array`	`$m_request_arguments` request arguments passed to sendRequest function request arguments passed to sendRequest function	# `array()`
`public string`	`$m_protocol_version` protocol version protocol version	# `"1.1"`
`public integer`	`$m_timeout` timeout for connection - seconds - fsockopen or curl_setopt timeout for connection - seconds - fsockopen or curl_setopt	# `0`
`public integer`	`$m_data_timeout` timeout for data stream - seconds timeout for data stream - seconds	# `0`
`public boolean`	`$m_support_cookies` whether enable cookie support or not whether enable cookie support or not	# `true`
`public array`	`$m_cookies` cookies array cookies array	# `array()`
`public string`	`$m_error` error message - usually set by setError error message - usually set by setError	# `""`
`public string`	`$m_exclude_address` address to which access is forbidden address to which access is forbidden	# `""`
`public boolean`	`$m_follow_redirect` enable/disable redirect commands enable/disable redirect commands	# `false`
`public integer`	`$m_redirection_limit` maximum number of redirections maximum number of redirections	# `5`
`public string`	`$m_response_status` HTTP response status (ex: 200, 401, etc) HTTP response status (ex: 200, 401, etc)	# `""`
`public string`	`$m_response_message` HTTP response message HTTP response message	# `""`
`public integer`	`$m_file_buffer_length` Buffer length in KBytes - to read stream data Buffer length in KBytes - to read stream data	# `8000`
`public boolean`	`$m_force_multipart_form_post` Force or not multipart form post in content-type header Force or not multipart form post in content-type header	# `false`
`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 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_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_force_resolve_ipv4_before_ipv6` fix routing problems with IPv6 (high start transfer time) fix routing problems with IPv6 (high start transfer time)	# `true`

Classes

Interfaces

Traits

Functions

Class http

Methods summary

Parameters

Returns

Reference

Parameters

Returns

Returns

Parameters

Reference

Parameters

Returns

Reference

Parameters

Returns

Parameters

Returns

Returns

Reference

Parameters

Returns

Reference

Returns

Reference

Parameters

Returns

Reference

Parameters

Reference

Parameters

Reference

Parameters

Reference

Parameters

Returns

Properties summary