# \cge_debug

A simple class with some debug functions.

This class supports output to different files.

## Summary

Methods
Properties
Constants
set_html()
is_html()
set_instant()
is_instant()
set_filename()
output()
add()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A
final

File
  lib/class.cge_debug.php
Package
  \CGExtensions
Class hierarchy
  \cge_debug

## Tags

todo |

## Methods

### set_html()

    set_html(bool $var)

Set flag indicating that output should be in html.

#### Parameters

bool | $var |

#

static

## Tags

todo |

### is_html()

    is_html() : bool

Get flag indicating that output should be in html or not.

#### Returns

bool

#

static

## Tags

todo |

### set_instant()

    set_instant(bool $var)

Set flag indicating that output should be output instantly, or cached

#### Parameters

bool | $var |

#

static

## Tags

todo |

### is_instant()

    is_instant() : bool

Get flag indicating whether output should be output instantly, or cached

#### Returns

bool

#

static

## Tags

todo |

### set_filename()

    set_filename(string $str)

Set filename for debug output.

The default value for this variable is TMP_CACHE_LOCATION/cge_debug.log

#### Parameters

string | $str | The absolute path to the filename.

#

static

## Tags

todo |

### output()

    output(string $filename)

Output accrued debug information to a specified file.

If the filename parameter is not specified, the currently set filename will be used, or a hardcoded filename.

#### Parameters

string | $filename |

#

static

## Tags

todo |

### add()

    add(mixed $var, string $title)

Add information to the debug log.

#### Parameters

mixed | $var | The variable to add to the debug log. This method attempts to parse objects and arrays.
string | $title | The title for the debug message.

#

static

## Tags

todo |

### class.cge_debug.php