WARNING LocalSite.cfg could not be found (This is normal for a new installation)
This Foswiki is running using a bootstrap configuration worked out by detecting the layout of the installation. To complete the bootstrap process you should either:
  • Restore the missing LocalSite.cfg from a backup, or
  • Complete the new Foswiki installation:

You have been logged in as a temporary administrator. Any requests made to this Foswiki will be treated as requests made by an administrator with full rights Your temporary administrator rights will "stick" until you've logged out from this session.
A Proxy server was detected. {ForceDefaultUrlHost} has been enabled.

If this page is rendered without any styles and you are using SSL (https), your proxy server may be misconfigured. It must generate the X-Forwarded-Proto header. Try adding ?SSL=1 to the Foswiki URL to bypass this issue.

error Warning: Updates found for 1 extension(s): EditRowPlugin ... Upgrade
You are here: Foswiki>System Web>Category>DeveloperDocumentationCategory>PerlDoc (06 Aug 2023, UnknownUser)Edit Attach

PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Parent package: Foswiki
Child packages:

internal package Foswiki::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 Foswiki session object with %initalContext and calls $sub method. Returns the Foswiki::Response object.

StaticMethod logon($session)

Handler for "logon" action.
  • $session is a Foswiki session object

StaticMethod checkWebExists( $session, $web, $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 checkAccess( $session, $mode, $topicObject )

Check if the given mode of access by the given user to the given web.topic is permissible, throwing a Foswiki::AccessControlException if not.

StaticMethod checkValidationKey( $session )

Check the validation key for the given action. Throws an exception if the validation key isn't valid (handled in _execute(), above)
  • $session - the current session object

See Foswiki::Validation for more information.

StaticMethod run( $method, %context )

Supported for bin scripts that were written for Foswiki < 1.0. The parameters are a function reference to the UI method to call and initial context.

In Foswiki >= 1.0 it should be replaced by a Config.spec entry such as:

# *PERL H* # Bin script registration - do not modify $Foswiki::cfg{SwitchBoard}{publish} = [ "Foswiki::Contrib::Publish", "publish", { publishing => 1 } ];

Edit  | Attach |   | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
Topic revision: r1 - 06 Aug 2023, UnknownUser
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback