Difference: TWikiUIDotPm (1 vs. 5)

Revision 52011-08-21 - TWikiContributor

 

Package =

package TWiki::UI

Coordinator of execution flow and service functions used by the UI packages

StaticMethod handleRequest ($req) -> $res

Main coordinator of request-process-response cycle.

StaticMethod execute ($req,$sub,%initialContext) -> $res

Creates a TWiki session object with %initalContext and calls $sub method. Returns the TWiki::Response object generated

StaticMethod logon ($session)

Handler to "logon" action.

  • $session is a TWiki session object

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

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)

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)

Revision 42010-05-29 - TWikiContributor

Changed:
<
<

Package =TWiki::UI

>
>

Package =

 
Changed:
<
<
Service functions used by the UI packages
>
>
Added:
>
>

package TWiki::UI

 
Added:
>
>
Coordinator of execution flow and service functions used by the UI packages
 
Deleted:
<
<
 
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.

  • $session is a TWiki session object

 

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

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)

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)

Revision 32009-09-02 - TWikiContributor

 

Package =TWiki::UI

Service functions used by the UI packages

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)=>boolean

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)

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)

Revision 22007-01-16 - TWikiContributor

 

Package =TWiki::UI

Service functions used by the UI packages

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.

Revision 12006-02-01 - TWikiContributor

 

Package =TWiki::UI

Service functions used by the UI packages

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)=>boolean

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)

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.

 
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © 1999-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiUIDotPm.