Note: This documentation is for Moodle 2.7. For up-to-date documentation see Dataform System events.

Dataform System events: Difference between revisions

From MoodleDocs
No edit summary
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Dataform}}
{{Dataform}}
{{Dataform Docs Note 1}}


The Dataform system events are triggered, with attached data during the activity, at moments that may be of interest and worth capturing for various purposes from other modules.
The Dataform system events are triggered with attached data during the activity, at moments that may be of interest and worth capturing for various purposes (e.g. logging, notifications). You can capture these events in your existing custom module or create a designated plugin (e.g. block, local) for that.


==Entry events==
Add-on views and fields may provide further event triggers.
*[[Events/mod/dataform/Entry created|Entry created]] – Triggered when an entry is added to the activity.
*[[Events/mod/dataform/Entry updated|Entry updated]] – Triggered when entry content is updated.
*[[Events/mod/dataform/Entry deleted|Entry deleted]] – Triggered when an entry is deleted.


==Field events==
==Activity==
*[[Events/mod/dataform/Field updated|Field updated]] – Triggered when an entry field is updated (content change).
<!--
*[[Events/mod/dataform/Comment added|Comment added]] – Triggered when a comment is added to an entry (a special case of the Field update event).
{| class="nicetable"  style="background-color:inherit;" 
*[[Events/mod/dataform/Rating added|Rating added]] – Triggered when a rating is added to an entry (a special case of the Field update event).
{{ Dataform system event table row |  | course_module_viewed | The activity has been displayed. }}
{{ Dataform system event table row |  | course_module_instance_list_viewed | The Dataform index has been viewed. }}
|}
-->


==View==
{| class="nicetable"  style="background-color:inherit;" 
{{Dataform system event table row |  | view_created | A view has been added to the activity. }}
{{Dataform system event table row |  | view_updated | A view has been updated in the activity. }}
{{Dataform system event table row |  | view_deleted | A view has been deleted from the activity. }}
{{Dataform system event table row |  | view_viewed | A view has been displayed. }}
|}
==Field==
{| class="nicetable"  style="background-color:inherit;" 
{{Dataform system event table row |  | field_created | A field has been added to the activity. }}
{{Dataform system event table row |  | field_updated | A field has been updated in the activity. }}
{{Dataform system event table row |  | field_deleted | A field has been deleted from the activity. }}
{{Dataform system event table row |  | field_content_updated | The entry content of a field has been updated. }}
|}
==Filter==
{| class="nicetable"  style="background-color:inherit;" 
{{Dataform system event table row |  | filter_created | A filter has been added to the activity. }}
{{Dataform system event table row |  | filter_updated | A filter has been updated in the activity. }}
{{Dataform system event table row |  | filter_deleted | A filter has been deleted from the activity. }}
|}
==Entry==
{| class="nicetable"  style="background-color:inherit;" 
{{Dataform system event table row |  | entry_created | An entry has been added to the activity. }}
{{Dataform system event table row |  | entry_updated | An entry has been updated in the activity. }}
{{Dataform system event table row |  | entry_deleted | An entry has been deleted from the activity. }}
|}
==Other==
{| class="nicetable"  style="background-color:inherit;" 
{{Dataform system event table row |  | comment_created | A comment has been added to an entry in the activity. }}
{{Dataform system event table row |  | comment_deleted | A comment has been deleted from an entry in the activity. }}
{{Dataform system event table row |  | rating_created | A rating has been added to an entry in the activity. }}
{{Dataform system event table row |  | rating_deleted | A rating has been deleted from an entry in the activity. }}
|}
==See also==
==See also==
[https://docs.moodle.org/dev/Event_2 Event 2]
[https://docs.moodle.org/dev/Event_2 Event 2]

Revision as of 00:55, 8 April 2014


The Dataform system events are triggered with attached data during the activity, at moments that may be of interest and worth capturing for various purposes (e.g. logging, notifications). You can capture these events in your existing custom module or create a designated plugin (e.g. block, local) for that.

Add-on views and fields may provide further event triggers.

Activity

View

view_created

A view has been added to the activity.

view_updated

A view has been updated in the activity.

view_deleted

A view has been deleted from the activity.

view_viewed

A view has been displayed.

Field

field_created

A field has been added to the activity.

field_updated

A field has been updated in the activity.

field_deleted

A field has been deleted from the activity.

field_content_updated

The entry content of a field has been updated.

Filter

filter_created

A filter has been added to the activity.

filter_updated

A filter has been updated in the activity.

filter_deleted

A filter has been deleted from the activity.

Entry

entry_created

An entry has been added to the activity.

entry_updated

An entry has been updated in the activity.

entry_deleted

An entry has been deleted from the activity.

Other

comment_created

A comment has been added to an entry in the activity.

comment_deleted

A comment has been deleted from an entry in the activity.

rating_created

A rating has been added to an entry in the activity.

rating_deleted

A rating has been deleted from an entry in the activity.

See also

Event 2