flamecore/synchronizer

Synchronize all kinds of things

FlameCore Synchronizer

, _(*1)

This library makes it easy to synchronize all kinds of things. It features a beautiful and easy to use API., _(*2)

Synchronizer was developed as backend for our deployment and testing tool Seabreeze., _(*3)

Implementations

The Synchronizer library is just an abstract foundation. But concrete implementations are available:, _(*4)

• FilesSynchronizer
• DatabaseSynchronizer

Usage

Include the vendor autoloader and use the classes:, _(*5)

namespace Acme\MyApplication;

// To create a Synchronizer:
use FlameCore\Synchronizer\AbstractSynchronizer;
use FlameCore\Synchronizer\SynchronizerSourceInterface;
use FlameCore\Synchronizer\SynchronizerTargetInterface;

// To make your project compatible with Synchronizer:
use FlameCore\Synchronizer\SynchronizerInterface;

require 'vendor/autoload.php';

Create your Synchronizer:, _(*6)

class ExampleSynchronizer extends AbstractSynchronizer
{
    /**
     * @param bool $preserve Preserve obsolete objects
     * @return bool Returns whether the synchronization succeeded.
     */
    public function synchronize($preserve = true)
    {
        // Do the sync magic

        return true;
    }

    /**
     * @param SynchronizerSourceInterface $source The source
     * @return bool Returns whether the synchronizer supports the source.
     */
    public function supportsSource(SynchronizerSourceInterface $source)
    {
        return $source instanceof ExampleSource;
    }

    /**
     * @param SynchronizerTargetInterface $target The target
     * @return bool Returns whether the synchronizer supports the target.
     */
    public function supportsTarget(SynchronizerTargetInterface $target)
    {
        return $target instanceof ExampleTarget;
    }
}

Create your Source and Target:, _(*7)

class ExampleSource implements SynchronizerSourceInterface
{
    /**
     * @param array $settings The settings
     */
    public function __construct(array $settings)
    {
        // Save settings
    }

    // Your methods...
}

class ExampleTarget implements SynchronizerTargetInterface
{
    /**
     * @param array $settings The settings
     */
    public function __construct(array $settings)
    {
        // Save settings
    }

    // Your methods...
}

Make your project compatible with Synchronizer:, _(*8)

class Application
{
    protected $synchronizer;

    public function setSynchronizer(SynchronizerInterface $synchronizer)
    {
        $this->synchronizer = $synchronizer;
    }

    // ...
}

Installation

Install via Composer

Install Composer if you don't already have it present on your system:, _(*9)

$ curl -sS https://getcomposer.org/installer | php

To install the library, run the following command and you will get the latest version:, _(*10)

$ php composer.phar require flamecore/synchronizer

Requirements

• You must have at least PHP version 5.4 installed on your system.

Contributing

If you'd like to contribute, please see the CONTRIBUTING file first., _(*11)