ILIAS  release_7 Revision v7.30-3-g800a261c036
Interruptive.php
Go to the documentation of this file.
1<?php
2
4
10interface Interruptive extends Modal
11{
12
18 public function getMessage();
19
20
26 public function getTitle();
27
28
36 public function withFormAction($form_action);
37
38
47 public function withAffectedItems(array $items);
48
49
55 public function getActionButtonLabel();
56
64 public function withActionButtonLabel(string $action_label) : Interruptive;
65
66
72 public function getCancelButtonLabel();
73
81 public function withCancelButtonLabel(string $cancel_label) : Interruptive;
82
83
89 public function getAffectedItems();
90
91
97 public function getFormAction();
98}
An exception for terminatinating execution or to throw for unit testing.
getCancelButtonLabel()
Get the label of the cancel button in the footer.
getFormAction()
Get the form action where the action button is sending the IDs of the affected items.
getActionButtonLabel()
Get the label of the action button in the footer.
getMessage()
Get the message of this modal, displayed below the modals title.
withCancelButtonLabel(string $cancel_label)
Get a modal like this with the cancel button labeled according to the parameter.
withFormAction($form_action)
Get a modal like this submitting the form to the given form action.
withAffectedItems(array $items)
Get a modal like this listing the given items in the content section below the message.
withActionButtonLabel(string $action_label)
Get a modal like this with the action button labeled according to the parameter.
getAffectedItems()
Return the affected items listed in the content by this modal.
getTitle()
Get the title of this modal.
This describes commonalities between the different modals.
Definition: Modal.php:14