tatter / workflows
Job task control through dynamic workflows, for CodeIgniter 4
Fund package maintenance!
tattersoftware
paypal.me/tatter
Installs: 1 621
Dependents: 0
Suggesters: 0
Security: 0
Stars: 21
Watchers: 4
Forks: 6
Open Issues: 3
Requires
- php: ^7.4 || ^8.0
- codeigniter4/authentication-implementation: 1.0
- npm-asset/sortablejs: ^1.10
- tatter/audits: ^1.0
- tatter/frontend: ^1.0
- tatter/handlers: ^3.0
- tatter/users: ^1.0
Requires (Dev)
- codeigniter4/framework: ^4.1
- tatter/imposter: ^1.0
- tatter/tools: ^2.0
- dev-develop
- v5.0.0-rc.1
- v5.0.0-beta.2
- v5.0.0-beta.1
- v4.1.0
- v4.0.10
- v4.0.9
- v4.0.8
- v4.0.7
- v4.0.6
- v4.0.5
- v4.0.4
- v4.0.3
- v4.0.2
- v4.0.1
- v4.0.0
- v3.3.0
- v3.2.2
- v3.2.1
- v3.2.0
- v3.1.2
- v3.1.1
- v3.1.0
- v3.0.2
- v3.0.1
- v2.0.1
- v2.0.0
- v1.1.1
- v1.1.0
- v1.0.1
- v1.0.0
- v0.8.3
- v0.8.2
- v0.8.1
- v0.8.0
- dev-dependabot/github_actions/actions/cache-4
- dev-master
This package is auto-updated.
Last update: 2024-10-18 16:59:56 UTC
README
Job action control through dynamic workflows, for CodeIgniter 4
Quick Start
- Install with Composer:
> composer require tatter/workflows
- Update the database:
> php spark migrate -all
- Register actions:
> php spark actions:register
- Start your first workflow: https://[yourdomain.com]/workflows
Features
Workflows functions as a super-controller for CodeIgniter 4, allowing developers to write their own actions as classes and then string them together for job flow controls.
Installation
Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities and always be up-to-date:
> composer require tatter/workflows
Or, install manually by downloading the source files and adding the directory to app/Config/Autoload.php.
Once the files are downloaded and included in the autoload, run any library migrations to ensure the database is setup correctly:
> php spark migrate -all
Configuration (optional)
The library's default behavior can be altered by extending its config file. Copy examples/Workflows.php to app/Config/ and follow the instructions in the comments. If no config file is found in app/Config/ the library will use its own.
Workflows uses Tatter\Users to
work with user records. Follow the instructions to verify you have a compatible authentication
library with classes that implement the UserEntity
and HasPermission
interfaces.
Usage
The CLI command spark actions:list
will search all namespaces for valid action files
and display them. Action files are identified as follows:
- Located in the Actions subfolder within the root of a namespace
- Extends
Tatter\Workflows\BaseAction
- Supplies a unique
HANDLER_ID
and descriptiveATTRIBUTES
class constants
You may write your own actions or import them from existing packages. Once actions are
available you can create workflows from a series of those actions by visiting the
/workflows
route.
Job control
Runner.php is the central controller that handles job flow. By default this intercepts
routes that match /jobs/
, but this can be changed in the config file.
Action permissions
You may limit access to individual Actions using the role
attribute of its definition.
By default an empty role
is available to everyone. Actions will use the UserEntity
with HasPermission
interface to test for allowed users.
Logging
Jobs track their activity through two supplemental database tables and their entities.
Joblogs
are created automatically any time a job changes stages, and will record:
- The stage the job leaves (
null
for new jobs) - The stage the job enters (
null
for completed jobs) - The ID of the current user (if available)
- The timestamp of the activity
Since jobs may progress and regress through a stage multiple times, Joblogs
are not
a good indicator of status. Jobflags
are set by the developer and represent a definitive
job state. A flag is a string key and CodeIgniter\I18n\Time
timestamp value. Flags are
managed from the Job
entity methods:
getFlags(): array
getFlag($name): Time
setFlag($name)
clearFlag($name)
clearFlags()
For example, an Action
may require a user to accept the "Terms of Service" agreement
before proceeding. Its code may look like this:
public function get() { if (! $this->job->getFlag('accepted')) { return $this->render('accept_form'); } // Null returns indicate "Action complete" return null; } public function post() { $this->job->setFlag('accepted'); return null; }