Following the API System Utility Application Utility

Transcription

1 Class Summary Following the API System Utility Application Utility Asset Tools Manipulating Resources HTML in WebGUI Users, Groups, and Privileges Messaging and Error Handling Miscellaneous Features

2 Following the API WebGUI API is found under the nightly builds for each version of WebGUI WebGUI is documented in POD Format NAME the name of the module DESCRIPTION what this module does SYNOPSIS public methods available METHODS a description of what each method does

3 System Utility WebGUI::Session Opening and Closing Sessions WebGUI::Session::open(webguiRoot,configFilename) WebGUI::Session::start(userId) WebGUI::Session::end(sessionId) WebGUI::Session::close() Updating Session Information WebGUI::Session::refreshPageInfo(assetId) WebGUI::Session::refreshSessionVars(sessionId) WebGUI::Session::refreshUserInfo(userId) WebGUI::Session::convertVisitorToUser(sessionId,userId) Dealing with Session Scratch What is Session Scratch? WebGUI::Session::setScratch(name,value) WebGUI::Session::deleteScratch(name); WebGUI::Session::deleteAllScratch(name);

4 System Utility (Cont) Admin Utilities WebGUI::Session::isAdminOn() WebGUI::Session::switchAdminOn() WebGUI::Session::swtichAdminOff() WebGUI::Auth WebGUI::Auth->new(authMethod,userId) WebGUI::Auth->getParams() WebGUi::Auth->saveParams() WebGUI::Auth->deleteParams() WebGUI::HTTP WebGUI:: WebGUI:: WebGUI:: WebGUI:: WebGUI::

5 System Utility (Cont) WebGUI:: WebGUI:: WebGUI:: WebGUI::

6 Application Utility Asset Functionality WebGUI::Asset WebGUI::Asset->newByDynamicClass(assetId) WebGUI::Asset->newByUrl([url]) WebGUI::Asset->get([propertyName]) WebGUI::Asset->getId() WebGUI::Asset->getUrl([params]) WebGUI::Asset->getvalue(key) WebGUI::Id WebGUI::Id::generate()

7 WebGUI::International WebGUI::International::get(intnlId[,namespace]) WebGUI::International::getLanguage(language[,property]) WebGUI::International::getLanguages() WebGUI::International::makeUrlCompliant(url[,language]) Manipulating Resources WebGUI::DatabaseLink WebGUI::DatabaseLink::getList() WebGUI::DatabaseLink::get(databaseLinkId) WebGUI::DatabaseLink->new(databaseLinkId) WebGUI::DatabaseLink->disconnect() WebGUI::DatabaseLink->dbh()

8 WebGUI::SQL Returning Simple Data WebGUI::SQL->buildArray(sql [,dbh]) WebGUI::SQL->buildArrayRef(sql [,dbh]) WebGUI::SQL->buildHash(sql [,dbh]) WebGUI::SQL->buildHashRef(sql [,dbh]) WebGUI::SQL->getRow(table,key,keyValue [,dbh]) WebGUI::SQL->quickArray(sql [,dbh]) WebGUI::SQL->quickCSV(sql [,dbh]) WebGUI::SQL->quickHash(sql [,dbh]) WebGUI::SQL->quickHashRef(sql [,dbh]) WebGUI::SQL->quickTab(sql [,dbh]) Returning Lists of Data WebGUI::SQl->read(sql [,dbh,placeholders]) WebGUI::SQL->unconditionalRead(sql [,dbh,placeholders]) WebGUI::SQL->prepare(sql [,dbh])

9 Statement Handler Functions $sth->array () $sth->getcolumnnames() $sth->errorcode() $sth->errormessage() $sth->execute() $sth->finish() $sth->hash() $sth->hashref() Writing to the Database WebGUI::SQL->beginTransaction() WebGUI::SQL->commit ([dbh]) WebGUI::SQL->rollback ([dbh]) WebGUI::SQL->setRow (table,key,data [,dbh,id]) WebGUI::SQL->write (sql [,dbh])

10 Utility Methods getnextid(idname) quote(string[,dbh]) quoteandjoin(arrayref[,dbh]) WebGUI::LDAPLink WebGUI::DatebaseLink::getList() WebGUI::DatabaseLink->get(databaseLinkId) WebGUI::LDAPLink->new(ldapLinkId) WebGUI::LDAPLink->bind() WebGUI::LDAPLink->getErrorMessage([ldapErrorCode]) WebGUI::LDAPLink->unbind() WebGUI::LDAPLink->getProperty(dn,property) WebGUI::LDAPLink->recurseProperty(base,array,property [,alternatekey])

