Difference between revisions of "Freeside:3:Documentation:Developer/FS/CGI"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::CGI - Subroutines for the web interface
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::CGI qw(header menubar idiot eidiot popurl);
 +
 +
  print header( 'Title', '&#39; );
 +
  print header( 'Title', menubar('item', 'URL', ... ) );
 +
 +
  idiot "error message";
 +
  eidiot "error message";
 +
 +
  $url = popurl; #returns current url
 +
  $url = popurl(3); #three levels up
 +
</code>
 +
==DESCRIPTION==
 +
Provides a few common subroutines for the web interface.
 +
 +
==SUBROUTINES==
 +
; header TITLE, MENUBAR
 +
:Returns an HTML header.
 +
; http_header
 +
:Sets an http header.
 +
; menubar ITEM, URL, ...
 +
:Returns an HTML menubar.
 +
; idiot ERROR
 +
:This is depriciated. Don't use it.
 +
 +
:Sends an HTML error message.
 +
; eidiot ERROR
 +
:This is depriciated. Don't use it.
 +
 +
:Sends an HTML error message, then exits.
 +
; myexit
 +
:You probably shouldn't use this; but if you must:
 +
 +
:If running under mod_perl, calles Apache::exit, otherwise, calls exit.
 +
; popurl LEVEL [URL]
 +
:Returns current (or, optionally, passed) URL with LEVEL levels of path removed from the end (default 0).
 +
; rooturl; table
 +
:Returns HTML tag for beginning a table.
 +
; itable
 +
:Returns HTML tag for beginning an (invisible) table.
 +
; ntable
 +
:This is getting silly.
 +
 +
==BUGS==
 +
Not OO.
 +
 +
Not complete.
 +
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/CGI|CGI]], [[Freeside:3:Documentation:Developer/CGI/Base|CGI::Base]]

Latest revision as of 05:29, 10 February 2015

NAME

FS::CGI - Subroutines for the web interface

SYNOPSIS

 use FS::CGI qw(header menubar idiot eidiot popurl);

 print header( 'Title', '' );
 print header( 'Title', menubar('item', 'URL', ... ) );

 idiot "error message"; 
 eidiot "error message";

 $url = popurl; #returns current url
 $url = popurl(3); #three levels up

DESCRIPTION

Provides a few common subroutines for the web interface.

SUBROUTINES

header TITLE, MENUBAR
Returns an HTML header.
http_header
Sets an http header.
menubar ITEM, URL, ...
Returns an HTML menubar.
idiot ERROR
This is depriciated. Don't use it.
Sends an HTML error message.
eidiot ERROR
This is depriciated. Don't use it.
Sends an HTML error message, then exits.
myexit
You probably shouldn't use this; but if you must:
If running under mod_perl, calles Apache::exit, otherwise, calls exit.
popurl LEVEL [URL]
Returns current (or, optionally, passed) URL with LEVEL levels of path removed from the end (default 0).
rooturl; table
Returns HTML tag for beginning a table.
itable
Returns HTML tag for beginning an (invisible) table.
ntable
This is getting silly.

BUGS

Not OO.

Not complete.

SEE ALSO

CGI, CGI::Base

Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/CGI&oldid=8318"