You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: manual/extended/notelist.rst
+100-61
Original file line number
Diff line number
Diff line change
@@ -29,8 +29,9 @@ Installation via Composer
29
29
Prerequisites for installation:
30
30
31
31
* PHP 7.x
32
-
* Contao 3.5.x
33
-
* MetaModels core dev-hotfix/2.0.0-alpha16 (b326aed1) und DCG 2.0.0-beta39
32
+
* Contao 3.5.x or Contao 4.4.x
33
+
* MetaModels from core 2.0.0-alpha16 respecively 2.1 and DCG 2.0.0-beta39
34
+
* (Zip file of the extension, pls send a request to [email protected])
34
35
35
36
In the package manager type `metamodels/notelist` into the search field, then install and update the database.
36
37
@@ -40,29 +41,28 @@ Create a watch list
40
41
41
42
After you have successfully installed watch list, you will see a new icon in the row of metaModels icons. Click on it to set up and edit watch lists.
42
43
43
-
|img_notelist_icon|
44
+
|img_notelist_icon_en|
44
45
45
46
When you create a new watch list choose a name first.
46
47
At the moment you can select the PHP session or Contao session as "storage adapter".
47
-
48
48
If you select Contao session, the values of a watch list of logged in users will automatically be saved in the session values of the database. They are made available again, when the user logs in again.
49
49
50
50
You can restrict the recording of data records to only records with certain properties, e.g. the "department" or particular member groups with the filter selection. Filtering for member groups is possible by using the following extension "`condition membergroup filter
Via the list view you'll get access to all watch lists that have been set up.
56
56
57
-
|img_notelist_overview|
57
+
|img_notelist_overview_en|
58
58
59
59
60
60
Activate watch list in MetaModels list
61
61
--------------------------------------
62
62
63
63
You will find a new section called "note list" in the CE MetaModels list, respectively in the FE module, where you can activate one or more of the watch lists, which you have set up.
64
64
65
-
|img_notelist_ce_mm-list|
65
+
|img_notelist_ce_mm-list_en|
66
66
67
67
You can change the order of the "action outputs" by drag & drop via the watch list sorting.
68
68
@@ -76,7 +76,7 @@ The links are available in the `action` node and can be output with the followin
@@ -86,17 +86,17 @@ You can output the watch list on the front end with a normal MetaModels list, wh
86
86
87
87
To be able to filter you just need to create a filter with the new filter setting "Notelist". In the filter settings just select the watch list with the elements you'd like to output.
88
88
89
-
|img_notelist_filterrule|
89
+
|img_notelist_filterrule_en|
90
90
91
91
In the filtered list on the front end you should now see only employees from the watch list.
92
92
93
-
|img_notelist_filtered_list|
93
+
|img_notelist_filtered_list_en|
94
94
95
95
In the list view it would be e.g. possible to activate a second watch list, to transfer elements from one watch list to another - e.g. from a "like" list to an "order" list.
96
96
97
97
In the settings for a watch list you can optionally set a filter for the inclusion onto a watch list. E.g if there are only employees allowed who belong to the sales department, the list looks as folllows:
98
98
99
-
|img_notelist_fe_list_with_filter|
99
+
|img_notelist_fe_list_with_filter_en|
100
100
101
101
102
102
Data display and inclusion into the form
@@ -105,23 +105,46 @@ Data display and inclusion into the form
105
105
There is also a new widget `MetaModels note list` available in the form generator. With its settings you can control the display in the form as well as in the email.
106
106
107
107
You can activate one or more watch lists and select a render setting for the FE output as well as for the email output.
108
+
Additionally, by checking the checkbox "clear list", you can define for each watch list whether the list should be cleared after the form processing.
109
+
110
+
|img_nodelist_form_widget_en|
111
+
112
+
„Custom email template“ is an optional template which contains all renderings of the mail output of a watch list and "encloses" them.
113
+
Please note that you have to specify the extension "text2 for " Supported template formats" in the Contao settings!
114
+
Watch list data can only be sent as (plain) text in an email at the moment - the render setting "output format" for the listing within the email has to be set to "text" respectively.
115
+
116
+
In the form the respective data records are output with the selected render setting.
117
+
118
+
119
+
|img_nodelist_form_fe_list_en|
108
120
109
-
|img_nodelist_form_widget|
121
+
It is not possible e.g. to delete elements of the watch list within the form, because by reloading the page all the data already entered in the form would be lost .
110
122
111
-
The respective data records are output in the form with the possibility to delete the whole list or individual items.
123
+
You can output a list with all elements of the watch list before you output the form. There you could edit theme seprately or delete the whole list.
112
124
113
-
|img_nodelist_form_fe_list|
125
+
.. code-block:: html
126
+
:linenos:
127
+
128
+
<p><ahref="de/metamodels/note-list-contact-form.html?notelist_2_action=clear">Clear List 2</a></p></a>
129
+
130
+
|img_nodelist_form_fe_list_edit_items_en|
114
131
115
132
Data is sent by email and output can be customized with the email template. The Contao form options or the Notification Center are available to you for transmission.
116
133
117
-
|img_notelist_email_list|
134
+
|img_notelist_email_list_en|
118
135
119
136
120
-
Known Issues and Next Features
121
-
------------------------------
137
+
Transfer of additional data for each item
138
+
-----------------------------------------
139
+
140
+
Optionally you can transfer additional data to the watchlist for each item, such as a number, tet or similar. To do this you'll have to create a form using the form generator, which contains the fields to display, e.g. field for a number and text field for a short information text - a submit button is not necessary and will be generated automatically.
141
+
142
+
This form will then be available in the watchlist settings - forms which already contain a watchlist formelement wll not be displayed (recursion!).
143
+
144
+
In the list view the form will be displayed with an "add/edit button" beneath each item. Data will be processed with the form and e.g. sent by email.
145
+
146
+
|img_notelist_fe_list_with_form_en|
122
147
123
-
* after sending the form the elements are not removed from the watch list
124
-
* optional specification of a number per watchlist item is missing
125
148
126
149
127
150
InsertTags
@@ -130,9 +153,9 @@ InsertTags
130
153
There are different InsertTags implemented for the output of the number of items in the watch lists. They output the number as follows ('mm_mitarbeiterliste'
131
154
is the respective MetaModels):
132
155
133
-
* Number of all items: {{metamodels_notelist::sum::mm_mitarbeiterliste}}
134
-
* Number of all items of the watch list with ID 1: {{metamodels_notelist::sum::mm_mitarbeiterliste::1}}
135
-
* Number of all items of the watch list with ID 1 and 2: {{metamodels_notelist::sum::mm_mitarbeiterliste::1,2}}
156
+
* Number of all items: {{metamodels_notelist::sum::mm_employeelist}}
157
+
* Number of all items of the watch list with ID 1: {{metamodels_notelist::sum::mm_employeelist::1}}
158
+
* Number of all items of the watch list with ID 1 and 2: {{metamodels_notelist::sum::mm_employeelist::1,2}}
136
159
137
160
If there is no item on the watch list, 0 (Null) will be output.
138
161
@@ -150,34 +173,38 @@ As an example for a feedback you can insert the following code to a custom Conta
150
173
:linenos:
151
174
152
175
<?php
153
-
154
-
use MetaModels\NoteList\Event\ManipulateNoteListEvent;
155
-
use MetaModels\NoteList\Event\NoteListEvents;
156
-
157
-
return [
158
-
NoteListEvents::MANIPULATE_NOTE_LIST => [
159
-
function (ManipulateNoteListEvent $event) {
160
-
// Only handle note list "1".
161
-
if ('1' !== ($listId = $event->getNoteList()->getStorageKey())) {
162
-
return;
163
-
}
164
-
165
-
switch ($event->getOperation()) {
166
-
case ManipulateNoteListEvent::OPERATION_ADD:
167
-
Message::addConfirmation('Added ' . $event->getItem()->get('id') . ' to ' . $listId);
168
-
break;
169
-
case ManipulateNoteListEvent::OPERATION_REMOVE:
170
-
Message::addConfirmation('Removed ' . $event->getItem()->get('id') . ' to ' . $listId);
171
-
break;
172
-
case ManipulateNoteListEvent::OPERATION_CLEAR:
173
-
Message::addConfirmation('Cleared ' . $listId);
174
-
break;
175
-
default:
176
-
throw new \RuntimeException('Unknown note list operation: ' . $event->getOperation());
177
-
}
178
-
}
179
-
]
180
-
];
176
+
177
+
use MetaModels\NoteList\Event\ManipulateNoteListEvent;
178
+
use MetaModels\NoteList\Event\NoteListEvents;
179
+
180
+
return [
181
+
NoteListEvents::MANIPULATE_NOTE_LIST => [
182
+
function (ManipulateNoteListEvent $event) {
183
+
// Only handle note list "1".
184
+
if ('1' !== ($listId = $event->getNoteList()->getStorageKey())) {
185
+
return;
186
+
}
187
+
188
+
switch ($event->getOperation()) {
189
+
case ManipulateNoteListEvent::OPERATION_ADD:
190
+
Message::addConfirmation('Added ' . $event->getItem()->get('id') . ' to ' . $listId);
0 commit comments