aboutsummaryrefslogtreecommitdiffstats
path: root/library/kzykhys/git/src/PHPGit/Command/LogCommand.php
diff options
context:
space:
mode:
Diffstat (limited to 'library/kzykhys/git/src/PHPGit/Command/LogCommand.php')
-rw-r--r--library/kzykhys/git/src/PHPGit/Command/LogCommand.php105
1 files changed, 105 insertions, 0 deletions
diff --git a/library/kzykhys/git/src/PHPGit/Command/LogCommand.php b/library/kzykhys/git/src/PHPGit/Command/LogCommand.php
new file mode 100644
index 000000000..c116550f7
--- /dev/null
+++ b/library/kzykhys/git/src/PHPGit/Command/LogCommand.php
@@ -0,0 +1,105 @@
+<?php
+
+namespace PHPGit\Command;
+
+use PHPGit\Command;
+use PHPGit\Exception\GitException;
+use Symfony\Component\OptionsResolver\OptionsResolverInterface;
+
+/**
+ * Show commit logs - `git log`
+ *
+ * @author Kazuyuki Hayashi <hayashi@valnur.net>
+ */
+class LogCommand extends Command
+{
+
+ /**
+ * Returns the commit logs
+ *
+ * ``` php
+ * $git = new PHPGit\Git();
+ * $git->setRepository('/path/to/repo');
+ * $logs = $git->log(array('limit' => 10));
+ * ```
+ *
+ * ##### Output Example
+ *
+ * ``` php
+ * [
+ * 0 => [
+ * 'hash' => '1a821f3f8483747fd045eb1f5a31c3cc3063b02b',
+ * 'name' => 'John Doe',
+ * 'email' => 'john@example.com',
+ * 'date' => 'Fri Jan 17 16:32:49 2014 +0900',
+ * 'title' => 'Initial Commit'
+ * ],
+ * 1 => [
+ * //...
+ * ]
+ * ]
+ * ```
+ *
+ * ##### Options
+ *
+ * - **limit** (_integer_) Limits the number of commits to show
+ * - **skip** (_integer_) Skip number commits before starting to show the commit output
+ *
+ * @param string $revRange [optional] Show only commits in the specified revision range
+ * @param string $path [optional] Show only commits that are enough to explain how the files that match the specified paths came to be
+ * @param array $options [optional] An array of options {@see LogCommand::setDefaultOptions}
+ *
+ * @throws GitException
+ * @return array
+ */
+ public function __invoke($revRange = '', $path = null, array $options = array())
+ {
+ $commits = array();
+ $options = $this->resolve($options);
+
+ $builder = $this->git->getProcessBuilder()
+ ->add('log')
+ ->add('-n')->add($options['limit'])
+ ->add('--skip=' . $options['skip'])
+ ->add('--format=%H||%aN||%aE||%aD||%s');
+
+ if ($revRange) {
+ $builder->add($revRange);
+ }
+
+ if ($path) {
+ $builder->add('--')->add($path);
+ }
+
+ $output = $this->git->run($builder->getProcess());
+ $lines = $this->split($output);
+
+ foreach ($lines as $line) {
+ list($hash, $name, $email, $date, $title) = preg_split('/\|\|/', $line, -1, PREG_SPLIT_NO_EMPTY);
+ $commits[] = array(
+ 'hash' => $hash,
+ 'name' => $name,
+ 'email' => $email,
+ 'date' => $date,
+ 'title' => $title
+ );
+ }
+
+ return $commits;
+ }
+
+ /**
+ * {@inheritdoc}
+ *
+ * - **limit** (_integer_) Limits the number of commits to show
+ * - **skip** (_integer_) Skip number commits before starting to show the commit output
+ */
+ public function setDefaultOptions(OptionsResolverInterface $resolver)
+ {
+ $resolver->setDefaults(array(
+ 'limit' => 10,
+ 'skip' => 0
+ ));
+ }
+
+} \ No newline at end of file