Overview

Namespaces

  • api
  • config
  • database
  • PHP
  • Slim
    • Exception
    • Http
    • Middleware
  • utiliy

Classes

  • Environment
  • Log
  • LogWriter
  • Middleware
  • Route
  • Router
  • Slim
  • View
  • Overview
  • Namespace
  • Class
  • Tree

Class Log

Log

This is the primary logger for a Slim application. You may provide a Log Writer in conjunction with this Log to write to various output destinations (e.g. a file). This class provides this interface:

debug( mixed $object ) info( mixed $object ) warn( mixed $object ) error( mixed $object ) fatal( mixed $object )

This class assumes only that your Log Writer has a public write() method that accepts any object as its one and only argument. The Log Writer class may write or send its argument anywhere: a file, STDERR, a remote web API, etc. The possibilities are endless.

Namespace: Slim
Package: Slim
Author: Josh Lockhart
Since: 1.0.0
Located at thirdparty/Slim/Log.php
Methods summary
public
# __construct( mixed $writer )

Constructor

Constructor

Parameters

$writer
mixed
$writer
public boolean
# getEnabled( )

Is logging enabled?

Is logging enabled?

Returns

boolean
public
# setEnabled( boolean $enabled )

Enable or disable logging

Enable or disable logging

Parameters

$enabled
boolean
$enabled
public
# setLevel( integer $level )

Set level

Set level

Parameters

$level
integer
$level

Throws

InvalidArgumentException
If invalid log level specified
public integer
# getLevel( )

Get level

Get level

Returns

integer
public
# setWriter( mixed $writer )

Set writer

Set writer

Parameters

$writer
mixed
$writer
public mixed
# getWriter( )

Get writer

Get writer

Returns

mixed
public boolean
# isEnabled( )

Is logging enabled?

Is logging enabled?

Returns

boolean
public mixed|false
# debug( mixed $object )

Log debug message

Log debug message

Parameters

$object
mixed
$object

Returns

mixed|false
What the Logger returns, or false if Logger not set or not enabled
public mixed|false
# info( mixed $object )

Log info message

Log info message

Parameters

$object
mixed
$object

Returns

mixed|false
What the Logger returns, or false if Logger not set or not enabled
public mixed|false
# warn( mixed $object )

Log warn message

Log warn message

Parameters

$object
mixed
$object

Returns

mixed|false
What the Logger returns, or false if Logger not set or not enabled
public mixed|false
# error( mixed $object )

Log error message

Log error message

Parameters

$object
mixed
$object

Returns

mixed|false
What the Logger returns, or false if Logger not set or not enabled
public mixed|false
# fatal( mixed $object )

Log fatal message

Log fatal message

Parameters

$object
mixed
$object

Returns

mixed|false
What the Logger returns, or false if Logger not set or not enabled
protected integer|false
# write( mixed $object, integer $level )

Log message

Log message

Parameters

$object
mixed
The object to log
$level
integer
The message level

Returns

integer|false
Constants summary
integer FATAL 0
#
integer ERROR 1
#
integer WARN 2
#
integer INFO 3
#
integer DEBUG 4
#
Properties summary
protected static array $levels array( self::FATAL => 'FATAL', self::ERROR => 'ERROR', self::WARN => 'WARN', self::INFO => 'INFO', self::DEBUG => 'DEBUG' )
#
protected mixed $writer
#
protected boolean $enabled
#
protected integer $level
#
GeoApi API documentation generated by ApiGen 2.8.0