docu_system/classes/GIT-Git.html
Ulf Gebhardt 50de610cf6
generated new version
missing changes

more

more

more
2024-11-21 02:49:15 +01:00

655 lines
41 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 &raquo; \GIT\Git
</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>&#160;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>&#160;Errors
</a>
</li>
<li>
<a href="markers.html">
<i class="icon-list-alt"></i>&#160;Markers
</a>
</li>
<li>
<a href="deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="go_to_top">
<a href="#___" style="color: inherit">Back to top&#160;&#160;<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_clone_remote" title="clone_remote :: Clones a remote repo into a directory and then returns a GitRepo object
for the newly created local repo">
<span class="description">Clones a remote repo into a directory and then returns a GitRepo object
for the newly created local repo</span><pre>clone_remote</pre>
</a>
</li>
<li class="method public">
<a href="#method_create" title="create :: Create a new git repository">
<span class="description">Create a new git repository</span><pre>create</pre>
</a>
</li>
<li class="method public">
<a href="#method_get_bin" title="get_bin :: Gets git executable path">
<span class="description">Gets git executable path</span><pre>get_bin</pre>
</a>
</li>
<li class="method public">
<a href="#method_is_repo" title="is_repo :: Checks if a variable is an instance of GitRepo">
<span class="description">Checks if a variable is an instance of GitRepo</span><pre>is_repo</pre>
</a>
</li>
<li class="method public">
<a href="#method_open" title="open :: Open an existing git repository">
<span class="description">Open an existing git repository</span><pre>open</pre>
</a>
</li>
<li class="method public">
<a href="#method_set_bin" title="set_bin :: Sets git executable path">
<span class="description">Sets git executable path</span><pre>set_bin</pre>
</a>
</li>
<li class="method public">
<a href="#method_windows_mode" title="windows_mode :: Sets up library for use in a default Windows environment">
<span class="description">Sets up library for use in a default Windows environment</span><pre>windows_mode</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
</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>Git</h1>
<small style="display: block; text-align: right">
</small>
<p class="short_description">Git Interface Class</p>
<div class="details">
<div class="long_description">
<p>This class enables the creating, reading, and manipulation
of git repositories.</p>
</div>
<table class="table table-bordered">
<tr>
<th>
class
</th>
<td>
<p>Git</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_clone_remote"></a>
<div class="element clickable method public method_clone_remote" data-toggle="collapse" data-target=".method_clone_remote .collapse">
<h2>Clones a remote repo into a directory and then returns a GitRepo object
for the newly created local repo</h2>
<pre>&amp; clone_remote(mixedrepo_path, mixedremote, 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 a remote to clone from</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>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
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_create"></a>
<div class="element clickable method public method_create" data-toggle="collapse" data-target=".method_create .collapse">
<h2>Create a new git repository</h2>
<pre>&amp; create(mixedrepo_path, mixedsource = 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>
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_get_bin"></a>
<div class="element clickable method public method_get_bin" data-toggle="collapse" data-target=".method_get_bin .collapse">
<h2>Gets git executable path</h2>
<pre>get_bin() : mixed</pre>
<div class="labels">
<span class="label">static</span> </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>
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_is_repo"></a>
<div class="element clickable method public method_is_repo" data-toggle="collapse" data-target=".method_is_repo .collapse">
<h2>Checks if a variable is an instance of GitRepo</h2>
<pre>is_repo(mixedvar) : bool</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 variable</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>var</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
bool</code><p></p>
</div>
</div>
</div>
<a id="method_open"></a>
<div class="element clickable method public method_open" data-toggle="collapse" data-target=".method_open .collapse">
<h2>Open an existing git repository</h2>
<pre>open(mixedrepo_path) : \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 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>
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_set_bin"></a>
<div class="element clickable method public method_set_bin" data-toggle="collapse" data-target=".method_set_bin .collapse">
<h2>Sets git executable path</h2>
<pre>set_bin(stringpath) : mixed</pre>
<div class="labels">
<span class="label">static</span> </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>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
string</code><p><p>executable location</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_windows_mode"></a>
<div class="element clickable method public method_windows_mode" data-toggle="collapse" data-target=".method_windows_mode .collapse">
<h2>Sets up library for use in a default Windows environment</h2>
<pre>windows_mode() : mixed</pre>
<div class="labels">
<span class="label">static</span> </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>
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>
<h3><i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_bin"> </a>
<div class="element clickable property protected property_bin" data-toggle="collapse" data-target=".property_bin .collapse">
<h2>Git executable location</h2>
<pre>bin : string</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
var
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Type(s)</h3>
<code>string</code>
</div>
</div>
</div>
</div>
</div>
<a id="\GIT\Git"></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\Git">Git</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>