Webcreate\Conveyor\Transporter\AbstractTransporter

Complexity

Total Complexity

14

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

42%

Importance

Changes

0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setOptions()	0	8	1
A	setHost()	0	6	1
A	getHost()	0	4	1
A	setPort()	0	6	1
A	getPort()	0	4	1
A	setUser()	0	6	1
A	getUser()	0	4	1
A	setPass()	0	6	1
A	getPass()	0	4	1
A	setPath()	0	6	1
A	getPath()	0	4	1
A	getDispatcher()	0	4	1
A	setDispatcher()	0	6	1
	exists()	0	1	?
	mkdir()	0	1	?
	get()	0	1	?
	put()	0	1	?
	putContent()	0	1	?
	symlink()	0	1	?
	isSymlink()	0	1	?
	copy()	0	1	?
	remove()	0	1	?
	ls()	0	1	?

<?php

/*
 * This file is part of the Conveyor package.
 *
 * (c) Jeroen Fiege <jeroen@webcreate.nl>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webcreate\Conveyor\Transporter;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;

abstract class AbstractTransporter
{
    protected $username;
    protected $password;
    protected $path;
    protected $host;
    protected $port;

    /**
     * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
     */
    protected $dispatcher;

    public function __construct(EventDispatcherInterface $dispatcher)
    {
        $this->setDispatcher($dispatcher);
    }

    public function setOptions(array $options)
    {
        $this->setHost($options['host']);
        $this->setPort($options['port']);
        $this->setUser($options['user']);
        $this->setPass($options['pass']);
        $this->setPath($options['path']);
    }

    public function setHost($host)
    {
        $this->host = $host;

        return $this;
    }

    public function getHost()
    {
        return $this->host;
    }

    /**
     * @param  mixed $port
     * @return self
     */
    public function setPort($port)
    {
        $this->port = $port;

        return $this;
    }

    /**
     * @return mixed
     */
    public function getPort()
    {
        return $this->port;
    }

    public function setUser($username)
    {
        $this->username = $username;

        return $this;
    }

    public function getUser()
    {
        return $this->username;
    }

    public function setPass($password)
    {
        $this->password = $password;

        return $this;
    }

    public function getPass()
    {
        return $this->password;
    }

    public function setPath($path)
    {
        $this->path = $path;

        return $this;
    }

    public function getPath()
    {
        return $this->path;
    }

    public function getDispatcher()
    {
        return $this->dispatcher;
    }

    public function setDispatcher(EventDispatcherInterface $dispatcher)
    {
        $this->dispatcher = $dispatcher;

        return $this;
    }

    /**
     * Checks if a file or directory exists on the remote server
     *
     * @param  string $path remote source path
     * @return bool   true when the resource exists, false otherwise
     */
    abstract public function exists($path);

    /**
     * Create a directory on the remote server
     *
     * @param string $dest remote path
     */
    abstract public function mkdir($dest);

    /**
     * Retrieve file or directory from remote server
     *
     * @param string $src  remote source path
     * @param string $dest (optional) local destination path
     */
    abstract public function get($src, $dest = null);

    /**
     * Upload a file or directory to remote server
     *
     * @param string $src  local source path
     * @param string $dest remote destination path
     */
    abstract public function put($src, $dest);

    /**
     * Upload a string to remote server
     *
     * @param string $content content
     * @param string $dest    remote destination path
     */
    abstract public function putContent($content, $dest);

    /**
     * Creates a symlink on the remote server
     *
     * @param string $src
     * @param string $dest
     * @return mixed
     */
    abstract public function symlink($src, $dest);

    /**
     * Checks for symlink on the remote server
     *
     * @param $dest
     * @return bool
     */
    abstract public function isSymlink($dest);

    /**
     * Copies a file/directory on the remote host
     *
     * @param  string $src
     * @param  string $dest
     * @param  bool   $recursive
     * @return mixed
     */
    abstract public function copy($src, $dest, $recursive = true);

    /**
     * Removes a file/directory on the remote host
     *
     * @param  string $path
     * @param  bool   $recursive
     * @return mixed
     */
    abstract public function remove($path, $recursive = true);

    /**
     * Lists files and directories on the remote host
     *
     * returns an array with the following format:
     *
     * array(
     *   'filename' => array(
     *     'type' => 'directory', // or 'file'
     *     'mtime' => new \DateTime(),
     *   ),
     * );
     *
     * @param  string $path
     * @return array
     */
    abstract public function ls($path);

This method's name is shorter than the configured minimum length of 3 characters.

}