SOC_Widget Class Reference

Inheritance diagram for SOC_Widget:

List of all members.

Public Member Functions
	SOC_Widget ($conf=NULL)
	remove ($key)
	version ()
	error ($msg)
	errors ($prefix="\nWARNING: ")
	errorReset ()
	conf ($configuration)

---

Detailed Description

SOC_Widget - root widget class for application.

Definition at line 26 of file soc1c.php.

---

Member Function Documentation

SOC_Widget::conf

(

$

configuration )

conf - read in a configuration file setting the attribute pairs found

Definition at line 107 of file soc1c.php.

References error().

Referenced by SOC_Configuration::SOC_Configuration(), and SOC_Widget().

SOC_Widget::error

(

$

msg )

error - store an error message for later processing in the object.

Parameters:

$msg	- the error message you want to record.

Returns:

true if successful, false otherwise

Definition at line 69 of file soc1c.php.

References WSCORE2::message().

Referenced by SOC_API1C::_restParse(), conf(), SOC_API1C::eventLoop(), SOC_API1C::getBioUrl(), SOC_API1C::getBooklist(), SOC_API1C::getCacheForTerm(), SOC_API1C::getClasses(), SOC_API1C::getDepartments(), SOC_API1C::getSession(), SOC_API1C::getTerms(), and AIS_SOAP_WS::xmlFromSoap().

SOC_Widget::errorReset

(

)

error_rest - reset the errors and error count stored with this object.

Returns:

true always

Definition at line 94 of file soc1c.php.

SOC_Widget::errors

(

$

prefix = "\nWARNING: " )

errors - return a string with all the errors stored in this object prefixed by $prefix

Parameters:

$prefix

- message prefix to display

Returns:

the error formatted error string

Definition at line 81 of file soc1c.php.

References WSCORE2::message().

Referenced by SOC_API1C::eventLoop().

SOC_Widget::remove

(

$

key )

remove - Remove an attribute from Object

Parameters:

$key	- the key of the attribute you wish to remove

Returns:

true if successful, false otherwise.

Definition at line 47 of file soc1c.php.

SOC_Widget::SOC_Widget

(

$

conf = NULL )

SOC_Widget - constructor for root level object

Returns:

SOC_Widget

Definition at line 32 of file soc1c.php.

References WSCORE2::__construct(), and conf().

Referenced by SOC_API1C::__construct(), AIS_SOAP_WS::AIS_SOAP_WS(), and SOC_Configuration::SOC_Configuration().

SOC_Widget::version

(

)

version - return a string of the version of this object

Definition at line 58 of file soc1c.php.

---

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

• models/soc1c.php