aboutsummaryrefslogtreecommitdiffstats
path: root/library/kzykhys/git/src/PHPGit/Command/CloneCommand.php
blob: cc6b4ab372011f25ee879b846e3a644905ca9071 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<?php

namespace PHPGit\Command;

use PHPGit\Command;
use PHPGit\Exception\GitException;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;

/**
 * Clone a repository into a new directory - `git clone`
 *
 * @author Kazuyuki Hayashi <hayashi@valnur.net>
 */
class CloneCommand extends Command
{

    /**
     * Clone a repository into a new directory
     * 
     * ``` php
     * $git = new PHPGit\Git();
     * $git->clone('https://github.com/kzykhys/PHPGit.git', '/path/to/repo');
     * ```
     *
     * ##### Options
     *
     * - **shared** (_boolean_) Starts out without any object of its own
     * - **bare**   (_boolean_) Make a bare GIT repository
     *
     * @param string $repository The repository to clone from
     * @param string $path       [optional] The name of a new directory to clone into
     * @param array  $options    [optional] An array of options {@see CloneCommand::setDefaultOptions}
     *
     * @throws GitException
     * @return bool
     */
    public function __invoke($repository, $path = null, array $options = array())
    {
        $options = $this->resolve($options);
        $builder = $this->git->getProcessBuilder()
            ->add('clone')
            ->add('--quiet');

        $this->addFlags($builder, $options);

        $builder->add($repository);

        if ($path) {
            $builder->add($path);
        }

        $this->git->run($builder->getProcess());

        return true;
    }

    /**
     * {@inheritdoc}
     *
     * - **shared** (_boolean_) Starts out without any object of its own
     * - **bare**   (_boolean_) Make a bare GIT repository
     */
    public function setDefaultOptions(OptionsResolverInterface $resolver)
    {
        $resolver->setDefaults(array(
            'shared' => false,
            'bare'   => false
        ));
    }

}