error_log(3) [php man page]

ERROR_LOG(3)								 1							      ERROR_LOG(3)

error_log - Send an error message to the defined error handling routines

SYNOPSIS

       bool error_log (string  $message, [int  $message_type], [string	$destination], [string	$extra_headers])

DESCRIPTION

	Sends an error message to the web server's error log or to a file.

PARAMETERS

	      o $message
		- The error message that should be logged.

	      o $message_type
		- Says where the error should go. The possible message types are as follows:

	      error_log(3) log types

	      +--+---------------------------------------------------+
	      |0 |						     |
	      |  |						     |
	      |  | $message  is  sent  to PHP's system logger, using |
	      |  | the Operating System's system  logging  mechanism |
	      |  | or  a  file, depending on what the error_log con- |
	      |  | figuration directive  is  set  to.  This  is  the |
	      |  | default option.				     |
	      |  |						     |
	      |1 |						     |
	      |  |						     |
	      |  | $message  is  sent by email to the address in the |
	      |  | $destination parameter. This is the only  message |
	      |  | type  where	the fourth parameter, $extra_headers |
	      |  | is used.					     |
	      |  |						     |
	      |2 |						     |
	      |  |						     |
	      |  |		  No longer an option.		     |
	      |  |						     |
	      |3 |						     |
	      |  |						     |
	      |  | $message is appended to the file $destination.  A |
	      |  | newline  is not automatically added to the end of |
	      |  | the $message string. 			     |
	      |  |						     |
	      |4 |						     |
	      |  |						     |
	      |  | $message is sent directly  to  the  SAPI  logging |
	      |  | handler.					     |
	      |  |						     |
	      +--+---------------------------------------------------+
	      o $destination
		- The destination. Its meaning depends on the $message_type parameter as described above.

	      o $extra_headers
		-  The extra headers. It's used when the $message_type parameter is set to 1. This message type uses the same internal function as
		mail(3) does.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

NOTES

       Warning

	      error_log(3) is not binary safe. $message will be truncated by null character.

       Tip

	      $message should not contain null character. Note that $message may be sent to file,  mail,  syslog,  etc.  Use  appropriate  conver-
	      sion/escape function, base64_encode(3), rawurlencode(3) or addslashes(3) before calling error_log(3).

EXAMPLES

       Example #1

	      error_log(3) examples

	      <?php
	      // Send notification through the server log if we can not
	      // connect to the database.
	      if (!Ora_Logon($username, $password)) {
		  error_log("Oracle database not available!", 0);
	      }

	      // Notify administrator by email if we run out of FOO
	      if (!($foo = allocate_new_foo())) {
		  error_log("Big trouble, we're all out of FOOs!", 1,
			     "operator@example.com");
	      }

	      // another way to call error_log():
	      error_log("You messed up!", 3, "/var/tmp/my-errors.log");
	      ?>

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 5.2.7	|						    |
       |	|						    |
       |	|  The	possible  value  of  4	was  added to $mes- |
       |	| sage_type.					    |
       |	|						    |
       +--------+---------------------------------------------------+
PHP Documentation Group 													      ERROR_LOG(3)