11 WebGUI::Storage Creating Storage WebGUI::Storage->create WebGUI::Storage->get(storageId) Streaming Files WebGUI::Storage->addFileFromFilesystem(pathToFile) WebGUI::Storage->addFileFromFormPost(formVarName) WebGUI::Storage->addFileFromHashref(filename,hashref) WebGUI::Storage->addFileFromScalar(filename,content) Retrieving Storage WebGUI::Storage->getFiles WebGUI::Storage->getFileContentsAsHashref(filename) WebGUI::Storage->getFileContentsAsScalar(filename)

12 Storage Information WebGUI::Storage->getErrorCount() WebGUI::Storage->getFileExtension(filename) WebGUI::Storage->getFileIconUrl(filename) WebGUI::Storage->getFileSize(filename) WebGUI::Storage->getId WebGUI::Storage->getLastError WebGUI::Storage->getPath(filename) WebGUI::Storage->getUrl(filename) Filesystem Utilities WebGUI::Storage->copy WebGUI::Storage->tar(filename) WebGUI::Storage->untar(filename) WebGUI::Storage->delete WebGUI::Storage->deleteFile(filename) WebGUI::Storage->rename(filename,newFilename) WebGUI::Storage->setPrivileges(userId,groupIdView, groupidedit)

13 Dealing with HTML WebGUI::Form Asset Button Checkbox Checklist Codearea Color Combo ContentType Control DatabaseLink Date DateTime DynamicField FieldType File FilterContent Float Group Hidden HiddenList HTMLArea Integer Interval LdapLink Password Phone Radio RadioList ReadOnly SelectList Submit Template Text TextArea TimeField Url WhatNext YesNo Zipcode

14 WebGUI::Form::footer() WebGUI::Form::header({action, method, extras, enctype, tableextras}) WebGUI::HTMLForm WebGUI::HTMLForm->new([action,method,extras,enctype, tableextras]) WebGUI::HTMLForm->print() WebGUI::HTMLForm->printRowsOnly() WebGUI::HTMLForm->raw(value) WebGUI::HTMLForm->trClass(class) WebGUI::FormProcessor WebGUI::FormProcessor::process(name,type [,default]) WebGUI::HTML WebGUI::HTML::cleanSegment(html); WebGUI::HTML::filter(html[,filter]);

15 WebGUI::HTML::format(content [,contenttype]); WebGUI::HTML::html2text(html); WebGUI::HTML::makeAbsolute(html [,baseurl]); WebGUI::HTML::processReplacements(html); WebGUI::Icon WebGUI::Icon::copyIcon(urlParameters [,pageurl]) WebGUI::Icon::cutIcon(urlParameters [,pageurl]) WebGUI::Icon::deleteIcon(urlParameters [,pageurl,confirmtext]) WebGUI::Icon::dragIcon() WebGUI::Icon::editIcon(urlParameters [,pageurl ]) WebGUI::Icon::exportIcon (urlparameters [,pageurl]) WebGUI::Icon::getToolbarOptions() - WebGUI::Icon::helpIcon(helpId [,namespace]) WebGUI::Icon::lockedIcon(urlParameters [,pageurl]) WebGUI::Icon::manageIcon(urlParameters [,pageurl])

16 WebGUI::Icon::moveBottomIcon(urlParameters [,pageurl]) WebGUI::Icon::moveDownIcon(urlParameters [,pageurl]) WebGUI::Icon::moveLeftIcon(urlParameters [,pageurl]) WebGUI::Icon::moveRightIcon(urlParameters [,pageurl]) WebGUI::Icon::moveTopIcon(urlParameters [,pageurl]) WebGUI::Icon::moveUpIcon(urlParameters [,pageurl]) WebGUI::Icon::pageIcon() WebGUI::Icon::pasteIcon(urlParameters [,pageurl]) WebGUI::Icon::shortcutIcon(urlParameters [,pageurl]) WebGUI::Icon::viewIcon(urlParameters [,pageurl]) WebGUI::Icon::wobjectIcon() WebGUI::Macro WebGUI::Macro::filter(html) WebGUI::Macro::getParams(parameterString) WebGUI::Macro::negate(html) WebGUI::Macro::process(html)

