Docs For Class WebCommon

Description

WebCommon.php

Long description for file: Class of common objects/functions for the WebGUI see also the 'Common' Class which this extends

author: FreeNAC Core Team
version: SVN: $Id
copyright: 2008 FreeNAC
link: http://freenac.net
license: GNU Public License Version 3

Located in /lib/WebCommon.php (line 18)

Common
   |
   --WebCommon

Direct descendents

Class	Description
GuiLogtail	GuiLogtail.php.php
GuiPrint	GuiPrint.php
GuiList1	GuiList1.php
GuiEditDevice	GuiEditDevice.php
GuiUserManager	GuiUserManager.php
GuiSearch
GuiEditEthernet	GuiEditEthernet.php
GuiEditIp	GuiEditIp.php
GuiUpdateDns	GuiUpdateDns.php

Variable Summary

mixed $calling_href

mixed $calling_script

mixed $module

mixed $table

Method Summary

WebCommon __construct ([ $show_header = true], [ $debuglevel = 1])

void debug ( $msg, [ $level = 1])

void Delete ( $table, $id)

void get_dose ( $port)

void get_hosts ( $port)

void get_location ( $port)

void get_locationid ( $port)

void get_patch ( $port)

void get_port_comment ( $port)

void get_vlan ( $s)

void loggui ( $msg, [ $who = 0], [ $priority = 'info'])

void logit ( $msg)

void port_delete ( $port)

void port_restart_request ( $port)

void print_dat_stats ( $q)

void print_dot_sel ()

void print_footer ([ $print_links = true])

void print_footer_empty ()

void print_header ([ $print_links = true])

void print_header1 ()

void print_headerMin ()

void print_headerSmall ([ $print_links = true])

void print_logo ()

void print_stats ( $q)

void print_switch_sel ( $sw)

void print_title ( $title)

void strip_datversion ( $long_version)

Variables

mixed $calling_href (line 21)

access: protected

mixed $calling_script (line 21)

access: protected

mixed $module (line 21)

access: protected

mixed $table (line 21)

access: protected

Inherited Variables

Inherited from Common

Common::$conf
Common::$db_conn
Common::$logger

Methods

Constructor __construct (line 23)

WebCommon __construct ([ $show_header = true], [ $debuglevel = 1])

$show_header
$debuglevel

Redefinition of:

Common::__construct(): Get the current instance of our Settings and Logger classes

Redefined in descendants as:

debug (line 45)

Add the class name and uid to debug messages

access: public

void debug ( $msg, [ $level = 1])

$msg
$level

Delete (line 214)

Delete a record from the WebGUI

access: public

void Delete ( $table, $id)

$table
$id

Redefined in descendants as:

GuiEditDevice::Delete()
GuiEditEthernet::Delete() : Delete() // Override the Webcommon functiion since we do not have an id column.

get_dose (line 345)

Lookup the patch outlet name

access: public

void get_dose ( $port)

$port

get_hosts (line 274)

Look up what systems were seen on a port in the last $conf->web_lastdays days

access: public

void get_hosts ( $port)

$port

get_location (line 492)

Look up the first switch or patch location for a port

access: public

void get_location ( $port)

$port

get_locationid (line 300)

Look up the first switch or patch location ID for a port

access: public

void get_locationid ( $port)

$port

get_patch (line 327)

Lookup the patch outlet name

access: public

void get_patch ( $port)

$port

get_port_comment (line 415)

Get port comment

access: public

void get_port_comment ( $port)

$port

get_vlan (line 255)

Get a Vlan name, given its index number

access: public

void get_vlan ( $s)

$s

loggui (line 65)

access: public

void loggui ( $msg, [ $who = 0], [ $priority = 'info'])

$msg
$who
$priority

logit (line 54)

access: public

void logit ( $msg)

$msg

port_delete (line 467)

Delete a port

access: public

void port_delete ( $port)

$port

port_restart_request (line 441)

Set the restart flag for a port

access: public

void port_restart_request ( $port)

$port

print_dat_stats (line 530)

access: public

void print_dat_stats ( $q)

$q

print_dot_sel (line 393)

void print_dot_sel ()

print_footer (line 137)

access: public

void print_footer ([ $print_links = true])

$print_links

Redefined in descendants as:

GuiPrint::print_footer()

print_footer_empty (line 188)

access: public

void print_footer_empty ()

print_header (line 91)

access: public

void print_header ([ $print_links = true])

$print_links

print_header1 (line 128)

access: public

void print_header1 ()

print_headerMin (line 116)

access: public

void print_headerMin ()

print_headerSmall (line 86)

access: public

void print_headerSmall ([ $print_links = true])

$print_links

print_logo (line 81)

access: public

void print_logo ()

print_stats (line 564)

access: public

void print_stats ( $q)

$q

print_switch_sel (line 363)

Print a HTML lookup list of switches

access: public

void print_switch_sel ( $sw)

$sw

print_title (line 202)

access: public

void print_title ( $title)

$title

Redefined in descendants as:

strip_datversion (line 522)

access: public

void strip_datversion ( $long_version)

$long_version

Inherited Methods

Inherited From Common

Common::__construct()
Common::getConnection()
Common::htmlescape()
Common::log2db()
Common::real_escape_string1()
Common::sqlescape()