Changes between Version 4 and Version 5 of AppFiltering

Timestamp:

Mar 4, 2014, 11:55:51 AM (10 years ago)

Author:

davea

Comment:

--

AppFiltering

@@ -1 @@
-= Application filtering =
+= User app selection =
 
 You can allow users to select which applications they will receive work for
 (by default, they may receive work for any application).
 
-This information is stored in the [ProjectSpecificPrefs project-specific preferences].
+Each user's list of selected apps is stored in the [ProjectSpecificPrefs project-specific preferences].
+This is stored in the user.project_specific_prefs database field.
 Each 'allowed' application is represented by an element {{{<app_id>N</app_id>}}},
 where N is the database ID of the application.
 If no {{{<app_id>}}} elements are present, the user may be sent work for any application.
 
-The sample PHP file for project-specific preferences
-supports application selection, but it is commented out by default:
+This feature is disabled by default.
+To enable it, edit your html/project/project_specific_prefs.inc to contain
 {{{
-if (false) {
-    $app_array = array(
-        array(1, "Application one"),
-        array(2, "Application two"),
-    );
-} else {
-    $app_array = null;
-}
+define ('APP_SELECT_PREFS', true);
 }}}
 
-To enable it, change the 'false' to 'true',
-and add your own list of application IDs and names.
+== Adding a new app ==
 
-If you use application filtering,
-be aware that currently there is no easy way to cancel it:
+When you add a new app, it won't be sent to any users who have selected apps.
+You can change this (i.e. add the new app to the prefs of users who have selected apps)
+by running
+{{{
+app_select_edit.php ID
+}}}
+in your html/ops directory (where ID is the database ID of the new app).
+
+== Warning ==
+
+Once you use application filtering,
+currently there is no easy way to cancel it:
 users who have non-empty app lists will continue to
 be filtered even if you remove app filtering from your PHP code.