Action subplugins

Actions are used to perform operations on Moodle users that enter a workflow step. Actions are always executed at the moment a user enters the workflow step the action is part of.

They are implemented as small subplugins and can therefore be easily extended by your own institution-specific actions.

Overview

Overview reduced for clarity

For clarity, the following overview diagram is reduced to the most important classes and members. Therefore, some details like methods, parameters, or members are omitted. Please refer to the plugin source code for a complete reference.

classDiagram
    direction TB

    %% Main classes
    class step_subplugin {
        <<abstract>>
        #id: int
        #step: step

        +get_instance_id()$ int
        +get_step() step
        +get_instance_title() string
        +get_instance_details() string
        +is_valid() bool
    }

    class userdeleteaction {
        <<abstract>>

        +get_instance_by_id(instanceid: int)$ self
        +create_instance(step: step, pluginname: string, settings: array)$ self
        +delete() void
        +get_plugin_type()$ subplugin_type
        +get_icon_class()$ string

    }

    class userdeleteaction_myfoo {
        +get_plugin_name()$ string
        +instance_setting_descriptors()$ array
        +execute(process: process) bool
    }

    %% Supporting classes
    class subplugin_instance_settings {
        <<trait>>

        +get_all_instance_settings() array
        +get_instance_setting(key: string) mixed
        +set_instance_setting(key: string, value: mixed) void
        +load_default_instance_settings(overrides: array) void
        +validate_instance_settings_data(data: array) array
    }

    class process {
        #id: int
        #userid: int
        #workflowid: int
        #stepid: int
        #state: process_state
        #timecreated: int
        #timemodified: int
    }

    class user {
    }

    class step {
    }

    class workflow {
    }

    %% Relationships
    userdeleteaction_myfoo --|> userdeleteaction
    userdeleteaction_myfoo --> process
    userdeleteaction --|> step_subplugin
    step_subplugin ..> subplugin_instance_settings
    process --> user
    process --> step
    process --> workflow

    %% Style
    style user fill:#dedede,stroke:#666666
    style step fill:#dedede,stroke:#666666
    style workflow fill:#dedede,stroke:#666666
    style process fill:#dedede,stroke:#666666
    style subplugin_instance_settings fill:#dedede,stroke:#666666
    style step_subplugin fill:#dedede,stroke:#666666
    style userdeleteaction fill:#dedede,stroke:#666666

Hold "Shift" to enable pan & zoom

Implementation

All action subplugins must use the userdeleteaction frankenstyle plugin type and extend the abstract \tool_userautodelete\userdeleteaction base class.

Any action subplugin must implement the following methods:

1. get_plugin_name(): string
2. execute(process: process): void
3. instance_setting_descriptors(): array (see also: instance settings)

Of course you can also override other methods like get_instance_details(): string or get_icon_class(): string to further customize the behavior of your action subplugin and how it displays within the UI.

PHPDocs are the ground source of truth

Please refer to the PHPDocs in the source code as the ground source of truth for detailed information regarding the implementation of these methods and their expected behavior.

Example action subplugin implementations

You can find many examples of action subplugins directly within action/.