17 WebGUI::Style WebGUI::Style::generateAdditionalHeadTags() WebGUI::Style::process(content,templateId) WebGUI::Style::setLink (url,params) WebGUI::Style::setMeta(params) WebGUI::Style::setRawHeadTags(tags) WebGUI::Style::setScript(url,params) WebGUI::URL WebGUI::URL::append(url,pairs) WebGUI::URL::escape(string) WebGUI::URL::gateway(pageURL [,pairs]) WebGUI::URL::getScriptURL() WebGUI::URL::getSiteURL() WebGUI::URL::makeCompliant(string) WebGUI::URL::makeAbsolute(url [,baseurl])

18 WebGUI::URL::page([pairs,useSiteUrl, skippreventproxycache ]) WebGUI::URL::setSiteURL(url) WebGUI::URL::unescape(string) WebGUI::URL::urlize(string)

19 Users, Groups, & Privileges WebGUI::User WebGUI::User->new(userId [,overrideid]) WebGUI::User->authMethod([value]) WebGUI::User->dateCreated() WebGUI::User->karma([amount,source,description]) WebGUI::User->lastUpdated() WebGUI::User->profileField (fieldname,[value]) WebGUI::User->status([value]) WebGUI::User->username([value]) WebGUI::User->userId() WebGUI::User->addToGroups(groups [,expireoffset]) WebGUI::User->deleteFromGroups(groups) WebGUI::User->referringAffiliate ([value]) WebGUI::User->delete()

20 Application Utility WebGUI::Privilege WebGUI::Privilege::adminOnly() WebGUI::Privilege::insufficient() WebGUI::Privilege::noAccess() WebGUI::Privilege::notMember() WebGUI::Privilege::vitalComponent() WebGUI::Group WebGUI::Group->new([groupId]) WebGUI::Group->find(name) WebGUI::Group->autoAdd([value]) WebGUI::Group->autoDelete([value]) WebGUI::Group->dateCreated() WebGUI::Group->deleteOffset([value]) WebGUI::Group->description([value]) WebGUI::Group->expireNotify([value]) WebGUI::Group->expireNotifyMessage([value]); WebGUI::Group->expireNotifyOffset([value]); WebGUI::Group->expireOffset([value]);

21 WebGUI::Group->groupId() WebGUI::Group->karmaThreshold([value]); WebGUI::Group->ipFilter([value]); WebGUI::Group->isEditable([value]); WebGUI::Group->lastUpdated() WebGUI::Group->name([value]); WebGUI::Group->scratchFilter([value]); WebGUI::Group->showInForms([value]); WebGUI::Group->dbQuery([value]); WebGUI::Group->databaseLinkId([value]) WebGUI::Group->dbCacheTimeout([value]) WebGUI::Group->ldapGroup([value]) WebGUI::Group->ldapGroupProperty([value]) WebGUI::Group->ldapRecursiveProperty([value]) WebGUI::Group->addGroups(groups) WebGUI::Group->addUsers(users) WebGUI::Group->deleteGroups(groups) WebGUI::Group->deleteUsers(users) WebGUI::Group->delete()

22 WebGUI::Grouping WebGUI::Grouping::addGroupsToGroups(groups,toGroups) WebGUI::Grouping::addUsersToGroups(users,groups [,expireoffset]) WebGUI::Grouping::deleteGroupsFromGroups (groups,fromgroups) WebGUI::Grouping::deleteUsersFromGroups(users,groups) WebGUI::Grouping::getGroupsForGroup(groupId) WebGUI::Grouping::getGroupsForUser(userId [,withoutexpired ]) WebGUI::Grouping::getGroupsInGroup(groupId [,recursive]) WebGUI::Grouping::getUsersInGroup(groupId [,recursive ]) WebGUI::Grouping::isInGroup([groupId,userId ]) WebGUI::Grouping::userGroupAdmin(userId,groupId[,value]) WebGUI::Grouping::userGroupExpireDate(userId,groupId [,epoch ])

