added workflow form control

lib/WebGUI/Form/Workflow.pm

@@ -0,0 +1,132 @@
+package WebGUI::Form::Workflow;
+
+=head1 LEGAL
+
+ -------------------------------------------------------------------
+  WebGUI is Copyright 2001-2006 Plain Black Corporation.
+ -------------------------------------------------------------------
+  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;
+use base 'WebGUI::Form::SelectBox';
+use WebGUI::Workflow;
+use WebGUI::International;
+
+=head1 NAME
+
+Package WebGUI::Workflow
+
+=head1 DESCRIPTION
+
+Creates a workflow chooser control.
+
+=head1 SEE ALSO
+
+This is a subclass of WebGUI::Form::SelectBox.
+
+=head1 METHODS 
+
+The following methods are specifically available from this class. Check the superclass for additional methods.
+
+=cut
+
+#-------------------------------------------------------------------
+
+=head2 definition ( [ additionalTerms ] )
+
+See the super class for additional details.
+
+=head3 additionalTerms
+
+The following additional parameters have been added via this sub class.
+
+=head4 name
+
+The identifier for this field. Defaults to "workflowId".
+
+=head4 type
+                
+The type of workflows to list based upon the object type that will be passed to them "none", "versiontag", etc. If this is omitted, the entire list of workflows will be returned.
+                
+=head4 label
+
+A text label that will be displayed if toHtmlWithWrapper() is called. Defaults to getName().
+
+=cut
+
+sub definition {
+	my $class = shift;
+	my $session = shift;
+	my $definition = shift || [];
+	my $i18n = WebGUI::International->new($session, 'Workflow_Cron');
+	push(@{$definition}, {
+		formName=>{
+			defaultValue=>$i18n->get("topicName")
+			},
+		label=>{
+			defaultValue=>$i18n->get("topicName")
+			},
+		name=>{
+			defaultValue=>"workflowId"
+			},
+		namespace=>{
+			defaultValue=>undef
+			},
+		});
+        return $class->SUPER::definition($session, $definition);
+}
+
+#-------------------------------------------------------------------
+
+=head2 toHtml ( )
+
+Renders a template picker control.
+
+=cut
+
+sub toHtml {
+	my $self = shift;
+	my $workflowList = WebGUI::Workflow->getList($self->session, $self->get("type"));
+	$self->set("options", $workflowList);
+	$self->setManageIcons();
+	return $self->SUPER::toHtml();
+}
+
+#-------------------------------------------------------------------
+
+=head2 toHtmlWithWrapper ( )
+
+Renders the form field to HTML as a table row complete with labels, subtext, hoverhelp, etc. Also adds manage and edit icons next to the field if the current user is in the admins group.
+
+=cut
+
+sub toHtmlWithWrapper {
+	my $self = shift;
+	$self->setManageIcons();
+	return $self->SUPER::toHtmlWithWrapper;
+}
+
+#-------------------------------------------------------------------
+
+=head2 setManageIcons ( )
+
+Adds code to the subtext field of the form so that buttons for managing or editing the template show up if the user is allowed to do that.
+
+=cut
+
+sub setManageIcons {
+	my $self = shift;
+        my $returnUrl = ";proceed=goBackToPage;returnUrl=".$self->session->url->escape($self->session->asset->getUrl);
+        my $buttons = $self->session->icon->edit("op=editWorkflow".$returnUrl);
+        $buttons .= $self->session->icon->manage("op=manageWorkflows".$returnUrl);
+	$self->set("subtext",$buttons . $self->get("subtext"));
+}
+
+1;

lib/WebGUI/Workflow.pm

@@ -184,6 +184,31 @@ sub getActivities {
 }
 
 
+#-------------------------------------------------------------------
+
+=head2 getList ( session, [ type ] )
+
+Returns a hash reference of workflowId/title pairs of all the workflows defined in the system. This is a class method.
+
+=head3 session
+
+A reference to the current session.
+
+=head3 type
+
+If specified this will limit the list to a certain type of workflow based upon the object type that the workflow is set up to handle.
+
+=cut
+
+sub getList {
+	my $session = shift;
+	my $type = shift;
+	my $sql = "select workflowId, title from Workflow";
+	$sql .= " where type=?" if ($type);
+	return $session->db->buildHashRef($sql, $type);
+}
+
+
 #-------------------------------------------------------------------
 
 =head2 getNextActivity ( [ activityId ] )