mcndave/lean-api
1
0 Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

- Work done to clarify a bit every section, and a hugh code refractoring also was made to the code base.

Browse Source
This commit is contained in:
Dave Mc Nicoll committed 2024-11-11 19:54:22 +00:00
1 parent a98e46c343
commit 6b655bdc76
15 files changed
+260 -145
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

view/lean-api/entity_descriptor.phtml
+76
View File
@@ -0,0 +1,76 @@
{% function yesOrNo(bool $toggle) : void %}
<span style="color: {{ $toggle ? 'green' : '#ac1b1b' }}">{{ $toggle ? 'oui' : 'non' }}</span>
{% endfunction %}
{% function length(int|null $length): void %}
<span style="color:{{ $length ? 'black' : 'gray' }}">{{ $length ?? "non-défini" }}</span>
{% endfunction %}
<div class="entities">
{% foreach $entities as $name => $entity %}
<div class="entity-wrapper" style="padding-left: 15px;border-left: 3px solid #eaa1af;">
<h4 class='entity-name'>{{ $entity['className'] }}</h4>
<div class='description'>{{ $entity['description'] }}</div>
<hr style="margin-top:15px">
<h5>Champs</h5>
<ol class='fields'>
{% foreach $entity['fields'] as $field %}
<li class="odd-even">
<div class="title">
<div><strong style="font-family:monospace">${{ $field['name'] }}</strong> <span style='margin-left:15px'>{{ $field['description'] }}</span></div>
</div>
<div class="field-desc" style="margin-top:10px;;background:#fff;padding:5px;font-size:0.9em">
<div style="padding:5px"><u>Champ SQL</u> : {{ $field['fieldName'] }}</div>
<div style="padding:5px"><u>Attribut</u> : {{ $field['tag'] }}</div>
<div style="padding:5px"><u>Type(s)</u> : {{ $field['type'] }}</div>
<div style="padding:5px"><u>Nullable</u> {{ yesOrNo($field['allowNulls']) }}</div>
<div style="padding:5px"><u>Taille</u> : {{ length($field['length']) }}</div>
<div style="padding:5px"><u>Lecture seule</u> : {{ yesOrNo($field['readonly']) }}</div>
</div>
</li>
{% endforeach %}
</ol>
</div>
<div class="search-request-wrapper">
<h4 class='search-request-name'>{{ $entity['className'] }}::searchRequest()</h4>
<h5>Requêtes</h5>
<div class='description' style="margin-bottom:10px">{{ $entity['searchRequestDescription'] }}</div>
<ol class='requests'>
{% foreach $entity['searchRequestFields'] as $field %}
<li class="odd-even">
<div class="title">
<div><strong style="font-family:monospace">{{ $field['name'] }}</strong> <span style='margin-left:15px'>{{ $field['description'] }}</span></div>
</div>
<div class="field-desc" style="margin-top:10px;;background:#fff;padding:5px;font-size:0.9em">
<div><u>Paramètre de requête (GET)</u> : {{ $field['parameter'] }}</div>
<div><u>Attribut</u> : {{ $field['tag'] }}</div>
<div><u>Type(s)</u> : {{ $field['type'] }}</div>
<div><u>Nullable</u> : {{ yesOrNo($field['allowNulls']) }}</div>
{% if $field['default'] !== "" %}
<div><u>Valeur par défault</u> : {{ $this->displayValue($field['default']) }}</div>
{% endif %}
</div>
</li>
{% endforeach %}
</ol>
</div>
{% endforeach %}
</div>
<style>
.entity-name {background:#eaa1af}
.entity-wrapper ol {background: #f0ddcd;}
.entity-wrapper li {border-color: #ae8585;}
.search-request-name {background: #b6e6ae}
.search-request-wrapper {padding-left: 15px;border-left: 3px solid #72886a;}
.search-request-wrapper ol {background: #d8f0cd;}
.search-request-wrapper li {border-color: #72886a;}
</style>
view/lean-api/form_descriptor.phtml
+38
View File
@@ -0,0 +1,38 @@
{% function yesOrNo(bool $toggle) : void %}
<span style="color: {{ $toggle ? 'green' : '#ac1b1b' }}">{{ $toggle ? 'oui' : 'non' }}</span>
{% endfunction %}
<div class="forms">
{% foreach $forms as $form %}
<div class="single-form" style="padding-left:15px;border-left: 3px solid #9ce6bc;">
<h4 style="background:#9ce6bc" class='form-name'>{{ $form['className'] }}</h4>
<div class='description'>{{ $form['description'] }}</div>
<hr style="margin-top:15px">
<h5>Champs</h5>
<ol class='fields'>
{% foreach $form['fields'] as $field %}
<li class="odd-even">
<div class="title">
<div>
<strong style="font-family:monospace">{{ $field['name'] }}</strong>
<span style='margin-left:15px'>{{ $field['description'] }}</span>
</div>
</div>
<div class="field-desc" style="margin-top:10px;;background:#fff;padding:5px;font-size:0.9em">
<div><u>Variable POST / champ JSON</u> : {{ $field['name'] }}</div>
<div><u>Type(s)</u> : {{ $field['type'] }}</div>
<div><u>Nullable</u> : {{ yesOrNo($field['allowNulls']) }}</div>
<div><u>Pattern regex</u> : {{ $field['regexPattern'] }}</div>
<div><u>Taille min.</u> : {{ $field['minLength'] }}</div>
<div><u>Taille max.</u> : {{ $field['maxLength'] }}</div>
<div><u>Exemple</u> : {{ $field['example'] }}</div>
</div>
</li>
{% endforeach %}
</ol>
</div>
{% endforeach %}
</div>
view/lean-api/route_descriptor.phtml
+9
View File
@@ -0,0 +1,9 @@
<ul>
{% foreach $routes as $route %}
<li>
<span><a href="{{ $route['route'] }}" title="{{ $route['path'] }}" style='font-family:monospace;font-size:.85em'>{{ $route['cleaned'] }}</a> - {{ $route['description'] }}</span>
<span style='color:#ac1b1b'>{{ $route['methods'] }}</span>
<small style="color:#374300">{{ $route['name'] }}</small>
</li>
{% endforeach %}
</ul>
view/lean/layout/docs.phtml
+60
View File
@@ -0,0 +1,60 @@
{% title "Documentation" %}
<!DOCTYPE html>
<html lang="fr">
{% section "head" %}
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<title>{% section "head.title" %}{% lang 'api.application_name' %} - {{ title() }}{% endsection %}</title>
<link rel="apple-touch-icon" sizes="180x180" href="{% asset 'static/lean-api/favicon/apple-touch-icon.png' %}">
<link rel="icon" type="image/png" sizes="96x96" href="{% asset 'static/lean-api/favicon/favicon-96x96.png' %}">
<link rel="manifest" href="{% asset 'static/lean-api/favicon/site.webmanifest' %}">
<link rel="mask-icon" href="{% asset 'static/lean-api/favicon/safari-pinned-tab.svg' %}" color="#5bbad5">
<meta name="msapplication-TileColor" content="#2d89ef">
<meta name="theme-color" content="#ffffff">
<style>
a{color:#e44a00}h3{background:#e1e1e1;padding:6px 12px}ul{background:#e9e9fd;padding-top:20px;padding-bottom:20px;border:1px solid #e3e3ec}ul li + li{margin-top:8px}li > em{font-size:0.75rem;color:gray}body{font-family:Helvetica, 'Helvetica Neuve', Arial, Tahoma, sans-serif;font-size:17px;color:#333}h1,h2,h3,h4,h5,h6{color:#222;margin:0 0 20px}dl,ol,p,pre,table,ul{margin:0 0 20px}h1,h2,h3{line-height:1.1}h1{font-size:20px;text-align:right;color:#387eea;font-weight:bold}h2{color:#393939}h3,h4,h5,h6{color:#494949}h3{display:flex}h3 > code{margin-right:5px;color:#b52dac}h3 > strong{margin-left:auto}a{color:#39c;font-weight:400;text-decoration:none}a small{font-size:11px;color:#777;margin-top:-0.6em;display:block}.wrapper{width:860px;margin:0 auto}blockquote{border-left:1px solid #e5e5e5;margin:0;padding:0 0 0 20px;font-style:italic}code,pre{font-size:12px}pre{padding:8px 15px;background:#f8f8f8;border-radius:5px;border:1px solid #e5e5e5;overflow-x:auto}table{width:100%;border-collapse:collapse}td,th{text-align:left;padding:5px 10px;border-bottom:1px solid #e5e5e5}dt{color:#444;font-weight:700}th{color:#444}img{max-width:100%}header{width:270px;float:left;position:fixed}header ul{list-style:none;height:40px;padding:0;background:#eee;background:-moz-linear-gradient(top, #f8f8f8 0%, #dddddd 100%);background:-webkit-gradient(linear, left top, left bottom, color-stop(0%,#f8f8f8), color-stop(100%,#dddddd));background:-webkit-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);background:-o-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);background:-ms-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);background:linear-gradient(top, #f8f8f8 0%,#dddddd 100%);border-radius:5px;border:1px solid #d2d2d2;box-shadow:inset #fff 0 1px 0, inset rgba(0,0,0,0.03) 0 -1px 0;width:270px}header li{width:89px;float:left;border-right:1px solid #d2d2d2;height:40px}header ul a{line-height:1;font-size:11px;color:#999;display:block;text-align:center;padding-top:6px;height:40px}strong{color:#222;font-weight:700}header ul li + li{width:88px;border-left:1px solid #fff}header ul li + li + li{border-right:none;width:89px}header ul a strong{font-size:14px;display:block;color:#222}section{width:500px;float:right;padding-bottom:50px}small{font-size:11px}hr{border:0;background:#e5e5e5;height:1px;margin:0 0 20px}footer{width:270px;float:left;position:fixed;bottom:50px}@media print, screen and (max-width: 960px){div.wrapper{width:auto;margin:0}footer,header,section{float:none;position:static;width:auto}header{padding-right:320px}section{border:1px solid #e5e5e5;border-width:1px 0;padding:20px 0;margin:0 0 20px}header a small{display:inline}header ul{position:absolute;right:50px;top:52px}}@media print, screen and (max-width: 720px){body{word-wrap:break-word}header{padding:0}header p.view,header ul{position:static}code,pre{word-wrap:normal}}@media print, screen and (max-width: 480px){body{padding:15px}header ul{display:none}}@media print{body{padding:0.4in;font-size:12pt;color:#444}}#wrapper{margin-left:auto;margin-right:auto;background-color:white}.ca-menu{list-style:none;padding:0;margin:20px auto}#navi{padding-top:15px;padding-right:15px;float:right;width:420px}#title{padding-left:15px;width:460px;float:left}div.clear{clear:both}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.2em}h5{font-size:1em;font-weight:bold}h6{font-size:1em;font-weight:bold}h1,h2,h3,h4,h5,h6{font-weight:normal;line-height:2.5rem;margin:1rem 0}.post p{max-width:580px}ol.list,ul.list{padding-left:3.333em;max-width:580px}.post h2{border-bottom:1px solid #EDEDED}h1:nth-child(1),h2:nth-child(1),h3:nth-child(1),h4:nth-child(1),h5:nth-child(1),h6:nth-child(1){margin-top:0}body{padding:1em}#wrapper{padding:1em}@media (min-width: 43.75em){body{padding:2em}#wrapper{padding:2em}}@media (min-width: 62em){body{padding:3em}#wrapper{max-width:740px;padding:3em}}
ol{background: #eff4f2;padding-top:20px;padding-bottom:20px;border:1px solid #e3e3ec}
h4{background:#e0f7ed;padding:6px 12px; font-weight: bold!important;font-size:100%;margin-top:0}
h5{text-decoration: underline}
h3 {display: flex;align-items: center;height: 60px;padding: 0 15px 0 15px;font-variant: small-caps;}
li.odd-even{border-top:1px solid #ccc;margin:10px 0;padding:15px 15px 10px 5px}
li.odd-even:first-child{border:0}
input, button {padding:5px; font-size:1em;margin-top:10px}
ul {background:#f4f4f4; list-style: none; padding-left:20px}
ul ul {margin: 0;border: 0;padding: 5px 30px;}
ul li + li {margin-top: 12px;}
ol .title { display: flex;justify-content: space-between;background: #ffffffb2;padding: 9px 5px;border: 1px solid #fff;}
.field-desc > div {padding:5px;}
.forms ol {background: #ccf2dd;}
.forms li {border-color: #85ae97;}
</style>
</head>
{% endsection %}
{% section "body" %}
<body>
{% section "body.header" %}{% endsection %}
{% section "header" %}{% endsection %}
{% section "message" %}
{% view "lean/widget/message" %}
{% endsection %}
<main role="main" class="content">
{% section "main" %}
<div>{{= $markdown }}</div>
{% endsection %}
</main>
<footer>{% section "footer" %}{% endsection %}</footer>
{% section "body.footer" %}{% endsection %}
</body>
{% endsection %}
</html>