Verified Commit 4c8bf2ca authored by Elias Häußler's avatar Elias Häußler 🐛

[TASK] Switch to Gitlab repository

parent df321b5b
Pipeline #50 passed with stages
in 49 seconds
......@@ -22,6 +22,10 @@ return new \Sami\Sami($iterator, [
'title' => 'elias-haeussler.de API',
'build_dir' => DOCS_PATH . '/__build__/%version%',
'cache_dir' => DOCS_PATH . '/cache/%version%',
'remote_repository' => new \Sami\RemoteRepository\GitHubRemoteRepository('eliashaeussler/api', ROOT_PATH),
'remote_repository' => new \Sami\RemoteRepository\GitLabRemoteRepository(
'eliashaeussler/api',
ROOT_PATH,
'https://gitlab.elias-haeussler.de/'
),
'default_opened_level' => 2,
]);
......@@ -6,7 +6,9 @@ Version numbers are based on [Semantic Versioning](https://semver.org).
## [Unreleased]
### Updated
- Switch to Gitlab repository and update code documentation with new repository URL
......
......@@ -57,7 +57,7 @@ The API serves different endpoints which can be accessed from various clients.
Clone the repository first:
```bash
git clone git@github.com:eliashaeussler/api.git
git clone http://gitlab.elias-haeussler.de/eliashaeussler/api.git
```
Install dependencies (`composer` needs to be installed for this):
......
......@@ -100,7 +100,7 @@
</div>
<p>abstract class
<strong>BaseController</strong> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php">View source</a>)
<strong>BaseController</strong> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php">View source</a>)
</p>
......@@ -281,7 +281,7 @@
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L47">line 47</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L47">line 47</a></div>
<code>final
<strong>__construct</strong>(string $route)
</code>
......@@ -314,7 +314,7 @@ calling <code>static::initializeRequest()</code>.</p>
</div>
<div class="method-item">
<h3 id="method_initializeRequest">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L62">line 62</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L62">line 62</a></div>
<code> abstract protected
<strong>initializeRequest</strong>()
</code>
......@@ -336,7 +336,7 @@ can also be used to pre-check API conditions and user authentications.</p>
</div>
<div class="method-item">
<h3 id="method_call">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L72">line 72</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L72">line 72</a></div>
<code>
<strong>call</strong>()
</code>
......@@ -367,7 +367,7 @@ validity and authenticity inside this method as it differs from different reques
</div>
<div class="method-item">
<h3 id="method_buildMessage">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L94">line 94</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L94">line 94</a></div>
<code> string
<strong>buildMessage</strong>(string $type, mixed $arg1, array ...$_)
</code>
......@@ -428,7 +428,7 @@ class. The first parameter <code>$type</code> defines the name of the method to
</div>
<div class="method-item">
<h3 id="method_readRequestBody">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L125">line 125</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L125">line 125</a></div>
<code> protected
<strong>readRequestBody</strong>()
</code>
......@@ -449,7 +449,7 @@ class. The first parameter <code>$type</code> defines the name of the method to
</div>
<div class="method-item">
<h3 id="method_readRequestHeaders">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L137">line 137</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L137">line 137</a></div>
<code> protected
<strong>readRequestHeaders</strong>()
</code>
......@@ -472,7 +472,7 @@ from the header name.</p> </div>
</div>
<div class="method-item">
<h3 id="method_matchesRoute">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L162">line 162</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L162">line 162</a></div>
<code> protected bool
<strong>matchesRoute</strong>(string $route)
</code>
......@@ -512,7 +512,7 @@ from the header name.</p> </div>
</div>
<div class="method-item">
<h3 id="method_getRequestBody">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L172">line 172</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L172">line 172</a></div>
<code> string
<strong>getRequestBody</strong>()
</code>
......@@ -542,7 +542,7 @@ from the header name.</p> </div>
</div>
<div class="method-item">
<h3 id="method_getRequestHeaders">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L182">line 182</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L182">line 182</a></div>
<code> array
<strong>getRequestHeaders</strong>()
</code>
......@@ -572,7 +572,7 @@ from the header name.</p> </div>
</div>
<div class="method-item">
<h3 id="method_getRequestHeader">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L198">line 198</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L198">line 198</a></div>
<code> string
<strong>getRequestHeader</strong>(string $header, bool $useRawInput = false)
</code>
......@@ -619,7 +619,7 @@ by setting <code>$useRawInput</code> to <code>true</code>.</p>
</div>
<div class="method-item">
<h3 id="method_setRoute">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L214">line 214</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Controller/BaseController.php#L214">line 214</a></div>
<code>
<strong>setRoute</strong>(string $route)
</code>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>AuthenticationException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Exception/AuthenticationException.php">View source</a>)
<strong>AuthenticationException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Exception/AuthenticationException.php">View source</a>)
</p>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>ClassNotFoundException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Exception/ClassNotFoundException.php">View source</a>)
<strong>ClassNotFoundException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Exception/ClassNotFoundException.php">View source</a>)
</p>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>EmptyControllerException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Exception/EmptyControllerException.php">View source</a>)
<strong>EmptyControllerException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Exception/EmptyControllerException.php">View source</a>)
</p>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>EmptyParametersException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Exception/EmptyParametersException.php">View source</a>)
<strong>EmptyParametersException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Exception/EmptyParametersException.php">View source</a>)
</p>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>InvalidControllerException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Exception/InvalidControllerException.php">View source</a>)
<strong>InvalidControllerException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Exception/InvalidControllerException.php">View source</a>)
</p>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>InvalidRequestException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Exception/InvalidRequestException.php">View source</a>)
<strong>InvalidRequestException</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Exception/InvalidRequestException.php">View source</a>)
</p>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>Message</strong> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php">View source</a>)
<strong>Message</strong> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php">View source</a>)
</p>
......@@ -230,7 +230,7 @@ renderer is provided through the <code>Template</code> class.</p>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L45">line 45</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L45">line 45</a></div>
<code>
<strong>__construct</strong>()
</code>
......@@ -260,7 +260,7 @@ renderer is provided through the <code>Template</code> class.</p>
</div>
<div class="method-item">
<h3 id="method_message">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L61">line 61</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L61">line 61</a></div>
<code> string
<strong>message</strong>(string $header, string $body, string $type = self::MESSAGE_TYPE_NOTICE)
</code>
......@@ -311,7 +311,7 @@ body will be printed without formatting. Otherwise, the default template will be
</div>
<div class="method-item">
<h3 id="method_success">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L84">line 84</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L84">line 84</a></div>
<code> string
<strong>success</strong>(string $header, string $body)
</code>
......@@ -356,7 +356,7 @@ body will be printed without formatting. Otherwise, the default template will be
</div>
<div class="method-item">
<h3 id="method_notice">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L96">line 96</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L96">line 96</a></div>
<code> string
<strong>notice</strong>(string $header, string $body)
</code>
......@@ -401,7 +401,7 @@ body will be printed without formatting. Otherwise, the default template will be
</div>
<div class="method-item">
<h3 id="method_warning">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L108">line 108</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L108">line 108</a></div>
<code> string
<strong>warning</strong>(string $header, string $body)
</code>
......@@ -446,7 +446,7 @@ body will be printed without formatting. Otherwise, the default template will be
</div>
<div class="method-item">
<h3 id="method_error">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L121">line 121</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Message.php#L121">line 121</a></div>
<code> string
<strong>error</strong>(<a target="_blank" href="http://php.net/Exception">Exception</a> $object)
</code>
......
......@@ -100,7 +100,7 @@
</div>
<p> class
<strong>Template</strong> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php">View source</a>)
<strong>Template</strong> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php">View source</a>)
</p>
......@@ -211,7 +211,7 @@
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L49">line 49</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L49">line 49</a></div>
<code>
<strong>__construct</strong>(string $file = self::DEFAULT_TEMPLATE)
</code>
......@@ -252,7 +252,7 @@ template for rendering by loading and storing it inside the class instance.</p>
</div>
<div class="method-item">
<h3 id="method_initializeTwig">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L60">line 60</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L60">line 60</a></div>
<code> protected
<strong>initializeTwig</strong>()
</code>
......@@ -273,7 +273,7 @@ template for rendering by loading and storing it inside the class instance.</p>
</div>
<div class="method-item">
<h3 id="method_loadTemplate">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L76">line 76</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L76">line 76</a></div>
<code> protected
<strong>loadTemplate</strong>()
</code>
......@@ -303,7 +303,7 @@ template for rendering by loading and storing it inside the class instance.</p>
</div>
<div class="method-item">
<h3 id="method_renderTemplate">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L87">line 87</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Frontend/Template.php#L87">line 87</a></div>
<code> string
<strong>renderTemplate</strong>(array $parameters = [])
</code>
......
......@@ -100,7 +100,7 @@
</div>
<p>abstract class
<strong>BaseRoute</strong> (<a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Routing/BaseRoute.php">View source</a>)
<strong>BaseRoute</strong> (<a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Routing/BaseRoute.php">View source</a>)
</p>
......@@ -174,7 +174,7 @@
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at <a href="https://github.com/eliashaeussler/api/blob/1.0.0/src/Routing/BaseRoute.php#L34">line 34</a></div>
<div class="location">at <a href="https://gitlab.elias-haeussler.de/eliashaeussler/api/blob/1.0.0/src/Routing/BaseRoute.php#L34">line 34</a></div>
<code>final
<strong>__construct</strong>(<a href="../../../EliasHaeussler/Api/Controller/BaseController.html"><abbr title="EliasHaeussler\Api\Controller\BaseController">BaseController</abbr></a> $controller)
</code>
......@@ -206,7 +206,7 @@ processing the concrete initialization by calling <code>static::initializeReques
</div>
<div class="method-item">