Skip to content

Commit

Permalink
[AUTO] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@gigili
gigili committed May 4, 2024
1 parent c41ba28 commit 20f1c17
Show file tree
Hide file tree
Showing 28 changed files with 3,406 additions and 962 deletions.
209 changes: 145 additions & 64 deletions docs/classes/Gac-Routing-DIContainer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
Expand All @@ -19,6 +19,7 @@
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
Expand Down Expand Up @@ -52,7 +53,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Doc
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
Expand Down Expand Up @@ -87,8 +88,9 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Fil
</section>
</aside>

<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/gac.html">Gac</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/gac-routing.html">Routing</a></li>
</ul>
Expand All @@ -108,6 +110,11 @@ <h2 class="phpdocumentor-content__title">

</h2>

<div class="phpdocumentor-label-line">


</div>

<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DIContainer.php"><a href="files/src-dicontainer.html"><abbr title="src/DIContainer.php">DIContainer.php</abbr></a></abbr>
:
Expand All @@ -122,23 +129,36 @@ <h2 class="phpdocumentor-content__title">






<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
<a href="classes/Gac-Routing-DIContainer.html#toc" class="headerlink"><i class="fas fa-link"></i></a>

</h3>










<h4 id="toc-methods">
Methods
<a href="classes/Gac-Routing-DIContainer.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Gac-Routing-DIContainer.html#method_get">get()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Method used for handling dependency injection</dd>

</dl>
</dl>




Expand All @@ -150,6 +170,7 @@ <h3 id="toc">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Gac-Routing-DIContainer.html#methods" class="headerlink"><i class="fas fa-link"></i></a>

</h3>
<article
class="phpdocumentor-element
Expand All @@ -160,6 +181,7 @@ <h3 class="phpdocumentor-elements__header" id="methods">
<h4 class="phpdocumentor-element__name" id="method_get">
get()
<a href="classes/Gac-Routing-DIContainer.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DIContainer.php"><a href="files/src-dicontainer.html"><abbr title="src/DIContainer.php">DIContainer.php</abbr></a></abbr>
Expand All @@ -174,6 +196,8 @@ <h4 class="phpdocumentor-element__name" id="method_get">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$arguments</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>

<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>It receives the class name that will be checked if it has any parameters that need to be injected
and a list of already defined/created arguments to be injected. It will than use the Reflection class API
to check if the provided class has any injectable parameters and if those parameters also require
Expand Down Expand Up @@ -204,80 +228,138 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>



<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Return a new list of arguments that holds manually provided and auto-injected arguments</p>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Return a new list of arguments that holds manually provided and auto-injected arguments</p>
</section>


</article>
</section>


<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';

var code = document.createElement('code');
code.className = 'language-' + language;

pre.textContent = '';

pre.setAttribute('data-line', line)
code.textContent = 'Loading…';

pre.appendChild(code);

var xhr = new XMLHttpRequest();
</article>
</section>

xhr.open('GET', src, true);
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/DIContainer.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>

xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';

const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);

var xhr = new XMLHttpRequest();

xhr.open('GET', src, true);

xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}

if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;

Prism.highlightElement(code);
return;
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;

if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';

if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
}
};

xhr.send(null);
});
}

var modals = document.querySelectorAll("[data-modal]");

modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
code.textContent = '✖ Error: An unknown error occurred';
};

xhr.send(null);
});
}

const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}

modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}

trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");

loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
});
})();
</script>

</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
</section>
<section class="phpdocumentor-on-this-page__sidebar">

<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>

<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/Gac-Routing-DIContainer.html#toc-methods">Methods</a></li>
</ul>
</li>


<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/Gac-Routing-DIContainer.html#method_get">get()</a></li>
</ul>
</li>
</ul>
</section>

</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
Expand All @@ -288,7 +370,6 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
</section>
</section>
</section>
</div>
</div>
<a href="classes/Gac-Routing-DIContainer.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>

Expand Down
Loading

0 comments on commit 20f1c17

Please sign in to comment.