contsructs a new MultiPersonSearch object.
- Parameters
-
string | name of the object and html ids |
addQuickfilter |
( |
|
$title, |
|
|
|
$userArray |
|
) |
| |
adds a new quickfilter.
- Parameters
-
string | $title | title of the new quickfilter |
array | $userArray | containing all user-ids belonging to the quickfilter |
- Returns
- MultiPersonSearch
returns the newly added persons. The array will contain all persons which are selected (on the right side of the dialog) but without the defaultSelectedUsers.
- Returns
- array containing all new persons
getAdditionalOptionArray |
( |
| ) |
|
returns an additional option array.
- Returns
- string html code
returns html code which will be shown inside the form element.
- Returns
- string html code
returns if data-dialog is enabled or disabled
- Returns
- bool
getDefaultSelectableUsersIDs |
( |
| ) |
|
returns the ids of defaultselectable users.
- Returns
- array
getDefaultSelectedUsersIDs |
( |
| ) |
|
returns the ids of defaultselected users.
- Returns
- array
returns the description.
- Returns
- string
returns the action which will handle the added and removed persons after saving the dialog.
- Returns
- string action which will handle the form data.
getJSFunctionOnSubmit |
( |
| ) |
|
returns a JavaScript-function which should be fired when the user has pressed the submit button.
- Returns
- string function name
returns the icon of the link to open the dialog.
- Returns
- string path ot the icon.
returns the link text of the link.
- Returns
- string text of the link.
returns the navigation item.
- Returns
- string
returns the url of the page where the GUI element is added.
- Returns
- string
returns the ids of quickfilters.
- Returns
- array
returns the removed persons. The array will contain all persons which were selected by default (on the right side of the dialog) and then removed by the user.
- Returns
- array containing all removed persons
returns the title.
- Returns
- string
render |
( |
|
$with_link_text = true | ) |
|
renders a link to open the multipersonsearch dialog.
- Parameters
-
string | $with_link_text | include link text in output |
restores the internal data from a session.
saveAddedUsersToSession |
( |
| ) |
|
saves the added persons to $_SESSION.
saveRemovedUsersToSession |
( |
| ) |
|
saves the removed persons to $_SESSION.
setAdditionalHTML |
( |
|
$html | ) |
|
sets html code which will be shown inside the form element.
- Parameters
-
- Returns
- MultiPersonSearch
setDataDialogStatus |
( |
|
$status | ) |
|
enables or disabled data-dialog
- Parameters
-
- Returns
- $this
setDefaultSelectableUser |
( |
|
$userArray | ) |
|
sets the persons which will be shown as selectable by default on the left side of the dialoag.
- Parameters
-
array | array containing user-ids |
setDefaultSelectedUser |
( |
|
$userArray | ) |
|
sets the persons which will be shown as selected by default on the right side of the dialoag.
- Parameters
-
array | array containing user-ids |
sets the description of the dialog.
- Parameters
-
string | $desc | description of the dialog |
- Returns
- MultiPersonSearch
sets the action which will handle the added and removed persons after saving the dialog.
- Parameters
-
- Returns
- MultiPersonSearch
setJSFunctionOnSubmit |
( |
|
$function_name | ) |
|
sets a JavaScript-function to be fired when the user has pressed the submit-button. Arguments are: function fireme(id_of_item, text_of_item) example setting: MPS->setJSFunctionOnSubmit('fireme');
- Parameters
-
string | $function_name | the name of the javascript function |
- Returns
- MultiPersonSearch
sets the icon of the link to open the dialog. To hide the icon an empty string can be set.
- Parameters
-
- Returns
- MultiPersonSearch
setLinkText |
( |
|
$text = "" | ) |
|
sets the link text of the link to open the dialog. To hide the text an empty string can be set.
- Parameters
-
- Returns
- MultiPersonSearch
setNavigationItem |
( |
|
$navigationItem | ) |
|
sets the navigation item.
- Parameters
-
string | $navigationItem | navigation item |
- Returns
- MultiPersonSearch
setSearchObject |
( |
|
$searchType | ) |
|
sets the title of the dialog.
- Parameters
-
string | $title | title of the dialog |
- Returns
- MultiPersonSearch
stores the internal data to a session.
The documentation for this class was generated from the following file: