PHP Class Spatie\DbDumper\DbDumper

Show file Open project: spatie/db-dumper

Protected Properties

Property	Type	Description
$dbName	string
$dumpBinaryPath	string
$excludeTables	array
$extraOptions	array
$host	string
$includeTables	array
$password	string
$port	integer
$socket	string
$timeout	integer
$userName	string

Public Methods

Method	Description
addExtraOption ( string $extraOption )
create ( )
dumpToFile ( string $dumpFile )
excludeTables ( string \| array $excludeTables )
getDbName ( ) : string
getHost ( ) : string
includeTables ( string \| array $includeTables )
setDbName ( string $dbName )
setDumpBinaryPath ( string $dumpBinaryPath )
setHost ( string $host )
setPassword ( string $password )
setPort ( integer $port )
setSocket ( string $socket )
setTimeout ( integer $timeout )
setUserName ( string $userName )

Protected Methods

Method	Description
checkIfDumpWasSuccessFul ( Process $process, string $outputFile )

Method Details

addExtraOption() public method

public addExtraOption ( string $extraOption )
$extraOption	string

checkIfDumpWasSuccessFul() protected method

protected checkIfDumpWasSuccessFul ( Process $process, string $outputFile )
$process	Symfony\Component\Process\Process
$outputFile	string

create() public static method

public static create ( )

dumpToFile() abstract public method

abstract public dumpToFile ( string $dumpFile )
$dumpFile	string

excludeTables() public method

public excludeTables ( string \| array $excludeTables )
$excludeTables	string \| array

getDbName() public method

public getDbName ( ) : string
return	string

getHost() public method

public getHost ( ) : string
return	string

includeTables() public method

public includeTables ( string \| array $includeTables )
$includeTables	string \| array

setDbName() public method

public setDbName ( string $dbName )
$dbName	string

setDumpBinaryPath() public method

public setDumpBinaryPath ( string $dumpBinaryPath )
$dumpBinaryPath	string

setHost() public method

public setHost ( string $host )
$host	string

setPassword() public method

public setPassword ( string $password )
$password	string

setPort() public method

public setPort ( integer $port )
$port	integer

setSocket() public method

public setSocket ( string $socket )
$socket	string

setTimeout() public method

public setTimeout ( integer $timeout )
$timeout	integer

setUserName() public method

public setUserName ( string $userName )
$userName	string

Property Details

$dbName protected property

protected string $dbName
return	string

$dumpBinaryPath protected property

protected string $dumpBinaryPath
return	string

$excludeTables protected property

protected array $excludeTables
return	array

$extraOptions protected property

protected array $extraOptions
return	array

$host protected property

protected string $host
return	string

$includeTables protected property

protected array $includeTables
return	array

$password protected property

protected string $password
return	string

$port protected property

protected int $port
return	integer

$socket protected property

protected string $socket
return	string

$timeout protected property

protected int $timeout
return	integer

$userName protected property

protected string $userName
return	string