function drush_core_call_rsync

8.0.x rsync.core.inc drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE)
6.x rsync.core.inc drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE)
7.x rsync.core.inc drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE)
3.x rsync.core.inc drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE)
4.x rsync.core.inc drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE)
5.x rsync.core.inc drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE)
master rsync.core.inc drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE)

Make a direct call to rsync after the source and destination paths have been evaluated.

Parameters

$source: Any path that can be passed to rsync.

$destination: Any path that can be passed to rsync.

$additional_options: An array of options that overrides whatever was passed in on the command line (like the 'process' context, but only for the scope of this one call).

$include_settings_is_default: If TRUE, then settings.php will be transferred as part of the rsync unless --exclude-conf is specified. If FALSE, then settings.php will be excluded from the transfer unless --include-conf is specified.

$live_output: If TRUE, output goes directly to the terminal using system(). If FALSE, rsync is executed with drush_shell_exec() with output in drush_shell_exec_output().

Return value

TRUE on success, FALSE on failure.

File

commands/core/rsync.core.inc, line 105

Code

function drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE) {
  $options = _drush_build_rsync_options($additional_options, $include_settings_is_default);
  return drush_core_exec_rsync($source, $destination, $options, $additional_options, $live_output);
}