Skip to content

Commit

Permalink
Merge c4cdd97 into f823664
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbn committed Aug 1, 2021
2 parents f823664 + c4cdd97 commit 7edcc7a
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 43 deletions.
4 changes: 4 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"first-line-heading": false,
"line-length": false
}
57 changes: 20 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,11 @@ in the workflow lifecycle; these are the events fired:

No additional parameters.

- **rollback** - Issued after a workflow is rolled back, e.g. due to failed
action execution.

No additional parameters.

- **save** - Issued after a workflow is successfully saved.

No additional parameters.
Expand Down Expand Up @@ -530,11 +535,11 @@ initialization time, so it should not happen.)

### get\_action\_fields( $action\_name )

Return a list of [Workflow::Action::InputField](https://metacpan.org/pod/Workflow%3A%3AAction%3A%3AInputField) objects for the given
Return a list of [Workflow::InputField](https://metacpan.org/pod/Workflow%3A%3AInputField) objects for the given
`$action_name`. If `$action_name` not in the current state or not
accessible by the environment an exception is thrown.

Returns: list of [Workflow::Action::InputField](https://metacpan.org/pod/Workflow%3A%3AAction%3A%3AInputField) objects
Returns: list of [Workflow::InputField](https://metacpan.org/pod/Workflow%3A%3AInputField) objects

### add\_history( @( \\%params | $wf\_history\_object ) )

Expand Down Expand Up @@ -583,18 +588,18 @@ Unless otherwise noted, properties are **read-only**.
Some properties are set in the configuration file for each
workflow. These remain static once the workflow is instantiated.

**type**
#### **type**

Type of workflow this is. You may have many individual workflows
associated with a type or you may have many different types
running in a single workflow engine.

**description**
#### **description**

Description (usually brief, hopefully with a URL...) of this
workflow.

**time\_zone**
#### **time\_zone**

Workflow uses the DateTime module to create all date objects. The time\_zone
parameter allows you to pass a time zone value directly to the DateTime
Expand All @@ -605,17 +610,17 @@ See the DateTime module for acceptable values.

You can get the following properties from any workflow object.

**id**
#### **id**

ID of this workflow. This will **always** be defined, since when the
[Workflow::Factory](https://metacpan.org/pod/Workflow%3A%3AFactory) creates a new workflow it first saves it to
long-term storage.

**state**
#### **state**

The current state of the workflow.

**last\_update** (read-write)
#### **last\_update** (read-write)

Date of the workflow's last update.

Expand Down Expand Up @@ -695,35 +700,13 @@ to [Workflow::Config](https://metacpan.org/pod/Workflow%3A%3AConfig), for implem

# DEPENDENCIES

- [Class::Accessor](https://metacpan.org/pod/Class%3A%3AAccessor)
- [Class::Factory](https://metacpan.org/pod/Class%3A%3AFactory)
- [DateTime](https://metacpan.org/pod/DateTime)
- [DateTime::Format::Strptime](https://metacpan.org/pod/DateTime%3A%3AFormat%3A%3AStrptime)
- [Exception::Class](https://metacpan.org/pod/Exception%3A%3AClass)
- [Log::Log4perl](https://metacpan.org/pod/Log%3A%3ALog4perl)
- [Safe](https://metacpan.org/pod/Safe)
- [XML::Simple](https://metacpan.org/pod/XML%3A%3ASimple)
- [DBI](https://metacpan.org/pod/DBI)
- [Data::Dumper](https://metacpan.org/pod/Data%3A%3ADumper)
- [Carp](https://metacpan.org/pod/Carp)
- [File::Slurp](https://metacpan.org/pod/File%3A%3ASlurp)
- [Data::UUID](https://metacpan.org/pod/Data%3A%3AUUID)

## DEPENDENCIES FOR THE EXAMPLE APPLICATION

- [CGI](https://metacpan.org/pod/CGI)
- [CGI::Cookie](https://metacpan.org/pod/CGI%3A%3ACookie)
- [DBD::SQLite](https://metacpan.org/pod/DBD%3A%3ASQLite)
- [HTTP::Daemon](https://metacpan.org/pod/HTTP%3A%3ADaemon)
- [HTTP::Request](https://metacpan.org/pod/HTTP%3A%3ARequest)
- [HTTP::Response](https://metacpan.org/pod/HTTP%3A%3AResponse)
- [HTTP::Status](https://metacpan.org/pod/HTTP%3A%3AStatus)
- [Template](https://metacpan.org/pod/Template) (Template Toolkit)

For Win32 systems you can get the Template Toolkit and DBD::SQLite
PPDs from TheoryX:

- [http://theoryx5.uwinnipeg.ca/cgi-bin/ppmserver?urn:/PPMServer58](http://theoryx5.uwinnipeg.ca/cgi-bin/ppmserver?urn:/PPMServer58)
The full list of dependencies is specified in the cpanfile in the distribution
archive. Additional dependencies are listed by feature. The following features
are currently supported by this distribution:

- `examples`

The additional dependencies required to run the example applications.

# INCOMPATIBILITIES

Expand Down
12 changes: 6 additions & 6 deletions lib/Workflow.pm
Original file line number Diff line number Diff line change
Expand Up @@ -1052,18 +1052,18 @@ Unless otherwise noted, properties are B<read-only>.
Some properties are set in the configuration file for each
workflow. These remain static once the workflow is instantiated.
B<type>
=head4 B<type>
Type of workflow this is. You may have many individual workflows
associated with a type or you may have many different types
running in a single workflow engine.
B<description>
=head4 B<description>
Description (usually brief, hopefully with a URL...) of this
workflow.
B<time_zone>
=head4 B<time_zone>
Workflow uses the DateTime module to create all date objects. The time_zone
parameter allows you to pass a time zone value directly to the DateTime
Expand All @@ -1074,17 +1074,17 @@ See the DateTime module for acceptable values.
You can get the following properties from any workflow object.
B<id>
=head4 B<id>
ID of this workflow. This will B<always> be defined, since when the
L<Workflow::Factory> creates a new workflow it first saves it to
long-term storage.
B<state>
=head4 B<state>
The current state of the workflow.
B<last_update> (read-write)
=head4 B<last_update> (read-write)
Date of the workflow's last update.
Expand Down

0 comments on commit 7edcc7a

Please sign in to comment.