Class: SecretariesHelper

SecretariesHelper

new SecretariesHelper()

This class contains the Secretaries helper class declaration, along with the "Secretaries" tab event handlers. By deviding the backend/users tab functionality into separate files it is easier to maintain the code.
Source:

Methods

bindEventHandlers()

Bind the event handlers for the backend/users "Secretaries" tab.
Source:

delete(id)

Delete a secretary record from database.
Parameters:
Name Type Description
id int Record id to be deleted.
Source:

display(secretary)

Display a secretary record into the admin form.
Parameters:
Name Type Description
secretary object Contains the secretary record data.
Source:

filter(key, selectId, display)

Filters secretary records depending a string key.
Parameters:
Name Type Description
key string This is used to filter the secretary records of the database.
selectId numeric (OPTIONAL = undefined) If provided then the given id will be selected in the filter results (only selected, not displayed).
display bool (OPTIONAL = false)
Source:

getFilterHtml(secretary) → {string}

Get an secretary row html code that is going to be displayed on the filter results list.
Parameters:
Name Type Description
secretary object Contains the secretary record data.
Source:
Returns:
The html code that represents the record on the filter results list.
Type
string

resetForm()

Resets the admin tab form back to its initial state.
Source:

save(secretary)

Save secretary record to database.
Parameters:
Name Type Description
secretary object Contains the admin record data. If an 'id' value is provided then the update operation is going to be executed.
Source:

select(id, display)

Select a specific record from the current filter results. If the secretary id does not exist in the list then no record will be selected.
Parameters:
Name Type Description
id numeric The record id to be selected from the filter results.
display bool (OPTIONAL = false) If true then the method will display the record on the form.
Source:

validate(secretary) → {bool}

Validates a secretary record.
Parameters:
Name Type Description
secretary object Contains the admin data to be validated.
Source:
Returns:
Returns the validation result.
Type
bool