Download the PHP package cullylarson/wp-deploy-folder-sync without Composer
On this page you can find all versions of the php package cullylarson/wp-deploy-folder-sync. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cullylarson/wp-deploy-folder-sync
More information about cullylarson/wp-deploy-folder-sync
Files in cullylarson/wp-deploy-folder-sync
Package wp-deploy-folder-sync
Short Description Library for syncing Wordpress folders, like the uploads folder. Useful for deploying, or pulling changes.
License MIT
Homepage https://github.com/cullylarson/wp-deploy-folder-sync
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package wp-deploy-folder-sync
Wordpress Deploy FolderSync
A library for syncing Wordpress folders. Can be used as part of a deployment system. Useful for deploying or pulling resources like the 'uploads' folder, since it likely contains files that the site depends on.
This project is meant to be a composable component. It does one thing, sync
folders. If you want to do more, as part of a deployment system, then check
out the other projects in the Wordpress\Deploy namespace.
Dependencies
-
The
rsynclinux command is used to perform the sync. So, it must be available via the command-line. You'll get aRuntimeExceptionif you try to callFolderSync::syncwithout thersynccommand. - All other dependencies are defined in
composer.json.
Install
Usage
Everything is done through an instance of the Wordpress\Deploy\FolderSync
class.
Construction
The Wordpress\Deploy\FolderSync constructor takes three arguments:
- source The source folder. It must have a trailing slash (
/). - dest The destination folder. After the sync is run, the destination folder
will match the source folder. It must have a trailing slash (
/). - options A set of options, described below.
Source and Destination Paths
These paths provided in the source and dest params can be any paths that
the rsync command recognizes. So you can provide either remote or local
paths. For example:
Options
The constructor accepts the following options:
-
delete boolean (Default: true) Whether to delete files when syncing (e.g. if a file no longer exists at the source, then delete it from the destination).
- exclude array (Default: []) An array of patterns to exclude from the sync. See the rsync man page for details on --exclude.
Syncing
The sync is performed by calling the Wordpress\Deploy\FolderSync::sync function.
This will examine your source folder and dest folder, and will make any changes
necessary so that your dest folder ends up just like your source folder. In
this way, the folders will be synchronized.
Example
Status Callback
The Wordpress\Deploy\FolderSync::sync function can optionally accept a callback
function. This callback will be called whenever the sync function wants to post
a status update (e.g. "I'm running", "Here's the output of the rsync command",
"Something went wrong", etc.). It allows you to have some control over whether
and how messages are handled.
The callback must take one parameter, an instance of Wordpress\Deploy\FolderSync\Status.
Here's an example:
