Skip to content

Commit

Permalink
Screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
SanderHamaka committed Sep 13, 2022
1 parent 8d34327 commit e5b5adb
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,30 @@ Silverstripe 4+
composer require "hamaka/silverstripe-taskforms"
```

## Features
* Adds some basic CSS to task output.
* Adds utility methods to give colour to alteration messages (echoGood, echoNotice, echoError etc).
* Adds a pattern to generate a simple form to populate variable input (an array of variables is turned into a form).
* Adds a way to block execution when not all required input is present.
* The default textfields in the form can be overruled with more complex Silverstripe FormFields.
* Adds a pattern to be able to force a dry run of the task before execution.
* Adds utility method to dump array output as a table.
* Overrides the default Silverstripe TaskRunner to allow /dev/tasks to be organized in categories. Categories can be added with TaskCategoryProviders in the same way Silverstripe PermissionProvider works.

## Usage
See ExampleTask.php

## Screenshots
![](/docs/images/screen_tasks_categories.jpg?raw=true "/dev/tasks can be organized with categories")

![](/docs/images/screen_task_simple_form.jpg?raw=true "Add a pattern to generate a simple form to populate variable input (an array of variables is turned into a form)")

![](/docs/images/screen_task_dry_run.jpg?raw=true "Add a pattern to be able to force a dry run of the task before execution")

![](/docs/images/screen_task_table.jpg?raw=true "Adds utility method to dump array output as a table")

PS. Who doesn't like confetti to celebrate a job well done?

## License
See [License](license.md)

Expand Down
Binary file added docs/images/screen_task_dry_run.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/screen_task_simple_form.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/screen_task_table.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/screen_tasks_categories.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e5b5adb

Please sign in to comment.