aboutsummaryrefslogtreecommitdiffstats
path: root/library/kzykhys/git/src/PHPGit/Command/StashCommand.php
blob: 52dceaa6b3a88a5fdb43dd2a077a46180c3fda93 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<?php

namespace PHPGit\Command;

use PHPGit\Command;

/**
 * Stash the changes in a dirty working directory away - `git stash`
 *
 * @author Kazuyuki Hayashi
 */
class StashCommand extends Command
{

    /**
     * Save your local modifications to a new stash, and run git reset --hard to revert them
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $git->stash();
     * ```
     *
     * @return bool
     */
    public function __invoke()
    {
        $builder = $this->git->getProcessBuilder()
            ->add('stash');

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

        return true;
    }

    /**
     * Save your local modifications to a new stash, and run git reset --hard to revert them.
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $git->stash->save('My stash');
     * ```
     *
     * @param string $message [optional] The description along with the stashed state
     * @param array  $options [optional] An array of options {@see StashCommand::setDefaultOptions}
     *
     * @return bool
     */
    public function save($message = null, array $options = array())
    {
        $options = $this->resolve($options);
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('save');

        $builder->add($message);

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

        return true;
    }

    /**
     * Returns the stashes that you currently have
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $stashes = $git->stash->lists();
     * ```
     *
     * ##### Output Example
     *
     * ``` php
     * [
     *     0 => ['branch' => 'master', 'message' => '0e2f473 Fixes README.md'],
     *     1 => ['branch' => 'master', 'message' => 'ce1ddde Initial commit'],
     * ]
     * ```
     *
     * @param array $options [optional] An array of options {@see StashCommand::setDefaultOptions}
     *
     * @return array
     */
    public function lists(array $options = array())
    {
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('list');

        $output = $this->git->run($builder->getProcess());
        $lines  = $this->split($output);
        $list   = array();

        foreach ($lines as $line) {
            if (preg_match('/stash@{(\d+)}:.* [Oo]n (.*): (.*)/', $line, $matches)) {
                $list[$matches[1]] = array(
                    'branch'  => $matches[2],
                    'message' => $matches[3]
                );
            }
        }

        return $list;
    }

    /**
     * Show the changes recorded in the stash as a diff between the stashed state and its original parent
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * echo $git->stash->show('stash@{0}');
     * ```
     *
     * ##### Output Example
     *
     * ```
     *  REAMDE.md |    2 +-
     *  1 files changed, 1 insertions(+), 1 deletions(-)
     * ```
     *
     * @param string $stash The stash to show
     *
     * @return string
     */
    public function show($stash = null)
    {
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('show');

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

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

    /**
     * Remove a single stashed state from the stash list
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $git->stash->drop('stash@{0}');
     * ```
     *
     * @param string $stash The stash to drop
     *
     * @return mixed
     */
    public function drop($stash = null)
    {
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('drop');

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

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

    /**
     * Remove a single stashed state from the stash list and apply it on top of the current working tree state
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $git->stash->pop('stash@{0}');
     * ```
     *
     * @param string $stash   The stash to pop
     * @param array  $options [optional] An array of options {@see StashCommand::setDefaultOptions}
     *
     * @return bool
     */
    public function pop($stash = null, array $options = array())
    {
        $options = $this->resolve($options);
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('pop');

        $this->addFlags($builder, $options, array('index'));

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

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

        return true;
    }

    /**
     * Like pop, but do not remove the state from the stash list
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $git->stash->apply('stash@{0}');
     * ```
     *
     * @param string $stash   The stash to apply
     * @param array  $options [optional] An array of options {@see StashCommand::setDefaultOptions}
     *
     * @return bool
     */
    public function apply($stash = null, array $options = array())
    {
        $options = $this->resolve($options);
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('apply');

        $this->addFlags($builder, $options, array('index'));

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

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

        return true;
    }

    /**
     * Creates and checks out a new branch named <branchname> starting from the commit at which the <stash> was originally created, applies the changes recorded in <stash> to the new working tree and index
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $git->stash->branch('hotfix', 'stash@{0}');
     * ```
     *
     * @param string $name  The name of the branch
     * @param string $stash The stash
     *
     * @return bool
     */
    public function branch($name, $stash = null)
    {
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('branch')
            ->add($name);

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

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

        return true;
    }

    /**
     * Remove all the stashed states
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $git->stash->clear();
     * ```
     *
     * @return bool
     */
    public function clear()
    {
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('clear');

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

        return true;
    }

    /**
     * Create a stash (which is a regular commit object) and return its object name, without storing it anywhere in the ref namespace
     *
     * ``` php
     * $git = new PHPGit\Git();
     * $git->setRepository('/path/to/repo');
     * $commit = $git->stash->create();
     * ```
     *
     * ##### Output Example
     *
     * ```
     * 877316ea6f95c43b7ccc2c2a362eeedfa78b597d
     * ```
     *
     * @return string
     */
    public function create()
    {
        $builder = $this->git->getProcessBuilder()
            ->add('stash')
            ->add('create');

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