PHP Class HM\BackUpWordPress\Email_Service

Inheritance: extends HM\BackUpWordPress\Service
Show file Open project: humanmade/backupwordpress

Public Properties

Property Type Description
$name string Human readable name for this service

Public Methods

Method Description
action ( string $action, Backup $backup ) Fire the email notification on the hmbkp_backup_complete
constant ( )
display ( ) : string The sentence fragment that is output as part of the schedule sentence
field ( ) Output the email form field
form ( ) : string Not used as we only need a field
intercom_data ( )
intercom_data_html ( )
is_service_active ( ) Used to determine if the service is in use or not
update ( &$new_data, array $old_data ) : array | null Validate the email and return an error if validation fails

Private Methods

Method Description
get_email_address_array ( ) : array Get an array or validated email address's

Method Details

action() public method

Fire the email notification on the hmbkp_backup_complete
See also: Backup::do_action
public action ( string $action, Backup $backup )
$action string The action received from the backup
$backup Backup

constant() public static method

public static constant ( )

display() public method

The sentence fragment that is output as part of the schedule sentence
public display ( ) : string
return string

field() public method

Output the email form field
public field ( )

form() public method

Not used as we only need a field
See also: field
public form ( ) : string
return string Empty string

intercom_data() public static method

public static intercom_data ( )

intercom_data_html() public static method

public static intercom_data_html ( )

is_service_active() public method

Used to determine if the service is in use or not
public is_service_active ( )

update() public method

Validate the email and return an error if validation fails
public update ( &$new_data, array $old_data ) : array | null
$old_data array The data we are replacing.
return array | null Null on success, array of errors if validation failed.

Property Details

$name public property

Human readable name for this service
public string $name
return string