jonasbn > Workflow-1.38 > Workflow::Condition::HasUser

Download:
Workflow-1.38.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  4
Open  2
View/Report Bugs
Module Version: 1.05   Source   Latest Release: Workflow-1.41

NAME ^

Workflow::Condition::HasUser - Condition to determine if a user is available

VERSION ^

This documentation describes version 1.05 of this package

SYNOPSIS ^

 # First setup the condition
 
 <conditions>
   <condition name="HasUser"
              class="Workflow::Condition::HasUser">
     <param name="user_key" value="CurrentUser" />
   </condition>
   ...

 # Next, attach it to an action
 
 <state name="INITIAL">
   <action name="create issue"
           resulting_state="CREATED">
       <condition name="CurrentUser" />
   </action>
   ...

 # Whenever you fetch available actions from state 'INITIAL' you must
 # have the key 'CurrentUser' defined in the workflow context

DESCRIPTION ^

Simple -- possibly too simple -- condition to determine if a user exists in a particular context key. Actually, it really only determines if something exists in a key, but we needed a simple condition to ship with the module.

Parameters

You can configure the condition with the following parameters:

METHODS

evaluate ( $wf )

Method to evaluate whether a user has been set for a workflow.

Takes a workflow object as parameter

Throws Workflow::Exception if evaluation fails

SEE ALSO ^

Workflow::Condition

COPYRIGHT ^

Copyright (c) 2004 Chris Winters. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHORS ^

Chris Winters <chris@cwinters.com>

syntax highlighting: