PHP Class HM\BackUpWordPress\Database_Backup_Engine

All Database Backup Engine implementations should extend this class

Inheritance: extends Backup_Engine

Public Properties

Property	Type	Description
$backup_filename	string	The filename for the resulting Backup

Method	Description
__construct ( )	Setup some general database backup settings
backup ( ) : boolean	Individual Database Backup Engine implementations must include a backup method at a minimum.
get_charset ( ) : string	Get the database charset setting.
get_collate ( ) : string	Get the database collate setting.
get_host ( ) : string	Get the database hostname.
get_name ( ) : string	Get the database name.
get_password ( ) : string	Get the database password.
get_port ( ) : integer	Get the database port.
get_socket ( ) : string	Get the database socket.
get_user ( ) : string	Get the database user.
parse_db_host_constant ( string $constant = 'DB_HOST' )	Parse the DB_HOST constant.
verify_backup ( ) : boolean	Verify that the database backup was successful.

Child classes must call parent::__construct in their own constructor.

public __construct ( )

Individual Database Backup Engine implementations must include a backup method at a minimum.

abstract public backup ( ) : boolean
return	boolean	Whether the backup completed successfully or not.

Get the database charset setting.

public get_charset ( ) : string
return	string	The database charset.

Get the database collate setting.

public get_collate ( ) : string
return	string	The database collage setting.

Get the database hostname.

public get_host ( ) : string
return	string	The database hostname.

Get the database name.

public get_name ( ) : string
return	string	The database name.

Get the database password.

public get_password ( ) : string
return	string	The database password.

Get the database port.

public get_port ( ) : integer
return	integer	The database port.

Get the database socket.

public get_socket ( ) : string
return	string	The database socket.

Get the database user.

public get_user ( ) : string
return	string	The database user.

The DB_HOST constant potentially contains the hostname, port or socket. We need to parse it to figure out the type of mysql connection to make.

public parse_db_host_constant ( string $constant = 'DB_HOST' )
$constant	string	The Constant to parse. If the string isn't a defined Constant then it will be parsed directly.

It's important this function is performant as it's called after every backup.

public verify_backup ( ) : boolean
return	boolean	Whether the backup completed successfully

The filename for the resulting Backup

public string $backup_filename
return	string