https://github.com/xobotyi/rsync

rsync dependency-free wrapper library for PHP7.1+
https://github.com/xobotyi/rsync

php rsync rsync-wrapper

Last synced: about 1 month ago
JSON representation

rsync dependency-free wrapper library for PHP7.1+

• Host: GitHub
• URL: https://github.com/xobotyi/rsync
• Owner: xobotyi
• License: mit
• Created: 2018-04-09T16:55:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-21T15:32:24.000Z (over 4 years ago)
• Last Synced: 2024-07-22T11:16:39.336Z (about 2 months ago)
• Topics: php, rsync, rsync-wrapper
• Language: PHP
• Homepage:
• Size: 62.5 KB
• Stars: 94
• Watchers: 9
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Rsync



    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



## About  

Rsync is a pure PHP 7.1+ dependency-free wrapper for rsync client. It provides you a simple way to abstract from command line control rsync right from php. Library uses PSR-4 autoloader standard and always has 100% tests coverage.  

There is no need to tell about rsync, except the fact that php doesn't has any faster or equal built-in way to upload files to remote server.

Library supports whole bunch of options and parameters implemented in rsync client version 3.1.2 

## Why Rsync?

1) It is small and fully covered with tests

2) It is well documented

3) I'm eating my own sweet pie=)

4) Supports whole bunch of parameters and options of rsync and ssh

5) Easy to use

6) Works on Windows (ofcourse id you installed ssh and rsync clients for Windows)

## Requirements

- [PHP](//php.net/) 7.1+

- PHP config `variables_order` must contain `E`, 4ex: `variables_order=EGPCS`.  

Otherwise you will have to manually specify absolute path to rsync and ssh binaries (at least on Windows)

- rsync client 3.1.2 +

## Installation

Install with composer

```bash

composer require xobotyi/rsync

```

## Docs

The code is well documented, for methods and parameters descriptions see the sources.

## Usage

_Simplest:_

```php

use xobotyi\rsync\Rsync;

$rsync = new Rsync();

$rsync->sync('/path/to/source', '/path/to/destination');

```

_If you need SSH:_

```php

use xobotyi\rsync\Rsync;

use xobotyi\rsync\SSH;

$rsync = new Rsync([

                       Rsync::CONF_CWD        => __DIR__,

                       Rsync::CONF_EXECUTABLE => '/even/alternative/executable/rsync.exe',

                       Rsync::CONF_SSH        => [

                           SSH::CONF_EXECUTABLE => '/even/alternative/executable/ssh.exe',

                           SSH::CONF_OPTIONS    => [

                               SSH::OPT_OPTION              => ['BatchMode=yes', 'StrictHostKeyChecking=no'],

                               SSH::OPT_IDENTIFICATION_FILE => './path/to/ident',

                               SSH::OPT_PORT                => 2222,

                           ],

                       ],

                   ]);

$rsync->sync('./relative/path/to/source', '[email protected]:/abs/path/to/destination');

echo './relative/path/to/source ' . ($rsync->getExitCode() === 0 ? 'successfully synchronized with remote.' : 'not synchronised due to errors.') . "\n";

$rsync->setExecutable('ssh')

      ->setOption(SSH::OPT_OPTION, false)// 'false' value turns off the options

      ->setOptions([

                       SSH::OPT_IDENTIFICATION_FILE => './new/path/to/ident',

                       SSH::OPT_PORT                => 22,

                   ]);

$rsync->sync('/new/path/to/source', '[email protected]:/abs/path/to/destination');

echo '/new/path/to/source ' . ($rsync->getExitCode() === 0 ? 'successfully synchronized with remote.' : 'not synchronised due to errors.') . "\n";

```