Full ELMS Learning Network documentation
class backup_migrate_filter_statusnotify
- cis7 sites/all/modules/ulmus/backup_migrate/includes/filters.statusnotify.inc backup_migrate_filter_statusnotify
- cle7 sites/all/modules/ulmus/backup_migrate/includes/filters.statusnotify.inc backup_migrate_filter_statusnotify
- elmsmedia7 sites/all/modules/ulmus/backup_migrate/includes/filters.statusnotify.inc backup_migrate_filter_statusnotify
- icor7 sites/all/modules/ulmus/backup_migrate/includes/filters.statusnotify.inc backup_migrate_filter_statusnotify
- meedjum_blog7 sites/all/modules/ulmus/backup_migrate/includes/filters.statusnotify.inc backup_migrate_filter_statusnotify
- mooc7 sites/all/modules/ulmus/backup_migrate/includes/filters.statusnotify.inc backup_migrate_filter_statusnotify
A filter to send a notification email on success or failure of backup.
Hierarchy
Expanded class hierarchy of backup_migrate_filter_statusnotify
Members
Name![]() |
Modifiers | Type | Description |
---|---|---|---|
backup_migrate_filter::backup | function | This function is called on a backup file after the backup has been completed. | |
backup_migrate_filter::backup_settings_form_submit | function | Submit the settings form. Any values returned will be saved. | |
backup_migrate_filter::backup_settings_form_validate | function | Get the form for the settings for this filter. | |
backup_migrate_filter::destinations | function | Declare any default destinations for this filter. | |
backup_migrate_filter::file_types | function | Get a list of file types handled by this filter. | |
backup_migrate_filter::post_backup | function | This function is called immediately post backup. | |
backup_migrate_filter::pre_backup | function | This function is called immediately prior to backup. | |
backup_migrate_filter::restore | function | This function is called on a backup file before importing it. | |
backup_migrate_filter::restore_settings_default | function | Get the form for the settings for this filter. | |
backup_migrate_filter::restore_settings_form | function | Get the form for the settings for this filter. | |
backup_migrate_filter::restore_settings_form_submit | function | Submit the settings form. Any values returned will be saved. | |
backup_migrate_filter::restore_settings_form_validate | function | Get the form for the settings for this filter. | |
backup_migrate_filter::weight | function | Get the weight of the filter for the given op. | |
backup_migrate_filter_statusnotify::backup_fail | function | Send the failure email. | |
backup_migrate_filter_statusnotify::backup_settings_default | function | Get the default backup settings for this filter. Overrides backup_migrate_filter::backup_settings_default | |
backup_migrate_filter_statusnotify::backup_settings_form | function | Get the form for the settings for this filter. Overrides backup_migrate_filter::backup_settings_form | |
backup_migrate_filter_statusnotify::backup_succeed | function | Send the success email. | |
backup_migrate_filter_statusnotify::get_messages | function | Render the messages and errors for the email. |
File
- sites/
all/ modules/ ulmus/ backup_migrate/ includes/ filters.statusnotify.inc, line 14 - A filter for compressing bckups with zip, gz bzip etc.
View source
class backup_migrate_filter_statusnotify extends backup_migrate_filter {
/**
* Get the default backup settings for this filter.
*/
function backup_settings_default() {
return array(
'notify_success_enable' => FALSE,
'notify_failure_enable' => FALSE,
'notify_success_email' => variable_get('site_mail', ''),
'notify_failure_email' => variable_get('site_mail', ''),
);
}
/**
* Get the form for the settings for this filter.
*/
function backup_settings_form($settings) {
$form = array();
$form['advanced']['notify_success_enable'] = array(
"#type" => 'checkbox',
"#title" => t("Send an email if backup succeeds"),
"#default_value" => @$settings['notify_success_enable'],
);
$form['advanced']['notify_success_email'] = array(
"#type" => "textfield",
"#title" => t("Email Address for Success Notices"),
"#default_value" => @$settings['notify_success_email'],
);
$form['advanced']['notify_failure_enable'] = array(
"#type" => 'checkbox',
"#title" => t("Send an email if backup fails"),
"#default_value" => @$settings['notify_failure_enable'],
);
$form['advanced']['notify_failure_email'] = array(
"#type" => "textfield",
"#title" => t("Email Address for Failure Notices"),
"#default_value" => @$settings['notify_failure_email'],
);
return $form;
}
/**
* Send the success email.
*/
function backup_succeed($settings) {
if (@$settings->filters['notify_success_enable'] && $to = @$settings->filters['notify_success_email']) {
$params = array(
'messages' => $this->get_messages(),
);
// Using the default language since this is not specific to a user.
$language = language_default();
drupal_mail('backup_migrate', 'backup_succeed', $settings->filters['notify_success_email'], $language, $params);
}
}
/**
* Send the failure email.
*/
function backup_fail($settings) {
if (@$settings->filters['notify_failure_enable'] && $to = @$settings->filters['notify_failure_email']) {
$params = array(
'messages' => $this->get_messages(),
);
// Using the default language since this is not specific to a user.
$language = language_default();
drupal_mail('backup_migrate', 'backup_fail', $settings->filters['notify_failure_email'], $language, $params);
}
}
/**
* Render the messages and errors for the email.
*/
function get_messages() {
$out = "";
$messages = _backup_migrate_messages();
foreach ($messages as $message) {
$out .= strip_tags(t($message['message'], $message['replace'])) . "\n";
}
return $out;
}
}
1 string reference to 'backup_migrate_filter_statusnotify'
- backup_migrate_backup_migrate_filters in sites/
all/ modules/ ulmus/ backup_migrate/ includes/ filters.inc - Implementation of hook_backup_migrate_filters().