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.
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. | |
| getXMLErrors () | |
| Get errors related to XML parsing. | |
| hasError () | |
| Does this object have errors? | |
| hasWarning () | |
| Does this object have warnings? | |
| parseXML ($xml) | |
| Parse an XML string and catch any parsing errors. | |
| resetError () | |
| Reset (clear) the errors stored for this object. | |
| resetWarning () | |
| Reset (clear) the warnings stored on this object. | |
| setError ($error) | |
| Set an error on this object. | |
| setPrettyError ($function, $error) | |
| Set an error with extra information about the function and object involved. | |
| setPrettyWarning ($function, $warning) | |
| Set a warning with extra information about the function and object involved. | |
| setUserError ($error) | |
| Set a user-visible error on this object. | |
| setWarning ($warning) | |
| Set a warning on this object. | |
| 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? | |
| static | resetStaticError () |
| Reset (clear) the static errors stored on this object. | |
| static | resetStaticWarning () |
| Reset (clear) the static warnings stored on this object. | |
| static | setStaticError ($error) |
| Set a static error on this object. | |
| static | setStaticPrettyError ($function, $error) |
| Set a static error with extra information about the function and object involved. | |
| static | setStaticPrettyWarning ($function, $warning) |
| Set a static warning with extra information about the function and object involved. | |
| static | setStaticWarning ($warning) |
| Set a static warning on this object. | |
Private Member Functions | |
| setSilentError ($msg) | |
| Set a silent error (not sent through SErrorManager). | |
| setSilentWarning ($msg) | |
| Set a silent warning (not sent through SErrorManager). | |
Provides error/warning reporting and XML parsing methods. All other classes in the web framework should extend this class.
Commented 11/21/08
Definition at line 12 of file SObject.php5.
| SObject::__construct | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
Reimplemented in AlbumModule, SLdap, CSERDModelBase, ModelBase, SDRModel, SCserdAuthModule, SGlobalAuthModule, SIplusAuthModule, SLdapAuthModule, SNcsiAuthModule, SSigmaxiAuthModule, SSucceedAuthModule, AuthModelBase, SGlobalUser, TKBorderPanel, TKHBox, TKNullBox, TKScrollPane, TKTree, TKVBox, TKDefaultTheme, TKComponent, TKContainer, and TKTheme.
Definition at line 53 of file SObject.php5.
| SObject::getError | ( | ) |
Get all the errors set on this object.
Definition at line 72 of file SObject.php5.
Referenced by SSucceedAuthModule::authenticate(), SSigmaxiAuthModule::authenticate(), SNcsiAuthModule::authenticate(), SGlobalAuthModule::authenticate(), SCserdAuthModule::authenticate(), TSD::can(), SQuestionnaire::commit(), SModel::commit(), SModel::commitForeign(), SnapContentMediaInteractivateApplet::copyFrom(), SModel::DBIHasNoError(), TSDBook::delete(), SnapContentMediaInteractivateApplet::doCopy(), SnapContentMediaImage::doCopy(), TSDService::getAlignmentsByStatus(), getErrorFrom(), TSDText::getListImpl(), TSDStandard::getListImpl(), TSDObject::getListImpl(), TSD::getParties(), TSDRelation::getRelated(), TSDService::getRelationships(), TSDWord::getResourceAlignments(), TSDService::getResourcesAligned(), SQuestionnaire::getXFormsModel(), hasError(), SDR::init(), CSERD::init(), TSDText::populate(), TSDStandard::populate(), SModel::populate(), TKSnapInteractivateLessonEditor::processSave(), TKSnapInteractivateInstructorEditor::processSave(), PageRender2::renderPrint(), TSD::setPermission(), SQuestionnaire::setXFormsModel(), STransObject::translate(), SInput::translate(), and SnapContentMediaInteractivateApplet::uploadApplet().
| SObject::getErrorFrom | ( | $ | obj | ) |
Relay errors from another object to this object.
| $obj | [object]: The object from which to fetch the errors |
Definition at line 140 of file SObject.php5.
References doc(), getError(), hasError(), setPrettyError(), and setSilentError().
Referenced by SPOSTEventHandler::callEventHandler(), SXMLListModel::getXMLImpl(), SModel2::getXMLImpl(), SPOSTEventHandler::handleEvents(), PageRender2::load(), SQuestionnaire::populate(), SDatabaseModel::prepareUpdate(), PageRender2::renderPrint(), and SModel2::setXMLImpl().
| SObject::getLastError | ( | ) |
Get the last error that was set on this object.
Definition at line 116 of file SObject.php5.
Referenced by SnapContentMediaDocument::doCopy(), TKSnapCssEditor::processSave(), and TSDBook::uploadCoverImage().
| static SObject::getLastStaticError | ( | ) | [static] |
Get the last static error that was set on this object.
Definition at line 361 of file SObject.php5.
Referenced by SnapSearch::execute().
| static SObject::getLastStaticWarning | ( | ) | [static] |
Get the last static warning that was set on this object.
Definition at line 372 of file SObject.php5.
| SObject::getLastWarning | ( | ) |
Get the last warning that was set on this object.
Definition at line 128 of file SObject.php5.
| static SObject::getStaticError | ( | ) | [static] |
Get all the static errors set on this object.
Definition at line 261 of file SObject.php5.
Referenced by hasStaticError(), and SnapDirectory::listContents().
| static SObject::getStaticWarning | ( | ) | [static] |
Get all the static warnings set on this object.
Definition at line 282 of file SObject.php5.
Referenced by hasStaticWarning().
| SObject::getWarning | ( | ) |
Get all the warnings set on this object.
Definition at line 64 of file SObject.php5.
Referenced by getWarningFrom(), hasWarning(), and PageRender2::renderPrint().
| SObject::getWarningFrom | ( | $ | obj | ) |
Relay warnings from another object to this object.
| $obj | [object]: The object from which to fetch the warnings |
Definition at line 159 of file SObject.php5.
References doc(), getWarning(), hasWarning(), setPrettyError(), and setSilentWarning().
Referenced by SXMLListModel::getXMLImpl(), SModel2::getXMLImpl(), PageRender2::load(), PageRender2::renderPrint(), SModel2::setXMLImpl(), and SInput::translate().
| SObject::getXMLErrors | ( | ) |
Get errors related to XML parsing.
For internal use only.
Definition at line 427 of file SObject.php5.
| SObject::hasError | ( | ) |
Does this object have errors?
Definition at line 198 of file SObject.php5.
References getError().
Referenced by SPOSTEventHandler::callEventHandler(), SDatabaseModel::commit(), getErrorFrom(), SModel::getList(), SDRService::getResource(), SPOSTEventHandler::handleEvents(), PageRender2::load(), SQuestionnaire::populate(), STransObject::translate(), STrans::translate(), SInput::translate(), and SDRServiceCache::updateAverageReviewRating().
| static SObject::hasStaticError | ( | ) | [static] |
Does this object have static errors?
Definition at line 303 of file SObject.php5.
References getStaticError().
| static SObject::hasStaticWarning | ( | ) | [static] |
Does this object have static warnings?
Definition at line 312 of file SObject.php5.
References getStaticWarning().
| SObject::hasWarning | ( | ) |
Does this object have warnings?
Definition at line 207 of file SObject.php5.
References getWarning().
Referenced by getWarningFrom().
| SObject::parseXML | ( | $ | xml | ) |
Parse an XML string and catch any parsing errors.
For internal use only.
| $xml | [string]: A string of XML | |
| $fixEntities | [boolean]: if true, put entities into CDATA sections to prevent parse and other errors |
Definition at line 439 of file SObject.php5.
References SXMLHelper::parse().
Referenced by SQuestionnaire::setXFormsModel(), and TransSDRPendingXML::translate().
| SObject::resetError | ( | ) |
Reset (clear) the errors stored for this object.
For internal use only.
Definition at line 215 of file SObject.php5.
Referenced by DBI2::clearErrors().
| static SObject::resetStaticError | ( | ) | [static] |
Reset (clear) the static errors stored on this object.
For internal use only.
Definition at line 320 of file SObject.php5.
| static SObject::resetStaticWarning | ( | ) | [static] |
Reset (clear) the static warnings stored on this object.
For internal use only.
Definition at line 328 of file SObject.php5.
| SObject::resetWarning | ( | ) |
Reset (clear) the warnings stored on this object.
For internal use only.
Definition at line 223 of file SObject.php5.
| SObject::setError | ( | $ | error | ) |
Set an error on this object.
For internal use only.
| $error | [string]: The string describing the error |
Definition at line 82 of file SObject.php5.
References SErrorManager::sobj_setError().
Referenced by TSDObject::__call(), TKContainer::__call(), TKComponent::__call(), SModel::__call(), SnapObject::__call(), DBTransaction::__call(), TKTreeAction::__construct(), TKSubmitAction::__construct(), TKPopupAction::__construct(), TKEmitAction::__construct(), TKChangeStyleAction::__construct(), SnapPermissionCache::__construct(), SnapPermission::__construct(), DBI2::__construct(), SModel2::__get(), SModel2::__set(), SnapFile::_canMove(), TKContainer::add(), TSDStandardGrade::addCategory(), TSDBook::addChapter(), TSDStandardOrganization::addGrade(), TKTree::addItemsTo(), TKContainer::addPriv(), SQuestionnaire::addQuestion(), TSDRequest::addResourceId(), SQuestionnaire::addResponseForRef(), TSDLeaf::align(), TKComponent::append(), TSDRelation::approve(), TSDLeaf::approveAlignments(), TKPagedView::build(), SDRServiceRequest::buildQueryURL(), TSDRelation::cancel(), TSDLeaf::cancelAlignments(), DBI2::cancelTransaction(), SnapFile::chcanonparent(), TSDObject::checkInit(), SModel2::checkType(), SnapObject::checkValid(), TSDText::commit(), TSDStandard::commit(), TSDRelation::commit(), SQuestionnaire::commit(), SDatabaseModel::commit(), SModel::commit(), SnapPermission::commit(), SnapMetadata::commit(), SModel::commitForeign(), DBI2::commitTransaction(), SnapContentMediaNetlogoApplet::copyFrom(), SnapContentMediaInteractivateApplet::copyFrom(), SnapContentMediaAgentsheetsApplet::copyFrom(), SnapExternalFile::create(), SnapDirectory::createDirectory(), SnapDirectory::createResource(), SModel::DBIHasNoError(), TSDRelation::delete(), TSDObject::delete(), TSDBook::delete(), DBI2::delete(), TSDStandardGrade::deleteCategoryByName(), TSDBook::deleteChapterByName(), TSDStandardOrganization::deleteGradeByName(), SnapFile::destroy(), SnapContentMediaInteractivateApplet::doCopy(), SnapContentMediaImage::doCopy(), SnapContentMediaDocument::doCopy(), TSDRequest::enableType(), SnapExternalFile::generateRelPath(), TSDObject::get(), TKComponent::get(), SModel2::get(), SDRSearchService::getAlignments(), SnapPermissionObject::getCapabilities(), SnapPermissionObject::getCapability(), SDatabaseModel::getConstraintForPrimaryKey(), DBI2::getDB(), DBI2::getFieldName(), SDatabaseModel::getFormatted(), SnapPermission::getGroupsAccess(), DBResult::getInsertId(), SModel::getList(), SModel::getListQuery(), DBI2::getQuery(), SQuestionnaire::getQuestionByRef(), SDRSearchService::getRelationships(), TSDWord::getResourceAlignments(), SQuestionnaire::getResponseByRefAndId(), SQuestionnaire::getResponsesForRef(), DBI2::getResult(), DBResult::getRow(), SnapContentMediaAgentsheetsApplet::getSize(), TKContainer::getSlotOption(), SnapPermission::getUserAccess(), SQuestionnaire::getXFormsModel(), SnapContentInteractivateLesson::getXML(), SnapContentInteractivateInstructor::getXML(), SnapContentMediaAgentsheetsApplet::getZipPath(), SnapContentMediaAgentsheetsApplet::getZipURL(), SnapPermission::has(), SnapPermission::hasEx(), SModel2::isChanged(), SnapObject::isLoaded(), TSDRelation::isValid(), TSDLeaf::listAlignments(), SnapDirectory::listContents(), SnapExternalFile::load(), SnapFile::loadCanonicalPath(), SnapDirectory::loadMaxDirOrdinal(), SnapResource::loadMaxOrdinal(), SnapDirectory::loadMaxResOrdinal(), SnapPermission::loadParties(), SDRSearchService::loadXML(), SLdapAuthModule::lookupGroups(), SLdap::lookupGroups(), SLdapAuthModule::lookupUsers(), SLdap::lookupUsers(), SnapPermission::mayLinkTo(), SnapPermission::mayRenameAt(), SnapPermission::mayReorderIn(), SnapPermission::maySetCanonicalParent(), SnapPermission::mayUnlinkFrom(), SnapFile::mklink(), DBResult::nextRow(), DBResult::numRows(), TSDText::populate(), TSDStandard::populate(), TSDRelation::populate(), TSDObject::populate(), SDatabaseModel::populate(), SModel::populate(), SnapPermissionObject::populate(), SnapVersion::populate(), SnapMetadata::populate(), SnapFile::populate(), SDatabaseModel::prepareUpdate(), SnapMetadata::put(), SnapMetadata::putMany(), SDRFedSearchClient::query(), DBI2::query(), SQuestionnaire::queryOrSetError(), SDatabaseModel::registerDBI(), SnapFile::reorderIn(), DBResult::reset(), SnapFile::restore(), SnapPermission::revokeGroup(), SnapPermission::revokeUser(), DBResult::seek(), TSDRelation::set(), TSDObject::set(), TKComponent::set(), SModel2::set(), SnapContent::set(), SnapExternalFile::setAcceptable(), TKComponent::setAction(), SnapContentMediaAgentsheetsApplet::setAdditionalWorksheets(), SnapMetadata::setAll(), SnapContent::setAll(), SnapContentMediaInteractivateApplet::setAppClass(), SDatabaseModel::setAttrsFromDBResult(), SDatabaseModel::setAttrsFromMultiDBResult(), SnapPermissionObject::setCapability(), TSDBook::setCoverImage(), CSERDUser::setEmail(), SDatabaseModel::setFormatted(), SnapPermission::setGroupAccess(), SnapContentMediaNetlogoApplet::setHeight(), SnapContentMediaInteractivateApplet::setHeight(), SnapContentMediaAgentsheetsApplet::setHeight(), TKTree::setItemState(), TSDRequest::setMode(), SnapFile::setName(), TSDRequest::setObjectId(), setPrettyError(), TSDRequest::setResourceId(), DBI2::setResult(), SnapObject::setSave(), TKContainer::setSlotOption(), SnapPermission::setUserAccess(), SnapResource::setValidDate(), SModel2::setValues(), SnapContentMediaNetlogoApplet::setWidth(), SnapContentMediaInteractivateApplet::setWidth(), SnapContentMediaAgentsheetsApplet::setWidth(), SnapContentMediaAgentsheetsApplet::setWorksheet(), SnapContentMediaAgentsheetsApplet::setWsCols(), SnapContentMediaAgentsheetsApplet::setWsRows(), SQuestionnaire::setXFormsModel(), SModel2::setXML(), DBI2::startTransaction(), SModel::superGetList(), DBResult::toArray(), STransObject::translate(), SInput::translate(), TSDLeaf::unalign(), SnapObject::unsetField(), DBI2::update(), SnapContentMediaNetlogoApplet::uploadApplet(), SnapContentMediaInteractivateApplet::uploadApplet(), SnapContentMediaAgentsheetsApplet::uploadApplet(), TSDBook::uploadCoverImage(), SnapContentMediaDocument::uploadDocument(), SnapContentMediaFile::uploadFile(), SnapContentMediaImage::uploadImage(), SDRServiceRequest::usePreset(), and SnapPermissionCache::warmCache().
| SObject::setPrettyError | ( | $ | function, | |
| $ | error | |||
| ) |
Set an error with extra information about the function and object involved.
For internal use only.
| $function | [string]: The name of the function the error is set from | |
| $error | [string]: The string describing the error |
Definition at line 234 of file SObject.php5.
References setError().
Referenced by STrans::__construct(), AlbumModule::addImageDirectory(), SSucceedAuthModule::authenticate(), SSigmaxiAuthModule::authenticate(), SNcsiAuthModule::authenticate(), SGlobalAuthModule::authenticate(), SCserdAuthModule::authenticate(), SPOSTEventHandler::callEventHandler(), SPermission::checkPermission(), SPOSTEventHandler::generateEvent(), PageRender2::getClassInstance(), getErrorFrom(), SModel::getList(), getWarningFrom(), PageRender2::load(), SQuestionnaire::populate(), SQuestionnaire::queryOrSetError(), PageRender2::render(), SGlobalAuthModule::requireProjects(), SQuestion::setActive(), SResponse::setQuestionId(), SQuestion::setRequired(), SResponse::setResponseId(), SResponse::setSurveyId(), STransObject::translate(), STransListXML::translate(), STrans::translate(), SInput::translate(), STransStdXML3Helper::translateList(), STransStdXML3Helper::translateListPage(), STransListXML::translateListPage(), STransStdXML3Helper::translateListUnit(), and STransListXML::translateListUnit().
| SObject::setPrettyWarning | ( | $ | function, | |
| $ | warning | |||
| ) |
Set a warning with extra information about the function and object involved.
| $function | [string]: The name of the function the warning is set from | |
| $warning | [string]: The string describing the warning |
Definition at line 246 of file SObject.php5.
References setWarning().
Referenced by SGlobalUser::authenticateWith(), SUser::clearSessionData(), CSERDuser::clearSessionData(), SUser::getSessionData(), CSERDuser::getSessionData(), SEventHandler::handleEvent(), SPOSTEventHandler::handleEvents(), STransStdXML3Helper::processBlockLevelElementXML(), and STransStdXML3Helper::processBlockOrMixedContentXMLHelper().
| SObject::setSilentError | ( | $ | msg | ) | [private] |
Set a silent error (not sent through SErrorManager).
For internal use only.
| $msg | [string]: The string describing the error |
Definition at line 178 of file SObject.php5.
Referenced by getErrorFrom().
| SObject::setSilentWarning | ( | $ | msg | ) | [private] |
Set a silent warning (not sent through SErrorManager).
For internal use only.
| $msg | [string]: The string describing the warning |
Definition at line 189 of file SObject.php5.
Referenced by getWarningFrom().
| static SObject::setStaticError | ( | $ | error | ) | [static] |
Set a static error on this object.
For internal use only.
| $error | [string]: The string describing the error |
Definition at line 271 of file SObject.php5.
References SErrorManager::sobj_setError().
Referenced by setStaticPrettyError().
| static SObject::setStaticPrettyError | ( | $ | function, | |
| $ | error | |||
| ) | [static] |
Set a static error with extra information about the function and object involved.
For internal use only.
| $function | [string]: The name of the function the error is set from | |
| $error | [string]: The string describing the error |
Definition at line 339 of file SObject.php5.
References setStaticError().
Referenced by SPath::getRelPath().
| static SObject::setStaticPrettyWarning | ( | $ | function, | |
| $ | warning | |||
| ) | [static] |
Set a static warning with extra information about the function and object involved.
For internal use only.
| $function | [string]: The name of the function the error is set from | |
| $warning | [string]: The string describing the error |
Definition at line 351 of file SObject.php5.
References setStaticWarning().
| static SObject::setStaticWarning | ( | $ | warning | ) | [static] |
Set a static warning on this object.
For internal use only.
| $warning | [string]: The string describing the warning |
Definition at line 292 of file SObject.php5.
References SErrorManager::sobj_setWarning().
Referenced by setStaticPrettyWarning().
| SObject::setUserError | ( | $ | error | ) |
Set a user-visible error on this object.
For internal use only.
| $error | [string]: The string describing the error |
Definition at line 94 of file SObject.php5.
References SErrorManager::sobj_setError().
| SObject::setWarning | ( | $ | warning | ) |
Set a warning on this object.
For internal use only.
| $warning | [string]: The string describing the warning |
Definition at line 105 of file SObject.php5.
References SErrorManager::sobj_setWarning().
Referenced by SDRServiceRequest::addConstraints(), SQuestionnaire::addQuestion(), TKContainer::addSlot(), DBI2::clearErrors(), SnapPermission::commit(), SnapContentLessonPlan::generateXML(), SXMLListModel::getXMLImpl(), SModel2::getXMLImpl(), DBI2::mysql_insert_id(), TSDText::populate(), TSDStandard::populate(), SnapVersion::populate(), TKComponent::removePropChangeListener(), TKContainer::removeSlot(), DBI2::select(), setPrettyWarning(), TKComponent::setPropChangeListener(), SnapContentXml::setXML(), SModel2::setXMLImpl(), and STransObject::translate().
| SObject::setXMLErrorMode | ( | $ | mode | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
[TYPE]: RETURN DESCRIPTION
For internal use only.
Set the XML parsing error mode
| $mode | [int]: The error parsing mode to be used |
Definition at line 415 of file SObject.php5.
1.5.6