23 Messaging & Error Handling WebGUI::Mail WebGUI::Mail::send (to,subject,message [,cc,from,bcc ]) WebGUI::MessageLog WebGUI::MessageLog::addEntry(userId,groupId,subject, message [,url,status,from]) WebGUI::MessageLog::addInternationalizedEntry(userId, groupid,url,internationalid [,namespace,status]) WebGUI::MessageLog::completeEntry(messageLogId) WebGUI::ErrorHandler WebGUI::ErrorHandler::audit(message) WebGUI::ErrorHandler::debug(message) WebGUI::ErrorHandler::error(message) WebGUI::ErrorHandler::fatal(message) WebGUI::ErrorHandler::getLogger()

24 WebGUI::ErrorHandler::getSessionVars() WebGUI::ErrorHandler::getStackTrace() WebGUI::ErrorHandler::info(message) WebGUI::ErrorHandler::security(message) WebGUI::ErrorHandler::showDebug() WebGUI::ErrorHandler::warn(message)

25 Miscellaneous Features WebGUI::DateTime WebGUI::DateTime::addToDate(epoch [,years,months,days]) WebGUI::DateTime::addToTime(epoch [,hours,minutes, seconds]) WebGUI::DateTime::arrayToEpochdate) WebGUI::DateTime::dayStartEnd(epoch) WebGUI::DateTime::dateToEpoch(epoch) WebGUI::DateTime::epochToArray(epoch) WebGUI::DateTime::epochToDate(epoch) WebGUI::DateTime::epochToHuman(epoch,formatString) WebGUI::DateTime::epochToSet(epoch[,withTime]) WebGUI::DateTime::getMonthName (monthinteger) WebGUI::DateTime::getDayName(dayInteger) WebGUI::DateTime::getDaysInMonth(epoch) WebGUI::DateTime::getDaysInInterval(start,end)

26 WebGUI::DateTime::getFirstDayInMonthPosition(epoch) WebGUI::DateTime::getSecondsFromEpoch(epoch) WebGUI::DateTime::humanToEpoch(dateString) WebGUI::DateTime::intervalToSeconds(interval,units) WebGUI::DateTime::localtime(epoch) WebGUI::DateTime::monthCount(startEpoch,endEpoch) WebGUI::DateTime::monthStartEnd(epoch) WebGUI::DateTime::secondsToInterval(seconds) WebGUI::DateTime::secondsToTime(seconds) WebGUI::DateTime::setToEpoch(setString) WebGUI::DateTime::time() WebGUI::DateTime::timeToSeconds(timeString) WebGUI::Paginator WebGUI::Paginator->new(currentURL [,paginateafter, pagenumber,formvar]) WebGUI::Paginator->setDataByArrayRef(arrayRef) WebGUI::Paginator->setDataByQuery(query [,dbh, unconditional,placeholders,dynamicpagenumberkey, dynamicpagenumbervalue])

27 WebGUI::Paginator->appendTemplateVars(hashRef) WebGUI::Paginator->getBar() WebGUI::Paginator->getBarAdvanced() WebGUI::Paginator->getBarSimple() WebGUI::Paginator->getBarTraditional() WebGUi::Paginator->getColumnNames() WebGUI::Paginator->getFirstPageLink() WebGUI::Paginator->getLastPageLink() WebGUI::Paginator->getNextPageLink() WebGUI::Paginator->getNumberOfPages() WebGUI::Paginator->getPage([pageNumber]) WebGUI::Paginator->getPageData([pageNumber]) WebGUI::Paginator->getPageNumber() WebGUI::Paginator->getPageLinks([limit]) WebGUI::Paginator->getPreviousPageLink() WebGUI::Paginator->getRowCount()

28 WebGUI::Utility WebGUI::Utility::commify(integer) WebGUI::Utility::formatBytes(integer) WebGUI::Utility::isBetween(value,first,second) WebGUI::Utility::isIn(value, array) WebGUI::Utility::makeArrayCommaSafe(array) WebGUI::Utility::makeArrayTabSafe(array) WebGUI::Utility::makeCommaSafe(string) WebGUI::Utility::makeTabSafe(string) WebGUI::Utility::randint(low,high) WebGUI::Utility::randomizeArray(array) WebGUI::Utility::randomizeHash(hashRef) WebGUI::Utility::round(float[,significantDigits]) WebGUI::Utility::sortHash(hash) WebGUI::Utility::sortHashDescending(hash)

29 Q&A As if there will be time for this!