/ 
Workflow-1.62
River stage zero No dependents
/ Workflow::Condition::HasUser

NAME

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

VERSION

This documentation describes version 1.62 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:

  • user_key, optional

    Key in workflow context to check for data. If not specified we use 'current_user'.

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

COPYRIGHT

Copyright (c) 2004-2023 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.

Please see the LICENSE

AUTHORS

Please see Workflow