PHPackages                             sudnonk/php-rsync - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. sudnonk/php-rsync

ActiveLibrary[Utility & Helpers](/categories/utility)

sudnonk/php-rsync
=================

Use rsync command from PHP.

1.0.0(6y ago)05MITPHPPHP >=7.0CI failing

Since Oct 10Pushed 6y agoCompare

[ Source](https://github.com/sudnonk/php-rsync)[ Packagist](https://packagist.org/packages/sudnonk/php-rsync)[ Docs](https://github.com/sudnonk/php-rsync)[ RSS](/packages/sudnonk-php-rsync/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

php-rsync
=========

[](#php-rsync)

[![Build Status](https://camo.githubusercontent.com/44333d7c580cf257b82391d422235a8d86e43b77b447871f7423b0812a777f72/68747470733a2f2f7472617669732d63692e6f72672f7375646e6f6e6b2f7068702d7273796e632e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/sudnonk/php-rsync)

phpでrsyncを便利に使えるようにするクラスです。

prerequisite 前提
---------------

[](#prerequisite-前提)

- ふつうにrsyncコマンドが使えること

install
-------

[](#install)

`composer require sudnonk/php-rsync`

environment 環境
--------------

[](#environment-環境)

- PHP 7.1.10以上
- Bash

usage 使い方
---------

[](#usage-使い方)

**注意**

実際に実行する前に、一度発行されるコマンドを確認してください。ファイルが消えても責任は取りません。

```
$rsync->run();//の前に！！！！！！！！！
echo $rsync->build(); //で確認すること！！！！！！
```

`sample.php`も参照

### コンストラクタ

[](#コンストラクタ)

```
$rsync = new Rsync();
```

標準出力に`rsync`コマンドの出力を出したいときは、

```
$rsync = new Rsync(true);
```

### コピー元のディレクトリをセット

[](#コピー元のディレクトリをセット)

```
$rsync->set_from(string ディレクトリ名,bool 中身だけか, string ユーザ名, string ホスト);

//例
$rsync->set_from("/remote/test",true,"root","localhost");
$rsync->set_from("/local/test2",false);
```

第二引数を`true`にすると、ディレクトリの中身だけをコピーします。 `false`にすると、ディレクトリ自体をコピーします。 ファイルをコピーしたいときは`false`にしてください。

コピー元がリモートの時は、第三と第四引数を指定してください。ローカルの時はなにも入れなくて良いです。

### コピー先のディレクトリをセット

[](#コピー先のディレクトリをセット)

```
$rsync->set_to(string ディレクトリ名, string ユーザ名, string ホスト);

//例
$rsync->set_to("/remote/test","root","localhost");
$rsync->set_to("/local/test2");
```

コピー先は、自動で指定したディレクトリの中にコピーする扱いになります。

コピー先がリモートの時は、第三と第四引数を指定してください。ローカルの時はなにも入れなくて良いです。

### オプションをセット

[](#オプションをセット)

```
//パラメータつきのオプションをセットするとき
$rsync->options()->set(string オプション名, string パラメータ);
//パラメータ無しのをまとめてセットするとき
$rsync->options()->sets(string オプション名, string オプション名, ...);

//例
$rsync->options()->set("ignore-times");
$rsync->options()->set("timeout", "5");
$rsync->options()->sets("a", "v", "z", "stats");
```

オプションを指定できます。どんなオプションがあるかはググってください。たぶん大体対応してます。

良く使うオプションについては、関数を用意してあります。

```
//コピー元にないファイルをコピー先から削除する
$rsync->options()->setDelete();
//どんな動作をするかを実際には行わずに確認する
$rsync->options()->setDryRun();
```

#### SSHのオプションをセット

[](#sshのオプションをセット)

```
//SSHのオプションをセット
$rsync->ssh_options()->set(string オプション名, string パラメータ);

//例
$rsync->ssh_options()->set("C");
$rsync->ssh_options()->set("F", "/path/to/config");
```

SSHのオプションを指定できます。どんなオプションがあるかはググってください。たぶん大体対応してます。

良く使うオプションについては、関数を用意してあります。

```
//接続先ポートを10022番にする
$rsync->ssh_options()->setPort(10022);
//公開鍵ファイルを指定する
$rsync->ssh_options()->setCert("/path/to/cert");
```

### rsyncを実行する

[](#rsyncを実行する)

```
//実行する
$rsync->run();

//コマンドだけを組み立てる
$command = $rsync->build();
var_dump($command);
//rsync -a -u -z --stat -e 'ssh -i /path/to/cert' /local/test root@example.com:/remote/test
```

とくにオプションはありません。

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2408d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9f84f7b529ddc6cba149ffd257d984db8c15b5a302f1fa66b1e14505ea2b2e6b?d=identicon)[snzhevo](/maintainers/snzhevo)

---

Top Contributors

[![sudnonk](https://avatars.githubusercontent.com/u/14357234?v=4)](https://github.com/sudnonk "sudnonk (37 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/sudnonk-php-rsync/health.svg)

```
[![Health](https://phpackages.com/badges/sudnonk-php-rsync/health.svg)](https://phpackages.com/packages/sudnonk-php-rsync)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)