SObject Class Reference

Root object for all other objects in the framework to extend. More...

Inherited by AlbumModule, CSERD, DBI2, DBResult, DBTransaction, GlobalPermission, PageRender2, SAuthModule, SCserdAuthModule, SDR, SDRFedSearchClient, SDRHelpers, SDRService, SDRServiceCache, SDRServiceRequest, SDRServiceStats, SEventHandler, SGlobalAuthModule, SInput, SIplusAuthModule, SModel, SModel2, Snap2, SnapBulkAction, SnapCache, SnapContent, SnapDBI, SnapExternalFile, SnapObject, SnapPathCache, SnapPermissionCache, SnapPermissionObject, SnapSearchRequest, SNcsiAuthModule, SPage, SPath, SPermission, SPOSTEventHandler, SQuery, SQuestionnaire, SSigmaxiAuthModule, SStringHelper, SSucceedAuthModule, STestReporter, STrans, STransStdXML3Helper, SURLHelper, SUserConfig, SValidation, SXMLHelper, TKAction, TKComponent, TKTheme, Toolkit, TSD, TSDObject, TSDRequest, TSDService, XFormsControlItem, XFormsGroup, XmlFormatter, and XSI.

List of all members.

Public Member Functions

 __construct ()
 INSERT BRIEF DESCRIPTION HERE.
 doc ()
 Return a documentation string about this class.
 getError ()
 Get all the errors set on this object.
 getErrorFrom ($obj)
 Relay errors from another object to this object.
 getLastError ()
 Get the last error that was set on this object.
 getLastWarning ()
 Get the last warning that was set on this object.
 getWarning ()
 Get all the warnings set on this object.
 getWarningFrom ($obj)
 Relay warnings from another object to this object.
 hasError ()
 Does this object have errors?
 hasWarning ()
 Does this object have warnings?
 setPrettyWarning ($function, $warning)
 Set a warning with extra information about the function and object involved.
 setXMLErrorMode ($mode)
 INSERT BRIEF DESCRIPTION HERE.

Static Public Member Functions

static getLastStaticError ()
 Get the last static error that was set on this object.
static getLastStaticWarning ()
 Get the last static warning that was set on this object.
static getStaticError ()
 Get all the static errors set on this object.
static getStaticWarning ()
 Get all the static warnings set on this object.
static hasStaticError ()
 Does this object have static errors?
static hasStaticWarning ()
 Does this object have static warnings?


Detailed Description

Root object for all other objects in the framework to extend.

Provides error/warning reporting and XML parsing methods. All other classes in the web framework should extend this class.

Author:
Jonathan (jwsm@shodor.org)
Date:
6/9/07

Commented 11/21/08


Constructor & Destructor Documentation

SObject::__construct (  ) 


Member Function Documentation

SObject::getError (  ) 

Get all the errors set on this object.

Returns:
[array]: Errors

SObject::getErrorFrom ( obj  ) 

Relay errors from another object to this object.

Parameters:
$obj [object]: The object from which to fetch the errors

SObject::getLastError (  ) 

Get the last error that was set on this object.

Returns:
[string]: The last error, or false if none exists

static SObject::getLastStaticError (  )  [static]

Get the last static error that was set on this object.

Returns:
[string]: The last static error, or false if none exists

static SObject::getLastStaticWarning (  )  [static]

Get the last static warning that was set on this object.

Returns:
[string]: The last static warning, or false if none exists

SObject::getLastWarning (  ) 

Get the last warning that was set on this object.

Returns:
[string]: The last warning, or false if none exists

static SObject::getStaticError (  )  [static]

Get all the static errors set on this object.

Returns:
[array]: Errors

static SObject::getStaticWarning (  )  [static]

Get all the static warnings set on this object.

Returns:
[array]: Warnings

SObject::getWarning (  ) 

Get all the warnings set on this object.

Returns:
[array]: Warnings

SObject::getWarningFrom ( obj  ) 

Relay warnings from another object to this object.

Parameters:
$obj [object]: The object from which to fetch the warnings

SObject::hasError (  ) 

Does this object have errors?

Returns:
[boolean]: True if there are errors set

static SObject::hasStaticError (  )  [static]

Does this object have static errors?

Returns:
[boolean]: True if there are static errors set

static SObject::hasStaticWarning (  )  [static]

Does this object have static warnings?

Returns:
[boolean]: True if there are static warnings set

SObject::hasWarning (  ) 

Does this object have warnings?

Returns:
[boolean]: True if there are warnings set

SObject::setPrettyWarning ( function,
warning 
)

Set a warning with extra information about the function and object involved.

Parameters:
$function [string]: The name of the function the warning is set from
$warning [string]: The string describing the warning

SObject::setXMLErrorMode ( mode  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION INSERT BRIEF DESCRIPTION HERE INSERT FULL DESCRIPTION HERE

[TYPE]: RETURN DESCRIPTION


The documentation for this class was generated from the following file:

Generated on Wed Nov 24 02:03:23 2010 for Common by  doxygen 1.5.6