TWiki's TWiki webThe Documentation Web of TWiki. TWiki is an Enterprise Collaboration Platform.
Changed:
< <
https://g3.dmuk.ac.uk/twiki/bin/view/TWikiCopyright 2024 by contributing authors2018-07-16T03:20:45ZSourceCodehttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/SourceCode2018-07-16T03:20:45ZTWiki Source Code Packages This documentation is automatically generated from the pod , so it always matches the running code TWiki::AccessControlException Exception... (last changed by TWikiContributor)TWikiContributorTWikiUIDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUIDotPm2018-07-16T03:20:41ZPackage TWiki::UI Coordinator of execution flow and service functions used by the UI packages StaticMethod handleRequest ($req) $res Main coordinator of request... (last changed by TWikiContributor)TWikiContributorTWikiDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiDotPm2015-11-29T10:27:03ZPackage TWiki TWiki operates by creating a singleton object (known as the Session object) that acts as a point of reference for all the different modules in the system... (last changed by TWikiContributor)TWikiContributorTWikiOopsExceptionDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiOopsExceptionDotPm2013-10-14T08:02:47ZPackage TWiki::OopsException Exception used to raise a request to redirect to an Oops URL. An OopsException thrown anywhere in the code will redirect the browser... (last changed by TWikiContributor)TWikiContributorTWikiEngineDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiEngineDotPm2013-10-14T08:02:47ZPackage TWiki::Engine The engine class is a singleton that implements details about TWiki`s execution mode. This is the base class and implements basic behavior.... (last changed by TWikiContributor)TWikiContributorTWikiUIMdrepoUIDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUIMdrepoUIDotPm2013-10-14T08:02:47ZPackage TWiki::UI::MdrepoUI UI delegate for mdrepo function StaticMethod mdrepo ($session); (last changed by TWikiContributor)TWikiContributorTWikiUICopyDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUICopyDotPm2013-10-14T08:02:47ZPackage TWiki::UI::Copy UI delegate for copy function StaticMethod copy ($session) copy command handler. This method is designed to be invoked via the UI::run... (last changed by TWikiContributor)TWikiContributorTWikiFormSelectDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiFormSelectDotPm2013-10-14T08:02:47ZPackage TWiki::Form::Select getDefaultValue() $value The default for a select is always the empty string, as there is no way in TWiki form definitions to indicate... (last changed by TWikiContributor)TWikiContributorTWikiResponseDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiResponseDotPm2013-10-14T08:02:47ZPackage TWiki::Response Class to encapsulate response data. Fields: status response status headers hashref to response headers body... (last changed by TWikiContributor)TWikiContributorTWikiConfigureCheckersCertificateKeyCheckerDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiConfigureCheckersCertificateKeyCheckerDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::Checkers::Certificate::KeyChecker Configure GUI checker for Certificate Key items. This checker validates files that contain private key... (last changed by TWikiContributor)TWikiContributorTWikiStoreRcsFileDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiStoreRcsFileDotPm2013-10-14T08:02:47ZPackage TWiki::Store::RcsFile This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. It is the base class of implementations of stores... (last changed by TWikiContributor)TWikiContributorTWikiConfigureCheckersCertificateDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiConfigureCheckersCertificateDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::Checkers::CertificateChecker Configure GUI checker for Certificate items. This checker validates files that contain X.509 certificates,... (last changed by TWikiContributor)TWikiContributorTWikiUsersTWikiUserMappingDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUsersTWikiUserMappingDotPm2011-08-21T04:16:00ZPackage TWiki::Users::TWikiUserMapping The User mapping is the process by which TWiki maps from a username (a login name) to a wikiname and back. It is also where... (last changed by TWikiContributor)TWikiContributorTWikiPluginsDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiPluginsDotPm2010-05-29T14:44:56ZPackage TWiki::Plugins This module defines the singleton object that handles Plugins loading, initialization and execution. This class uses Chain of Responsibility... (last changed by TWikiContributor)TWikiContributorTWikiUIUploadDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUIUploadDotPm2010-05-29T14:44:45ZPackage TWiki::UI::Upload UI delegate for attachment management functions StaticMethod attach ($session) attach command handler. This method is designed to be... (last changed by TWikiContributor)TWikiContributorTWikiEngineExceptionDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiEngineExceptionDotPm2010-05-29T14:44:11ZPackage TWiki::EngineException Exception used to raise an engine related error. This exception has the following fields: status status code to send to client... (last changed by TWikiContributor)TWikiContributor
TWiki's TWiki webThe Documentation Web of TWiki. TWiki is an Enterprise Collaboration Platform.https://g3.dmuk.ac.uk/twiki/bin/view/TWikiCopyright 2024 by contributing authors2018-07-16T03:20:47ZTWikiRenderDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiRenderDotPm2018-07-16T03:20:47ZPackage TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer ObjectMethod finish... (last changed by TWikiContributor)TWikiContributorTWikiConfigureImgToolDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiConfigureImgToolDotPm2018-07-16T03:20:39ZPackage TWiki::Configure::ImgTool This class is a singleton that offers URLs for the images (logos, warning, info) used during configuration when neither pub... (last changed by TWikiContributor)TWikiContributorTWikiStoreDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiStoreDotPm2018-07-16T03:20:37ZPackage TWiki::Store This module hosts the generic storage backend. This module provides the interface layer between the `real` store provider which is hidden behind... (last changed by TWikiContributor)TWikiContributorTWikiFuncDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiFuncDotPm2018-07-16T03:20:32ZPackage TWiki::Func Official list of stable TWiki functions for Plugin developers This module defines official functions that TWiki plugins can use to interact... (last changed by TWikiContributor)TWikiContributorTWikiUsersDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUsersDotPm2018-07-16T03:20:32ZPackage TWiki::Users This package provides services for the lookup and manipulation of login and wiki names of users, and their authentication. It is a Facade that... (last changed by TWikiContributor)TWikiContributorTWikiFormDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiFormDotPm2014-10-05T11:03:28ZPackage TWiki::Form Object representing a single form definition. Form definitions are mainly used to control rendering of a form for editing, though there is some... (last changed by TWikiContributor)TWikiContributorTWikiConfigureUIsEXTENDDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiConfigureUIsEXTENDDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::UIs::EXTEND StaticMethod unpackArchive ($archive ,$dir ) Unpack an archive. The unpacking method is determined from the file extension... (last changed by TWikiContributor)TWikiContributorTWikiRequestDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiRequestDotPm2013-10-14T08:02:47ZPackage TWiki::Request Class to encapsulate request data. Fields: action action requested (view, edit, save, ...) cookies hashref whose keys are cookie... (last changed by TWikiContributor)TWikiContributorTWikiAccessDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiAccessDotPm2013-10-14T08:02:47ZPackage TWiki::Access A singleton object of this class manages the access control database. Dynamic access control and permission caching As TWiki:Codev/DynamicAccessControl... (last changed by TWikiContributor)TWikiContributorTWikiLoginManagerDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiLoginManagerDotPm2013-10-14T08:02:47ZPackage TWiki::LoginManager The package is also a Factory for login managers and also the base class for all login managers. On its own, an object of this class is... (last changed by TWikiContributor)TWikiContributorTWikiLoginManagerSessionDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiLoginManagerSessionDotPm2013-10-14T08:02:47ZPackage TWiki::LoginManager::Session Class to provide CGI::Session like infra structure, compatible with TWiki Runtime Engine mechanisms other than CGI. It inherits... (last changed by TWikiContributor)TWikiContributorTWikiUserMappingDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUserMappingDotPm2011-08-21T04:16:08ZPackage TWiki::UserMapping This is a virtual base class (a.k.a an interface) for all user mappers. It is not useable as a mapping in TWiki use the BaseUserMapping... (last changed by TWikiContributor)TWikiContributorTWikiUsersPasswordDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUsersPasswordDotPm2011-08-21T04:15:50ZPackage TWiki::Users::Password Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like. The methods of this class... (last changed by TWikiContributor)TWikiContributorWebLeftBarSearchhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/WebLeftBarSearch2009-04-29T20:53:55Z (last changed by TWikiContributor)TWikiContributorTWikiPluralsDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiPluralsDotPm2009-03-30T09:17:52ZPackage TWiki::Plurals Handle conversion of plural topic names to singular form. StaticMethod singularForm ($web,$pluralForm) $singularForm Try to singularise... (last changed by TWikiContributor)TWikiContributorTWikiInfixParserDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiInfixParserDotPm2008-12-06T09:02:22ZPackage TWiki::Infix::Parser A simple stack based parser that parses infix expressions with nonary, unary and binary operators specified using an operator table.... (last changed by TWikiContributor)TWikiContributor
TWiki's TWiki webThe Documentation Web of TWiki. TWiki is an Enterprise Collaboration Platform.https://g3.dmuk.ac.uk/twiki/bin/view/TWikiCopyright 2024 by contributing authors2018-07-16T03:20:47ZTWikiRenderDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiRenderDotPm2018-07-16T03:20:47ZPackage TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer ObjectMethod finish... (last changed by TWikiContributor)TWikiContributorTWikiConfigureImgToolDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiConfigureImgToolDotPm2018-07-16T03:20:39ZPackage TWiki::Configure::ImgTool This class is a singleton that offers URLs for the images (logos, warning, info) used during configuration when neither pub... (last changed by TWikiContributor)TWikiContributorTWikiNetDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiNetDotPm2015-11-29T10:27:03ZPackage TWiki::Net Object that brokers access to network resources. ObjectMethod finish () Break circular references. ObjectMethod registerExternalHTTPHandler... (last changed by TWikiContributor)TWikiContributorTWikiTimeDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiTimeDotPm2014-10-05T11:03:29ZPackage TWiki::Time Time handling functions. StaticMethod parseTime ($szDate,$defaultLocal) $iSecs Convert string date/time string to seconds since epoch (... (last changed by TWikiContributor)TWikiContributorTWikiUISearchDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUISearchDotPm2013-10-14T08:02:47ZPackage TWiki::UI::Search UI functions for searching. StaticMethod search ($session) Perform a search as dictated by CGI parameters: Parameter: Description... (last changed by TWikiContributor)TWikiContributorTWikiPluginDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiPluginDotPm2013-10-14T08:02:47ZPackage TWiki::Plugin ClassMethod new ($session,$name,$module) $session TWiki object $name name of the plugin e.g. MyPlugin $module... (last changed by TWikiContributor)TWikiContributorTWikiStoreSearchAlgorithmsPurePerlDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiStoreSearchAlgorithmsPurePerlDotPm2013-10-14T08:02:47ZPackage TWiki::Store::SearchAlgorithms::PurePerl Pure perl implementation of the RCS cache search. StaticMethod search ($searchString,$topics,$options,$sDir)... (last changed by TWikiContributor)TWikiContributorTWikiConfigureLoadDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiConfigureLoadDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::Load This module consists of just a single subroutine readConfig . It allows to safely modify configuration variables for one single... (last changed by TWikiContributor)TWikiContributorTWikiConfigureUIsEXTENDDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiConfigureUIsEXTENDDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::UIs::EXTEND StaticMethod unpackArchive ($archive ,$dir ) Unpack an archive. The unpacking method is determined from the file extension... (last changed by TWikiContributor)TWikiContributorTWikiRequestDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiRequestDotPm2013-10-14T08:02:47ZPackage TWiki::Request Class to encapsulate request data. Fields: action action requested (view, edit, save, ...) cookies hashref whose keys are cookie... (last changed by TWikiContributor)TWikiContributorTWikiUsersBaseUserMappingDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUsersBaseUserMappingDotPm2013-10-14T08:02:47ZPackage TWiki::Users::BaseUserMapping User mapping is the process by which TWiki maps from a username (a login name) to a display name and back. It is also where... (last changed by TWikiContributor)TWikiContributorTWikiUsersPasswordDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUsersPasswordDotPm2011-08-21T04:15:50ZPackage TWiki::Users::Password Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like. The methods of this class... (last changed by TWikiContributor)TWikiContributorTWikiUsersHtPasswdUserDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUsersHtPasswdUserDotPm2011-08-21T04:15:17ZPackage TWiki::Users::HtPasswdUser Support for htpasswd and htdigest format password files. Subclass of TWiki::Users::Password . See documentation of that class... (last changed by TWikiContributor)TWikiContributorWebLeftBarSearchhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/WebLeftBarSearch2009-04-29T20:53:55Z (last changed by TWikiContributor)TWikiContributorTWikiCompatibilityDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiCompatibilityDotPm2008-01-22T03:21:32ZPackage TWiki::Compatibility Support for compatibility with old TWiki versions. Packaged separately because 99.999999% of the time this won`t be needed. StaticMethod... (last changed by TWikiContributor)TWikiContributorTWikiUIRDiffDotPmhttps://g3.dmuk.ac.uk/twiki/bin/view/TWiki/TWikiUIRDiffDotPm2008-01-22T03:21:32ZPackage TWiki::UI::RDiff UI functions for diffing. StaticMethod diff ($session,$web,$topic,$query) diff command handler. This method is designed to be invoked... (last changed by TWikiContributor)TWikiContributor