2130 lines
142 KiB
HTML
2130 lines
142 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
|
<meta charset="utf-8"/>
|
|
<title> SYSTEM - PHP Framework » \GIT\GitRepo
|
|
</title>
|
|
<meta name="author" content=""/>
|
|
<meta name="description" content=""/>
|
|
<base href="../">
|
|
|
|
<link href="css/template.css" rel="stylesheet" media="all"/>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
|
|
<![endif]-->
|
|
<script src="js/jquery-1.7.1.min.js" type="text/javascript"></script>
|
|
<script src="js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
|
|
<script src="js/jquery.mousewheel.min.js" type="text/javascript"></script>
|
|
<script src="js/bootstrap.js" type="text/javascript"></script>
|
|
<script src="js/template.js" type="text/javascript"></script>
|
|
<script src="js/prettify/prettify.min.js" type="text/javascript"></script>
|
|
|
|
<link rel="shortcut icon" href="img/favicon.ico"/>
|
|
<link rel="apple-touch-icon" href="img/apple-touch-icon.png"/>
|
|
<link rel="apple-touch-icon" sizes="72x72" href="img/apple-touch-icon-72x72.png"/>
|
|
<link rel="apple-touch-icon" sizes="114x114" href="img/apple-touch-icon-114x114.png"/>
|
|
</head>
|
|
<body>
|
|
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="navbar-inner">
|
|
<div class="container">
|
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
|
<span class="icon-bar"></span> <span class="icon-bar"></span>
|
|
<span class="icon-bar"></span> </a>
|
|
<a class="brand" href="index.html">SYSTEM - PHP Framework</a>
|
|
|
|
<div class="nav-collapse">
|
|
<ul class="nav">
|
|
<li class="dropdown">
|
|
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
|
API Documentation <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li><a>Namespaces</a></li>
|
|
<li><a href="\LIB">LIB</a></li>
|
|
<li><a href="\GIT">GIT</a></li>
|
|
<li><a href="\vakata">vakata</a></li>
|
|
<li><a href="\Michelf">Michelf</a></li>
|
|
<li><a href="\MatthiasMullie">MatthiasMullie</a></li>
|
|
<li><a href="\PHPDocMD">PHPDocMD</a></li>
|
|
<li><a href="\ScssPhp">ScssPhp</a></li>
|
|
<li><a href="\SYSTEM">SYSTEM</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown" id="charts-menu">
|
|
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
|
Charts <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li>
|
|
<a href="graph_class.html">
|
|
<i class="icon-list-alt"></i> Class hierarchy diagram
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown" id="reports-menu">
|
|
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
|
Reports <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li>
|
|
<a href="errors.html">
|
|
<i class="icon-list-alt"></i> Errors
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="markers.html">
|
|
<i class="icon-list-alt"></i> Markers
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="deprecated.html">
|
|
<i class="icon-list-alt"></i> Deprecated
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="go_to_top">
|
|
<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="___" class="container">
|
|
<noscript>
|
|
<div class="alert alert-warning">
|
|
Javascript is disabled; several features are only available if Javascript is enabled.
|
|
</div>
|
|
</noscript>
|
|
|
|
|
|
<style>
|
|
.deprecated h2 {
|
|
text-decoration: line-through;
|
|
}
|
|
</style>
|
|
<div class="row">
|
|
<div class="span4">
|
|
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
|
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
|
|
<button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
|
</div>
|
|
<div class="btn-group visibility" data-toggle="buttons-checkbox">
|
|
<button class="btn public active" title="Show public elements">Public</button>
|
|
<button class="btn protected" title="Show protected elements">Protected</button>
|
|
<button class="btn private" title="Show private elements">Private</button>
|
|
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
|
|
</div>
|
|
|
|
<ul class="side-nav nav nav-list">
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-method"></i> Methods
|
|
<ul>
|
|
<li class="method public">
|
|
<a href="#method___construct" title="__construct :: Constructor">
|
|
<span class="description">Constructor</span><pre>__construct</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_active_branch" title="active_branch :: Returns name of active branch">
|
|
<span class="description">Returns name of active branch</span><pre>active_branch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_add" title="add :: Runs a `git add` call">
|
|
<span class="description">Runs a `git add` call</span><pre>add</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_add_tag" title="add_tag :: Add a new tag on the current position">
|
|
<span class="description">Add a new tag on the current position</span><pre>add_tag</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_checkout" title="checkout :: Runs a `git checkout` call">
|
|
<span class="description">Runs a `git checkout` call</span><pre>checkout</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_clean" title="clean :: Runs a `git clean` call">
|
|
<span class="description">Runs a `git clean` call</span><pre>clean</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_clone_from" title="clone_from :: Runs a `git clone` call to clone a different repository
|
|
into the current repository">
|
|
<span class="description">Runs a `git clone` call to clone a different repository
|
|
into the current repository</span><pre>clone_from</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_clone_remote" title="clone_remote :: Runs a `git clone` call to clone a remote repository
|
|
into the current repository">
|
|
<span class="description">Runs a `git clone` call to clone a remote repository
|
|
into the current repository</span><pre>clone_remote</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_clone_to" title="clone_to :: Runs a `git clone` call to clone the current repository
|
|
into a different directory">
|
|
<span class="description">Runs a `git clone` call to clone the current repository
|
|
into a different directory</span><pre>clone_to</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_commit" title="commit :: Runs a `git commit` call">
|
|
<span class="description">Runs a `git commit` call</span><pre>commit</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_create_branch" title="create_branch :: Runs a `git branch` call">
|
|
<span class="description">Runs a `git branch` call</span><pre>create_branch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_create_new" title="create_new :: Create a new git repository">
|
|
<span class="description">Create a new git repository</span><pre>create_new</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_delete_branch" title="delete_branch :: Runs a `git branch -[d|D]` call">
|
|
<span class="description">Runs a `git branch -[d|D]` call</span><pre>delete_branch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_fetch" title="fetch :: Runs a git fetch on the current branch">
|
|
<span class="description">Runs a git fetch on the current branch</span><pre>fetch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_get_description" title="get_description :: Gets the project description.">
|
|
<span class="description">Gets the project description.</span><pre>get_description</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_git_directory_path" title="git_directory_path :: Get the path to the git repo directory (eg. the ".git" directory)">
|
|
<span class="description">Get the path to the git repo directory (eg. the ".git" directory)</span><pre>git_directory_path</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_list_branches" title="list_branches :: Runs a `git branch` call">
|
|
<span class="description">Runs a `git branch` call</span><pre>list_branches</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_list_remote_branches" title="list_remote_branches :: Lists remote branches (using `git branch -r`).">
|
|
<span class="description">Lists remote branches (using `git branch -r`).</span><pre>list_remote_branches</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_list_tags" title="list_tags :: List all the available repository tags.">
|
|
<span class="description">List all the available repository tags.</span><pre>list_tags</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_log" title="log :: List log entries.">
|
|
<span class="description">List log entries.</span><pre>log</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_merge" title="merge :: Runs a `git merge` call">
|
|
<span class="description">Runs a `git merge` call</span><pre>merge</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_pull" title="pull :: Pull specific branch from remote">
|
|
<span class="description">Pull specific branch from remote</span><pre>pull</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_push" title="push :: Push specific branch to a remote">
|
|
<span class="description">Push specific branch to a remote</span><pre>push</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_rm" title="rm :: Runs a `git rm` call">
|
|
<span class="description">Runs a `git rm` call</span><pre>rm</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_run" title="run :: Run a git command in the git repository">
|
|
<span class="description">Run a git command in the git repository</span><pre>run</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_set_description" title="set_description :: Sets the project description.">
|
|
<span class="description">Sets the project description.</span><pre>set_description</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_set_repo_path" title="set_repo_path :: Set the repository's path">
|
|
<span class="description">Set the repository's path</span><pre>set_repo_path</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_setenv" title="setenv :: Sets custom environment options for calling Git">
|
|
<span class="description">Sets custom environment options for calling Git</span><pre>setenv</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_status" title="status :: Runs a 'git status' call">
|
|
<span class="description">Runs a 'git status' call</span><pre>status</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_test_git" title="test_git :: Tests if git is installed">
|
|
<span class="description">Tests if git is installed</span><pre>test_git</pre>
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header protected">» Protected
|
|
<ul>
|
|
<li class="method protected">
|
|
<a href="#method_run_command" title="run_command :: Run a command in the git repository">
|
|
<span class="description">Run a command in the git repository</span><pre>run_command</pre>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header private">» Private
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-constant"></i> Constants
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="span8">
|
|
<div class="element class">
|
|
<h1>GitRepo</h1>
|
|
<small style="display: block; text-align: right">
|
|
</small>
|
|
<p class="short_description">Git Repository Interface Class</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
<p>This class enables the creating, reading, and manipulation
|
|
of a git repository</p>
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
class
|
|
</th>
|
|
<td>
|
|
|
|
<p>GitRepo</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>Application</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method___construct"></a>
|
|
<div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
|
|
<h2>Constructor</h2>
|
|
<pre>__construct(mixedrepo_path = null, mixedcreate_new = false, mixed_init = true) : void</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a repository path</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>repo_path</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>create_new</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>_init</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_active_branch"></a>
|
|
<div class="element clickable method public method_active_branch" data-toggle="collapse" data-target=".method_active_branch .collapse">
|
|
<h2>Returns name of active branch</h2>
|
|
<pre>active_branch(mixedkeep_asterisk = false) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>keep_asterisk</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_add"></a>
|
|
<div class="element clickable method public method_add" data-toggle="collapse" data-target=".method_add .collapse">
|
|
<h2>Runs a `git add` call</h2>
|
|
<pre>add(mixedfiles = "*") : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a list of files to add</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>files</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_add_tag"></a>
|
|
<div class="element clickable method public method_add_tag" data-toggle="collapse" data-target=".method_add_tag .collapse">
|
|
<h2>Add a new tag on the current position</h2>
|
|
<pre>add_tag(stringtag, stringmessage = null) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts the name for the tag and the message</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>tag</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>message</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_checkout"></a>
|
|
<div class="element clickable method public method_checkout" data-toggle="collapse" data-target=".method_checkout .collapse">
|
|
<h2>Runs a `git checkout` call</h2>
|
|
<pre>checkout(mixedbranch) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a name for the branch</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>branch</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_clean"></a>
|
|
<div class="element clickable method public method_clean" data-toggle="collapse" data-target=".method_clean .collapse">
|
|
<h2>Runs a `git clean` call</h2>
|
|
<pre>clean(mixeddirs = false, mixedforce = false) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a remove directories flag</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>dirs</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>force</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_clone_from"></a>
|
|
<div class="element clickable method public method_clone_from" data-toggle="collapse" data-target=".method_clone_from .collapse">
|
|
<h2>Runs a `git clone` call to clone a different repository
|
|
into the current repository</h2>
|
|
<pre>clone_from(mixedsource) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a source directory</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>source</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_clone_remote"></a>
|
|
<div class="element clickable method public method_clone_remote" data-toggle="collapse" data-target=".method_clone_remote .collapse">
|
|
<h2>Runs a `git clone` call to clone a remote repository
|
|
into the current repository</h2>
|
|
<pre>clone_remote(mixedsource, mixedreference) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a source url</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>source</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>reference</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_clone_to"></a>
|
|
<div class="element clickable method public method_clone_to" data-toggle="collapse" data-target=".method_clone_to .collapse">
|
|
<h2>Runs a `git clone` call to clone the current repository
|
|
into a different directory</h2>
|
|
<pre>clone_to(mixedtarget) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a target directory</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>target</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_commit"></a>
|
|
<div class="element clickable method public method_commit" data-toggle="collapse" data-target=".method_commit .collapse">
|
|
<h2>Runs a `git commit` call</h2>
|
|
<pre>commit(mixedmessage = "", mixedcommit_all = true) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a commit message string</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>message</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>commit_all</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_create_branch"></a>
|
|
<div class="element clickable method public method_create_branch" data-toggle="collapse" data-target=".method_create_branch .collapse">
|
|
<h2>Runs a `git branch` call</h2>
|
|
<pre>create_branch(mixedbranch) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a name for the branch</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>branch</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_create_new"></a>
|
|
<div class="element clickable method public method_create_new" data-toggle="collapse" data-target=".method_create_new .collapse">
|
|
<h2>Create a new git repository</h2>
|
|
<pre>& create_new(mixedrepo_path, mixedsource = null, mixedremote_source = false, mixedreference = null) : \GIT\GitRepo</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a creation path, and, optionally, a source path</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>repo_path</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>source</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>remote_source</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>reference</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\GIT\GitRepo</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_delete_branch"></a>
|
|
<div class="element clickable method public method_delete_branch" data-toggle="collapse" data-target=".method_delete_branch .collapse">
|
|
<h2>Runs a `git branch -[d|D]` call</h2>
|
|
<pre>delete_branch(mixedbranch, mixedforce = false) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a name for the branch</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>branch</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>force</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_fetch"></a>
|
|
<div class="element clickable method public method_fetch" data-toggle="collapse" data-target=".method_fetch .collapse">
|
|
<h2>Runs a git fetch on the current branch</h2>
|
|
<pre>fetch() : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_description"></a>
|
|
<div class="element clickable method public method_get_description" data-toggle="collapse" data-target=".method_get_description .collapse">
|
|
<h2>Gets the project description.</h2>
|
|
<pre>get_description() : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_git_directory_path"></a>
|
|
<div class="element clickable method public method_git_directory_path" data-toggle="collapse" data-target=".method_git_directory_path .collapse">
|
|
<h2>Get the path to the git repo directory (eg. the ".git" directory)</h2>
|
|
<pre>git_directory_path() : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_list_branches"></a>
|
|
<div class="element clickable method public method_list_branches" data-toggle="collapse" data-target=".method_list_branches .collapse">
|
|
<h2>Runs a `git branch` call</h2>
|
|
<pre>list_branches(mixedkeep_asterisk = false) : array</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>keep_asterisk</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
array</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_list_remote_branches"></a>
|
|
<div class="element clickable method public method_list_remote_branches" data-toggle="collapse" data-target=".method_list_remote_branches .collapse">
|
|
<h2>Lists remote branches (using `git branch -r`).</h2>
|
|
<pre>list_remote_branches() : array</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Also strips out the HEAD reference (e.g. "origin/HEAD -> origin/master").</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
array</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_list_tags"></a>
|
|
<div class="element clickable method public method_list_tags" data-toggle="collapse" data-target=".method_list_tags .collapse">
|
|
<h2>List all the available repository tags.</h2>
|
|
<pre>list_tags(stringpattern = null) : array</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Optionally, accept a shell wildcard pattern and return only tags matching it.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>pattern</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p><p>Shell wildcard pattern to match tags against.</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
array</code><p><p>Available repository tags.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_log"></a>
|
|
<div class="element clickable method public method_log" data-toggle="collapse" data-target=".method_log .collapse">
|
|
<h2>List log entries.</h2>
|
|
<pre>log(\GIT\strginformat = null) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>format</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\GIT\strgin</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_merge"></a>
|
|
<div class="element clickable method public method_merge" data-toggle="collapse" data-target=".method_merge .collapse">
|
|
<h2>Runs a `git merge` call</h2>
|
|
<pre>merge(stringbranch) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a name for the branch to be merged</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>branch</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_pull"></a>
|
|
<div class="element clickable method public method_pull" data-toggle="collapse" data-target=".method_pull .collapse">
|
|
<h2>Pull specific branch from remote</h2>
|
|
<pre>pull(stringremote, stringbranch) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts the name of the remote and local branch</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>remote</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>branch</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_push"></a>
|
|
<div class="element clickable method public method_push" data-toggle="collapse" data-target=".method_push .collapse">
|
|
<h2>Push specific branch to a remote</h2>
|
|
<pre>push(stringremote, stringbranch) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts the name of the remote and local branch</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>remote</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>branch</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_rm"></a>
|
|
<div class="element clickable method public method_rm" data-toggle="collapse" data-target=".method_rm .collapse">
|
|
<h2>Runs a `git rm` call</h2>
|
|
<pre>rm(mixedfiles = "*", mixedcached = false) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a list of files to remove</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>files</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>cached</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_run"></a>
|
|
<div class="element clickable method public method_run" data-toggle="collapse" data-target=".method_run .collapse">
|
|
<h2>Run a git command in the git repository</h2>
|
|
<pre>run(mixedcommand) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a git command to run</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>command</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_run_command"></a>
|
|
<div class="element clickable method protected method_run_command" data-toggle="collapse" data-target=".method_run_command .collapse">
|
|
<h2>Run a command in the git repository</h2>
|
|
<pre>run_command(mixedcommand) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts a shell command to run</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>protected</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>command</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_set_description"></a>
|
|
<div class="element clickable method public method_set_description" data-toggle="collapse" data-target=".method_set_description .collapse">
|
|
<h2>Sets the project description.</h2>
|
|
<pre>set_description(stringnew) : mixed</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>new</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_set_repo_path"></a>
|
|
<div class="element clickable method public method_set_repo_path" data-toggle="collapse" data-target=".method_set_repo_path .collapse">
|
|
<h2>Set the repository's path</h2>
|
|
<pre>set_repo_path(mixedrepo_path, mixedcreate_new = false, mixed_init = true) : void</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accepts the repository path</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>repo_path</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>create_new</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>_init</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_setenv"></a>
|
|
<div class="element clickable method public method_setenv" data-toggle="collapse" data-target=".method_setenv .collapse">
|
|
<h2>Sets custom environment options for calling Git</h2>
|
|
<pre>setenv(mixedkey, mixedvalue) : mixed</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>key</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>value</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_status"></a>
|
|
<div class="element clickable method public method_status" data-toggle="collapse" data-target=".method_status .collapse">
|
|
<h2>Runs a 'git status' call</h2>
|
|
<pre>status(mixedhtml = false) : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Accept a convert to HTML bool</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>html</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_test_git"></a>
|
|
<div class="element clickable method public method_test_git" data-toggle="collapse" data-target=".method_test_git .collapse">
|
|
<h2>Tests if git is installed</h2>
|
|
<pre>test_git() : bool</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
access
|
|
</th>
|
|
<td>
|
|
|
|
<p>public</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<h3><i class="icon-custom icon-property"></i> Properties</h3>
|
|
<a id="property_repo_path"> </a>
|
|
<div class="element clickable property protected property_repo_path" data-toggle="collapse" data-target=".property_repo_path .collapse">
|
|
<h2>repo_path</h2>
|
|
<pre>repo_path : </pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="property_bare"> </a>
|
|
<div class="element clickable property protected property_bare" data-toggle="collapse" data-target=".property_bare .collapse">
|
|
<h2>bare</h2>
|
|
<pre>bare : </pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="property_envopts"> </a>
|
|
<div class="element clickable property protected property_envopts" data-toggle="collapse" data-target=".property_envopts .collapse">
|
|
<h2>envopts</h2>
|
|
<pre>envopts : </pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="\GIT\GitRepo"></a>
|
|
<ul class="breadcrumb">
|
|
<li><a href="index.html"><i class="icon-custom icon-class"></i></a></li>
|
|
|
|
|
|
<li><span class="divider">\</span><a href="\GIT">GIT</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="\GIT\GitRepo">GitRepo</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<footer class="span12">
|
|
Template is built using <a href="https://getbootstrap.com/">Twitter Bootstrap 2</a> and icons provided by
|
|
<a href="https://glyphicons.com/">Glyphicons</a>.<br/>
|
|
Documentation is powered by <a href="https://www.phpdoc.org/">phpDocumentor </a> and<br/>
|
|
generated on Thu, 21 Nov 2024 01:33:23 +0000.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|