oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added POD to these packages.

Browse source
This commit is contained in:
JT Smith 2002-12-15 02:58:51 +00:00
parent 21daeceb6e
commit b240822489
12 changed files with 1075 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

72
lib/WebGUI/Macro.pm
View file

@ -1,20 +1,63 @@
package WebGUI::Macro;
#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2002 Plain Black LLC.
#-------------------------------------------------------------------
# Please read the legal notices (docs/legal.txt) and the license
# (docs/license.txt) that came with this distribution before using
# this software.
#-------------------------------------------------------------------
# http://www.plainblack.com info@plainblack.com
#-------------------------------------------------------------------
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2002 Plain Black LLC.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict qw(vars subs);
use WebGUI::ErrorHandler;
use WebGUI::Session;
=head1 NAME
Package WebGUI::Macro
=head1 SYNOPSIS
use WebGUI::Macro;
@array = WebGUI::Macro::getParams($parameterString);
$html = WebGUI::Macro::process($html);
=head1 DESCRIPTION
This package is the interface to the WebGUI macro system.
NOTE: This entire system is likely to be replaced in the near future.
It has served WebGUI well since the very beginning but lacks the
speed and flexibility that WebGUI users will require in the future.
=head1 METHODS
These functions are available from this package:
=cut
#-------------------------------------------------------------------
=head2 getParams ( parameterString )
A simple, but error prone mechanism for getting a prameter list from a string. Returns an array of parameters.
=item parameterString
A string containing a comma separated list of paramenters.
=cut
sub getParams {
my ($data, @param);
$data = $_[0];
@ -28,6 +71,17 @@ sub getParams {
}
#-------------------------------------------------------------------
=head2 process ( html )
Runs all the WebGUI macros to and replaces them in the HTML with their output.
=item html
A string of HTML to be processed.
=cut
sub process {
my ($macro, $cmd, $output);
$output = $_[0];