ClearOS API

Description

Base class for the API.

author: Point Clark Networks
copyright: Copyright 2006, Point Clark Networks
license: GNU Public License

Located in /api/Engine.class.php (line 228)

Direct descendents

Class	Description
IfaceManager	Network interface manager class.
ClearDirectory	ClearOS LDAP Directory class.
FileGroupManager	Generic file group manager class.
UserManager	User database information.
HordePrefs	Horde Preferences.
WebServices	Web services class.
DmCrypt	DmCrypt base class.
JNetTop	Wrapper for JNetTop utility.
Organization	Organization class.
File	File handling class.
FileTypes	File extension and MIME type class.
Chap	CHAP/PAP configuration class.
ProcessManager	System process manager.
Shell	User shell class.
Raid	RAID Management Utility.
BackupRestore	BackupRestore.
User	User administration.
RemoteBackup	RemoteBackup.
Register	System registration class.
Locale	System locale manager.
Time	System time and configuration.
FileGroup	Generic file group class
Hosts	Hosts.
Process	System process tool.
FileBrowser	File browser.
PosixUser	Posix user administration.
Netstat	Netstat class.
Console	Console utility class.
Folder	Folder handling class.
OpenVpnHelper	OpenVPN helper class.
StorageDevice	Storage Device Utility.
Software	Software package management tools.
Hostname	Hostname class.
System	Shutdown and reboot system class.
GroupManager	System group manager.
Ssl	SSL CA and key management class.
Mime	MIME class.
Os	Software package class.
Mailer	E-Mailer Utility.
Aliases	Mail aliases class.
Stats	Stats utility class.
CyrusAdmin	Cyrus Administrative Interface.
Network	Network tools.
Bnetd	Bnetd class.
UserImport	UserImport.
Country	Country class.
NetworkServices	Network services class.
FirewallRule	FirewallRule base class.
SoftwareUpdate	Software update class.
FileScan	FileScan base class.
ConnectionTracking	Connection tracking class.
Mailzu	Mailzu class
DaemonManager	Daemon manager class.
Archive	Storage Device Utility.
Group	System group manager.
Report	Base class for batch reports.
ShellExec	Wrapper for running shell commands.

Class Constant Summary

COMMAND_API = "/usr/sbin/api"

Variable Summary

array $errors

Method Summary

static void Log (int $code, string $message, string $tag, int $line)

void __construct ()

void __destruct ()

void AddValidationError (string $message, string $tag, integer $line)

boolean CheckValidationErrors ()

array CopyValidationErrors ([boolean $purge = false])

array GetValidationErrors ([boolean $purge = false])

Variables

array $errors = array() (line 238)

var: validation error queue
access: protected

Methods

static method Log (line 285)

Prints a message to the log.

The following log levels are used:

COMMON_DEBUG - debug messages
COMMON_VALIDATION - validation error message
COMMON_INFO - informational messages (e.g. dynamic DNS updated with IP w.x.y.z)
COMMON_NOTICE - pedantic warnings (e.g. dynamic DNS updated with IP w.x.y.z)
COMMON_WARNING - normal but significant errors (e.g. dynamic DNS could not detect WAN IP)
COMMON_ERROR - errors that should not happen under normal circumstances
COMMON_FATAL - really nasty errors

static void Log (int $code, string $message, string $tag, int $line)

int $code: error code
string $message: short and informative message
string $tag: identifier (usually the method)
int $line: line number

Constructor __construct (line 252)

Engine constructor.

void __construct ()

Redefined in descendants as:

