Zikula: A Flexible Open Source Content Management System
home | forum | international support | contact us

Docs For Class LogUtil

[ class tree: Zikula_Core ] [ index: Zikula_Core ] [ all elements ] [ Todo List ]

Class: LogUtil

Source Location: /pnobjlib/LogUtil.class.php

Class Overview



LogUtil













Methods











Inherited Variables



Inherited Methods







Class Details



[line 19]
LogUtil









[ Top ]







Class Methods



  

	
	
method getErrorMessages [line 69]

	

    

    

		array getErrorMessages(
[
$delete = true], [
$reverse = true])
    

    


	
		Get an array of error messages







Tags:





  

    return:  of messages
  










        
Parameters:

    

    

          

          
        $delete  
        
      

          

          
        $reverse  
        
      

        

    


        
[ Top ]

  

  

	
	
method getErrorMessagesText [line 92]

	

    

    

		string getErrorMessagesText(
[$delimeter
$delimeter = '<br />'], [
$delete = true])
    

    


	
		Get an error message text







Tags:





  

    return:  the generated error message
  










        
Parameters:

    

    

          

        $delimeter  
        $delimeter  
        The string to use as the delimeter between the array of messages
      

          

          
        $delete  
        
      

        

    


        
[ Top ]

  

  

	
	
method getErrorType [line 104]

	

    

    

		int getErrorType(
)
    

    


	
		get the error type







Tags:





  

    return:  error type
  










        
[ Top ]

  

  

	
	
method getLogFileName [line 297]

	

    

    

		the getLogFileName(
[
$level = null])
    

    


	
		Generate the filename of todays log file







Tags:





  

    return:  generated filename
  










        
Parameters:

    

    

          

          
        $level  
        
      

        

    


        
[ Top ]

  

  

	
	
method getStatusMessages [line 27]

	

    

    

		array getStatusMessages(
[$override
$delete = true], [
$override = true], [
$reverse = true])
    

    


	
		Returns an array of status messages







Tags:





  

    return:  of messages
  










        
Parameters:

    

    

          

        $override  
        $delete  
        whether to override status messages with error messages
      

          

          
        $override  
        
      

          

          
        $reverse  
        
      

        

    


        
[ Top ]

  

  

	
	
method getStatusMessagesText [line 57]

	

    

    

		string getStatusMessagesText(
[$delimeter
$delimeter = '<br />'], [$override
$delete = true], [
$override = true])
    

    


	
		Returns a string of the available status messages, separated by the given delimeter







Tags:





  

    return:  the generated error message
  










        
Parameters:

    

    

          

        $delimeter  
        $delimeter  
        The string to use as the delimeter between the array of messages
      

          

        $override  
        $delete  
        whether to override status messages with error messages
      

          

          
        $override  
        
      

        

    


        
[ Top ]

  

  

	
	
method hasErrors [line 114]

	

    

    

		int hasErrors(
)
    

    


	
		check if errors







Tags:





  

    return:  error type
  










        
[ Top ]

  

  

	
	
method log [line 267]

	

    

    

		nothing log(
msg
$msg, [level
$level = 'DEFAULT'])
    

    


	
		Log the given messge under the given level











        
Parameters:

    

    

          

        msg  
        $msg  
        The message to log
      

          

        level  
        $level  
        The log to log this message under
      

        

    


        
[ Top ]

  

  

	
	
method registerAuthidError [line 150]

	

    

    

		false registerAuthidError(
[$url
$url = null])
    

    


	
		Register a failed authid check. This method calls registerError and  then redirects back to the specified URL.











        
Parameters:

    

    

          

        $url  
        $url  
        The URL to redirect to (optional) (default=null)
      

        

    


        
[ Top ]

  

  

	
	
method registerError [line 199]

	

    

    

		false registerError(
$message
$message, [$type
$type = null], [$url
$url = null])
    

    


	
		Set an error message text. Also adds method, file and line where the error occured











        
Parameters:

    

    

          

        $message  
        $message  
        string the error message
      

          

        $type  
        $type  
        type of error (numeric and corresponding to a HTTP status code) (optional) (default=null)
      

          

        $url  
        $url  
        the url to redirect to (optional) (default=null)
      

        

    


        
[ Top ]

  

  

	
	
method registerPermissionError [line 163]

	

    

    

		false registerPermissionError(
[$url
$url = null])
    

    


	
		Register a failed permission check. This method calls registerError and  then logs the failed permission check so that it can be analyzed later.











        
Parameters:

    

    

          

        $url  
        $url  
        The URL to redirect to (optional) (default=null)
      

        

    


        
[ Top ]

  

  

	
	
method registerStatus [line 126]

	

    

    

		true registerStatus(
$message
$message)
    

    


	
		Set an error message text











        
Parameters:

    

    

          

        $message  
        $message  
        string the error message
      

        

    


        
[ Top ]

  

  

	
	
method _checkLogFile [line 456]

	

    

    

		boolean _checkLogFile(

$logfile, 
$level, 
&$reason)
    

    


	
		Check the log file is writable and not full.


returns unwritable The file or directory cannot be written to  returns toobig The log file size is bigger than $log_length in logging.conf.php.






Tags:





  

    return:  Whether or not the file is ready for writing
  










        
Parameters:

    

    

          

          
        $logfile  
        
      

          

          
        $level  
        
      

          

          
        &$reason  
        
      

        

    


        
[ Top ]

  

  

	
	
method _cleanLogFiles [line 497]

	

    

    

		void _cleanLogFiles(
)
    

    


	
		Cleans up unneeded old log files











        
[ Top ]

  

  

	
	
method _write [line 341]

	

    

    

		Logging _write(
msg
$msg, [level
$level = 'DEFAULT'], [
$securityInfo = null])
    

    


	
		Write the error message to the log file.


Prints log file full error (if $log_show_errors is true)






Tags:





  

    return:  file write error (file or directory unwritable) (if $log_show_errors is true)
  










        
Parameters:

    

    

          

        msg  
        $msg  
        The message to log
      

          

        level  
        $level  
        The log level to log this message under
      

          

          
        $securityInfo  
        
      

        

    


        
[ Top ]

  




	





		  
Packages:

      

							
Files:

		




				
				
Classes: