Package =TWiki::UICoordinator of execution flow and service functions used by the UI packagesOn this page:
StaticMethod handleRequest ($req) -> $resMain coordinator of request-process-response cycle.StaticMethod execute ($req,$sub,%initialContext) -> $resCreates a TWiki session object with %initalContext and calls $sub method. Returns the TWiki::Response object generatedStaticMethod logon ($session)Handler to "logon" action.
StaticMethod checkWebExists ($session,$web,$topic,$op) | ||||||||
Changed: | ||||||||
< < | Check if the web exists. If it doesn't, will throw an oops exception. | |||||||
> > | Check if the web exists. If it does not, will throw an oops exception. | |||||||
$op is the user operation being performed.
StaticMethod topicExists ($session,$web,$topic,$op)=>booleanCheck if the given topic exists, throwing an OopsException if it doesn't. $op is the user operation being performed.StaticMethod *checkWebWritable ($session)Checks if this web is writable on this site, Throwing an exception if it is not.StaticMethod checkAccess ($web,$topic,$mode,$user)Check if the given mode of access by the given user to the given web.topic is permissible, throwing a TWiki::OopsException if not.StaticMethod *readTemplateTopic ($session,$theTopicName) -> ($meta,$text)Search for a template topic in current web, Main web, and TWiki web, in that order.StaticMethod run ($method)Supported for bin scripts that were written for TWiki < 5.0. The parameter is a function reference to the UI method to call, and is ignored in TWiki >= 5.0, where it should be replaced by a Config.spec entry such as: # *PERL H* # Bin script registration - do not modify $TWiki::cfg{SwitchBoard}{publish} = [ "TWiki::Contrib::Publish", "publish", { publishing => 1 } ];StaticMethod *verifyCryptToken ($session,$crypt_token) |
Changed: | ||||||||
< < | Package = | |||||||
> > | Package =TWiki::UI | |||||||
Deleted: | ||||||||
< < | On this page:
package TWiki::UI | |||||||
Coordinator of execution flow and service functions used by the UI packages | ||||||||
Added: | ||||||||
> > | On this page:
| |||||||
StaticMethod handleRequest ($req) -> $resMain coordinator of request-process-response cycle.StaticMethod execute ($req,$sub,%initialContext) -> $resCreates a TWiki session object with %initalContext and calls $sub method. Returns the TWiki::Response object generatedStaticMethod logon ($session)Handler to "logon" action.
StaticMethod checkWebExists ($session,$web,$topic,$op)Check if the web exists. If it doesn't, will throw an oops exception. $op is the user operation being performed.StaticMethod topicExists ($session,$web,$topic,$op)=>booleanCheck if the given topic exists, throwing an OopsException if it doesn't. $op is the user operation being performed. | ||||||||
Changed: | ||||||||
< < | StaticMethod checkMirror ($session,$web,$topic) | |||||||
> > | StaticMethod *checkWebWritable ($session) | |||||||
Changed: | ||||||||
< < | Checks if this web is a mirror web, throwing an OopsException if it is. | |||||||
> > | Checks if this web is writable on this site, Throwing an exception if it is not. | |||||||
StaticMethod checkAccess ($web,$topic,$mode,$user)Check if the given mode of access by the given user to the given web.topic is permissible, throwing a TWiki::OopsException if not.StaticMethod *readTemplateTopic ($session,$theTopicName) -> ($meta,$text)Search for a template topic in current web, Main web, and TWiki web, in that order.StaticMethod run ($method)Supported for bin scripts that were written for TWiki < 5.0. The parameter is a function reference to the UI method to call, and is ignored in TWiki >= 5.0, where it should be replaced by a Config.spec entry such as: # *PERL H* # Bin script registration - do not modify $TWiki::cfg{SwitchBoard}{publish} = [ "TWiki::Contrib::Publish", "publish", { publishing => 1 } ];StaticMethod *verifyCryptToken ($session,$crypt_token) |
Package =On this page:
package TWiki::UICoordinator of execution flow and service functions used by the UI packagesStaticMethod handleRequest ($req) -> $resMain coordinator of request-process-response cycle.StaticMethod execute ($req,$sub,%initialContext) -> $resCreates a TWiki session object with %initalContext and calls $sub method. Returns the TWiki::Response object generatedStaticMethod logon ($session)Handler to "logon" action.
StaticMethod checkWebExists ($session,$web,$topic,$op)Check if the web exists. If it doesn't, will throw an oops exception. $op is the user operation being performed.StaticMethod topicExists ($session,$web,$topic,$op)=>booleanCheck if the given topic exists, throwing an OopsException if it doesn't. $op is the user operation being performed.StaticMethod checkMirror ($session,$web,$topic)Checks if this web is a mirror web, throwing an OopsException if it is.StaticMethod checkAccess ($web,$topic,$mode,$user)Check if the given mode of access by the given user to the given web.topic is permissible, throwing a TWiki::OopsException if not.StaticMethod *readTemplateTopic ($session,$theTopicName) -> ($meta,$text) | ||||||||
Changed: | ||||||||
< < | Read a topic from the TWiki web, or if that fails from the current | |||||||
> > | Search for a template topic in current web, Main web, and TWiki web, in that order. | |||||||
Deleted: | ||||||||
< < | web. | |||||||
StaticMethod run ($method)Supported for bin scripts that were written for TWiki < 5.0. The parameter is a function reference to the UI method to call, and is ignored in TWiki >= 5.0, where it should be replaced by a Config.spec entry such as: # *PERL H* # Bin script registration - do not modify $TWiki::cfg{SwitchBoard}{publish} = [ "TWiki::Contrib::Publish", "publish", { publishing => 1 } ];StaticMethod *verifyCryptToken ($session,$crypt_token) |
Changed: | ||||||||
< < | Package =TWiki::UI | |||||||
> > | Package = | |||||||
Changed: | ||||||||
< < | Service functions used by the UI packages | |||||||
> > | On this page:
| |||||||
Added: | ||||||||
> > | package TWiki::UI | |||||||
Added: | ||||||||
> > | Coordinator of execution flow and service functions used by the UI packages | |||||||
Deleted: | ||||||||
< < | On this page:
| |||||||
Changed: | ||||||||
< < | StaticMethod run (\&method,...) | |||||||
> > | StaticMethod handleRequest ($req) -> $res | |||||||
Changed: | ||||||||
< < | Entry point for execution of a UI function. The parameter is a | |||||||
> > | Main coordinator of request-process-response cycle. | |||||||
Deleted: | ||||||||
< < | reference to the method. | |||||||
Deleted: | ||||||||
< < | ... is a list of name-value pairs that define initial context identifiers that must be set during initPlugin. This set will be extended to include command_line if the script is detected as being run outside the browser. | |||||||
Added: | ||||||||
> > | StaticMethod execute ($req,$sub,%initialContext) -> $res | |||||||
Added: | ||||||||
> > | Creates a TWiki session object with %initalContext and calls
$sub method. Returns the TWiki::Response object generated
StaticMethod logon ($session)Handler to "logon" action.
| |||||||
StaticMethod checkWebExists ($session,$web,$topic,$op)Check if the web exists. If it doesn't, will throw an oops exception. $op is the user operation being performed.StaticMethod topicExists ($session,$web,$topic,$op)=>booleanCheck if the given topic exists, throwing an OopsException if it doesn't. $op is the user operation being performed.StaticMethod checkMirror ($session,$web,$topic)Checks if this web is a mirror web, throwing an OopsException if it is.StaticMethod checkAccess ($web,$topic,$mode,$user)Check if the given mode of access by the given user to the given web.topic is permissible, throwing a TWiki::OopsException if not.StaticMethod *readTemplateTopic ($session,$theTopicName) -> ($meta,$text)Read a topic from the TWiki web, or if that fails from the current web. | ||||||||
Added: | ||||||||
> > |
StaticMethod run ($method)Supported for bin scripts that were written for TWiki < 5.0. The parameter is a function reference to the UI method to call, and is ignored in TWiki >= 5.0, where it should be replaced by a Config.spec entry such as: # *PERL H* # Bin script registration - do not modify $TWiki::cfg{SwitchBoard}{publish} = [ "TWiki::Contrib::Publish", "publish", { publishing => 1 } ]; | |||||||
StaticMethod *verifyCryptToken ($session,$crypt_token) |
Package =TWiki::UIService functions used by the UI packagesOn this page:
StaticMethod run (\&method,...)Entry point for execution of a UI function. The parameter is a reference to the method. ... is a list of name-value pairs that define initial context identifiers that must be set during initPlugin. This set will be extended to include command_line if the script is detected as being run outside the browser.StaticMethod checkWebExists ($session,$web,$topic,$op)Check if the web exists. If it doesn't, will throw an oops exception. $op is the user operation being performed.StaticMethod topicExists ($session,$web,$topic,$op)=>booleanCheck if the given topic exists, throwing an OopsException if it doesn't. $op is the user operation being performed.StaticMethod checkMirror ($session,$web,$topic)Checks if this web is a mirror web, throwing an OopsException if it is.StaticMethod checkAccess ($web,$topic,$mode,$user)Check if the given mode of access by the given user to the given web.topic is permissible, throwing a TWiki::OopsException if not.StaticMethod *readTemplateTopic ($session,$theTopicName) -> ($meta,$text)Read a topic from the TWiki web, or if that fails from the current web. | ||||||||
Added: | ||||||||
> > | StaticMethod *verifyCryptToken ($session,$crypt_token) |
Package =TWiki::UIService functions used by the UI packagesOn this page:
| ||||||||
Changed: | ||||||||
< < | StaticMethod run (\&method) | |||||||
> > | StaticMethod run (\&method,...) | |||||||
Entry point for execution of a UI function. The parameter is a reference to the method. | ||||||||
Added: | ||||||||
> > | ... is a list of name-value pairs that define initial context identifiers that must be set during initPlugin. This set will be extended to include command_line if the script is detected as being run outside the browser. | |||||||
Added: | ||||||||
> > | ||||||||
StaticMethod checkWebExists ($session,$web,$topic,$op)Check if the web exists. If it doesn't, will throw an oops exception. $op is the user operation being performed.StaticMethod topicExists ($session,$web,$topic,$op)=>boolean | ||||||||
Added: | ||||||||
> > | ||||||||
Check if the given topic exists, throwing an OopsException
if it doesn't. $op is the user operation being performed.
StaticMethod checkMirror ($session,$web,$topic) | ||||||||
Added: | ||||||||
> > | ||||||||
Checks if this web is a mirror web, throwing an OopsException
if it is.
StaticMethod checkAccess ($web,$topic,$mode,$user) | ||||||||
Added: | ||||||||
> > | ||||||||
Check if the given mode of access by the given user to the given
web.topic is permissible, throwing a TWiki::OopsException if not.
StaticMethod *readTemplateTopic ($session,$theTopicName) -> ($meta,$text)Read a topic from the TWiki web, or if that fails from the current web. |
Package =TWiki::UIService functions used by the UI packagesOn this page:
StaticMethod run (\&method)Entry point for execution of a UI function. The parameter is a reference to the method.StaticMethod checkWebExists ($session,$web,$topic,$op)Check if the web exists. If it doesn't, will throw an oops exception. $op is the user operation being performed.StaticMethod topicExists ($session,$web,$topic,$op)=>booleanCheck if the given topic exists, throwing an OopsException if it doesn't. $op is the user operation being performed.StaticMethod checkMirror ($session,$web,$topic)Checks if this web is a mirror web, throwing an OopsException if it is.StaticMethod checkAccess ($web,$topic,$mode,$user)Check if the given mode of access by the given user to the given web.topic is permissible, throwing a TWiki::OopsException if not.StaticMethod *readTemplateTopic ($session,$theTopicName) -> ($meta,$text)Read a topic from the TWiki web, or if that fails from the current web. |