IfaceManager::__construct() : IfaceManager constructor.
ClearDirectory::__construct() : LDAP tools constructor.
FileGroupManager::__construct() : Group manager constructor.
UserManager::__construct() : User manager constructor.
HordePrefs::__construct() : Horde Preferences constructor.
WebServices::__construct() : The WebServices constructor.
YumWebService::__construct() : Yum web service constructor.
IpReferrer::__construct() : IpReferrer constructor.
AptWebService::__construct() : Apt web service constructor.
ApplicationWebServices::__construct() : Application web services constructor.
DansGuardianWebService::__construct() : DansGuardian web service constructor.
SnortWebService::__construct() : Snort web service constructor.
SpamAssassinWebService::__construct() : SpamAssassin web service constructor.
SuvaWebService::__construct() : User Web Service constructor.
DynamicDns::__construct() : Dynamic Dns constructor.
UserWebService::__construct() : User Web Service constructor.
IpSecWebService::__construct() : IpSecWebService constructor.
SoftwareWebservice::__construct() : Software webservice constructor.
DmCrypt::__construct() : Dmcrypt constructor.
JNetTop::__construct() : JNetTop constructor.
Organization::__construct() : Organization constructor.
File::__construct() : File constructor.
ConfigurationFile::__construct() : Configuration file constructor.
FileTypes::__construct() : File type constructor.
Chap::__construct() : Chap constructor.
ProcessManager::__construct() : ProccessManager constructor.
Shell::__construct() : Shell constructor.
Raid::__construct() : RAID constructor.
RaidLsi::__construct() : RaidLsi constructor.
Raid3ware::__construct() : Raid3ware constructor.
RaidSoftware::__construct() : RaidSoftware constructor.
BackupRestore::__construct() : BackupRestore constructor.
User::__construct() : User constructor.
RemoteBackup::__construct() : RemoteBackup constructor.
Register::__construct() : Register constructor.
Locale::__construct() : Locale constructor.
Time::__construct() : Time constructor.
NtpTime::__construct() : NtpTime constructor.
FileGroup::__construct() : Group manager constructor.
Hosts::__construct() : Hosts constructor.
Process::__construct() : Proccess constructor.
FileBrowser::__construct() : FileBrowser constructor.
PosixUser::__construct() : User constructor.
Netstat::__construct() : Netstat constructor.
Console::__construct() : Console constructor.
Folder::__construct() : Folder constructor.
OpenVpnHelper::__construct() : OpenVPN helper constructor.
StorageDevice::__construct() : StorageDevice constructor.
Software::__construct() : Software constructor.
Horde::__construct() : Horde constructor.
Daemon::__construct() : Daemon constructor.
Cups::__construct() : Cups constructor.
SpamAssassin::__construct() : SpamAssassin constructor.
Fetchmail::__construct() : Fetchmail constructor.
Snort::__construct() : Snort constructor.
Mysql::__construct() : Mysql constructor.
OpenVpn::__construct() : OpenVPN constructor.
Firewall::__construct() : Firewall constructor.
FirewallRedirect::__construct() : Firewall redirect constructor.
FirewallMultiWan::__construct() : Class constructor.
FirewallForward::__construct() : FirewallForward constructor.
FirewallLayer7Filter::__construct() : FirewallLayer7Filter constructor.
Bandwidth::__construct() : Bandwidth constructor.
FirewallOutgoing::__construct() : Firewall constructor.
FirewallIncoming::__construct() : FirewallIncoming constructor.
FirewallOneToOneNat::__construct() : FirewallOneToOneNat constructor.
FirewallDmz::__construct() : Firewall DMZ constructor.
FirewallWifi::__construct() : FirewallWifi constructor.
Bacula::__construct() : The Bacula constructor.
Cyrus::__construct() : Cyrus constructor.
Ipsec::__construct() : IpSec constructor.
Layer7Filter::__construct() : Layer7Filter constructor.
Freshclam::__construct() : Freshclam constructor.
Httpd::__construct() : Locale constructor.
Postfix::__construct() : Postfix constructor.
Ldap::__construct() : Ldap constructor.
DnsMasq::__construct() : DnsMasq constructor.
AutoFs::__construct() : AutoFs constructor.
Pcmcia::__construct() : PCMCIA constructor.
Syslog::__construct() : Syslog constructor.
SnortSam::__construct() : SnortSam constructor.
Nmbd::__construct() : Nmbd constructor.
Amavis::__construct() : Amavis constructor.
Suva::__construct() : Suva constructor.
Postgrey::__construct() : Postgrey constructor.
Winbind::__construct() : Winbind constructor.
Cron::__construct() : Cron constructor.
Pptpd::__construct() : Pptp constructor.
ClamAv::__construct() : ClamAV constructor.
Proftpd::__construct() : Locale constructor.
Kolab::__construct() : Kolab constructor.
Webconfig::__construct() : Webconfig constructor.
Syswatch::__construct() : Syswatch constructor.
Squid::__construct() : Squid constructor.
DansGuardian::__construct() : Dansguardian constructor.
Samba::__construct() : Samba constructor.
RoundCube::__construct() : RoundCube constructor.
Awstats::__construct() : Awstats constructor.
MailFilter::__construct() : Mail filter constructor.
Mrtg::__construct() : MRTG constructor.
Flexshare::__construct() : Flexshare constructor.
Squirrelmail::__construct() : Squirrelmail constructor.
Altermime::__construct() : Altermime constructor.
Gallery::__construct() : Photo gallery constructor.
Hostname::__construct() : Locale constructor.
HostnameChecker::__construct() : HostnameChecker constructor.
System::__construct() : System constructor.
GroupManager::__construct() : GroupManager constructor.
Ssl::__construct() : Ssl constructor.
Mime::__construct() : Mime constructor.
Os::__construct() : Os constructor.
Mailer::__construct() : Mailer constructor.
Aliases::__construct() : Aliases constructor.
CyrusAdmin::__construct() : Cyrus Admin constructor.
Network::__construct() : Network constructor.
Routes::__construct() : Routes constructor.
Iface::__construct() : Iface constructor.
Ethers::__construct() : Ethers constructor.
Resolver::__construct() : Resolver constructor.
Bnetd::__construct() : Bnetd constructor.
UserImport::__construct() : UserImport constructor.
Country::__construct() : Country constructor.
NetworkServices::__construct() : Network services constructor.
FirewallRule::__construct()
SoftwareUpdate::__construct() : Software update constructor.
FileScan::__construct()
ConnectionTracking::__construct() : Connection tracking constructor.
Mailzu::__construct() : Mailzu constructor.
DaemonManager::__construct() : DaemonManager constructor.
Archive::__construct() : Archive constructor.
Group::__construct() : Group constructor.
Report::__construct() : Report constructor.
ShellExec::__construct() : ShellExec constructor.

Destructor __destruct (line 380)

access: public

void __destruct ()

Redefined in descendants as:

AddValidationError (line 304)

Add a validation error to the queue.

access: protected

void AddValidationError (string $message, string $tag, integer $line)

string $message: error message
string $tag: tag (usually the method call)
integer $line: line number

CheckValidationErrors (line 365)

Returns true if validation errors exist.

return: true if validation errors exist
access: public

boolean CheckValidationErrors ()

CopyValidationErrors (line 346)

Returns an array of validation error objects.

return: validation errors
access: public

array CopyValidationErrors ([boolean $purge = false])

boolean $purge: (optional) if true, the error queue will be purged.

GetValidationErrors (line 323)

Returns an array of validation error messages.

return: validation errors
access: public

array GetValidationErrors ([boolean $purge = false])

boolean $purge: (optional) if true, the error queue will be purged.

Class Constants

COMMAND_API = "/usr/sbin/api" (line 240)

ClearFoundation

Class Engine

Foundation

Software

Community

Contribute