stream_wrapper_register(3) [php man page]

STREAM_WRAPPER_REGISTER(3)						 1						STREAM_WRAPPER_REGISTER(3)

stream_wrapper_register - Register a URL wrapper implemented as a PHP class

SYNOPSIS

       bool stream_wrapper_register (string  $protocol, string	$classname, [int  $flags])

DESCRIPTION

	Allows you to implement your own protocol handlers and streams for use with all the other filesystem functions (such as fopen(3), fread(3)
       etc.).

PARAMETERS

	      o $protocol
		- The wrapper name to be registered.

	      o $classname
		- The classname which implements the $protocol.

	      o $flags
		- Should be set to STREAM_IS_URL if $protocol is a URL protocol. Default is 0, local stream.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

       stream_wrapper_register(3) will return FALSE if the $protocol already has a handler.

CHANGELOG

       +--------+------------------------------+
       |Version |			       |
       |	|			       |
       |	|	  Description	       |
       |	|			       |
       +--------+------------------------------+
       | 5.2.4	|			       |
       |	|			       |
       |	|  Added the $flags parameter. |
       |	|			       |
       +--------+------------------------------+
EXAMPLES

       Example #1

	      How to register a stream wrapper

	      <?php
	      $existed = in_array("var", stream_get_wrappers());
	      if ($existed) {
		  stream_wrapper_unregister("var");
	      }
	      stream_wrapper_register("var", "VariableStream");
	      $myvar = "";

	      $fp = fopen("var://myvar", "r+");

	      fwrite($fp, "line1
");
	      fwrite($fp, "line2
");
	      fwrite($fp, "line3
");

	      rewind($fp);
	      while (!feof($fp)) {
		  echo fgets($fp);
	      }
	      fclose($fp);
	      var_dump($myvar);

	      if ($existed) {
		  stream_wrapper_restore("var");
	      }

	      ?>

	      The above example will output:

	      line1
	      line2
	      line3
	      string(18) "line1
	      line2
	      line3
	      "

SEE ALSO

       The "streamWrapper" prototype class, "Example class registered as stream wrapper", stream_wrapper_unregister(3), stream_wrapper_restore(3),
       stream_get_wrappers(3).

PHP Documentation Group 												STREAM_WRAPPER_REGISTER(3)

STREAM_SET_TIMEOUT(3)							 1						     STREAM_SET_TIMEOUT(3)

stream_set_timeout - Set timeout period on a stream

SYNOPSIS

       bool stream_set_timeout (resource  $stream, int	$seconds, [int	$microseconds])

DESCRIPTION

	Sets the timeout value on $stream, expressed in the sum of $seconds and $microseconds.

	When  the stream times out, the 'timed_out' key of the array returned by stream_get_meta_data(3) is set to TRUE, although no error/warning
       is generated.

PARAMETERS

	      o $stream
		- The target stream.

	      o $seconds
		- The seconds part of the timeout to be set.

	      o $microseconds
		- The microseconds part of the timeout to be set.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 4.3.0	|						    |
       |	|						    |
       |	|  As of PHP 4.3, this function  can  (potentially) |
       |	| work	on  any  kind of stream. In PHP 4.3, socket |
       |	| based streams are still the only  kind  supported |
       |	| in  the  PHP	core,  although  streams from other |
       |	| extensions may support this function. 	    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

       Example #1

	      stream_set_timeout(3) example

	      <?php
	      $fp = fsockopen("www.example.com", 80);
	      if (!$fp) {
		  echo "Unable to open
";
	      } else {

		  fwrite($fp, "GET / HTTP/1.0

");
		  stream_set_timeout($fp, 2);
		  $res = fread($fp, 2000);

		  $info = stream_get_meta_data($fp);
		  fclose($fp);

		  if ($info['timed_out']) {
		      echo 'Connection timed out!';
		  } else {
		      echo $res;
		  }

	      }
	      ?>

NOTES

       Note

	       This function doesn't work with advanced operations like stream_socket_recvfrom(3), use	stream_select(3)  with	timeout  parameter
	      instead.

	This function was previously called as set_socket_timeout(3) and later socket_set_timeout(3) but this usage is deprecated.

SEE ALSO 
fsockopen(3), fopen(3).
PHP Documentation Group 												     STREAM_SET_TIMEOUT(3)