docs: update readme and PHPDoc settings (#120)
* update readme.txt * Test * Test * docs: update documentation * docs: add package tag * docs: add PHPDoc config, alter Composer script Co-authored-by: Rumperuu <me+footnotes@bengoldsworthy.net>
This commit is contained in:
parent
226df694a2
commit
4dd3345685
44 changed files with 10272 additions and 12004 deletions
|
@ -70,7 +70,7 @@
|
|||
|
||||
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
||||
<ul class="phpdocumentor-breadcrumbs">
|
||||
<li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
|
||||
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
|
||||
</ul>
|
||||
|
||||
<article class="phpdocumentor-element -class">
|
||||
|
@ -85,7 +85,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">22</span>
|
||||
<span class="phpdocumentor-element-found-in__line">17</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts data types and Footnotes specific values.</p>
|
||||
|
@ -99,15 +99,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -132,47 +123,47 @@
|
|||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_debug">debug()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Displays a Variable.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_getArrow">getArrow()</a>
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_get_arrow">get_arrow()</a>
|
||||
<span>
|
||||
: array<string|int, mixed>|string </span>
|
||||
</dt>
|
||||
<dd>Get a html Array short code depending on Arrow-Array key index.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_Index">Index()</a>
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_index">index()</a>
|
||||
<span>
|
||||
: string </span>
|
||||
</dt>
|
||||
<dd>Converts a integer into the user-defined counter style for the footnotes.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toBool">toBool()</a>
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_bool">to_bool()</a>
|
||||
<span>
|
||||
: bool </span>
|
||||
</dt>
|
||||
<dd>Converts a string depending on its value to a boolean.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toArabicLeading">toArabicLeading()</a>
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_arabic_leading">to_arabic_leading()</a>
|
||||
<span>
|
||||
: string </span>
|
||||
</dt>
|
||||
<dd>Converts an integer to a leading-0 integer.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toLatin">toLatin()</a>
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_latin">to_latin()</a>
|
||||
<span>
|
||||
: string </span>
|
||||
</dt>
|
||||
<dd>Converts an integer into latin ascii characters, either lower or upper-case.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toRomanic">toRomanic()</a>
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_romanic">to_romanic()</a>
|
||||
<span>
|
||||
: string </span>
|
||||
</dt>
|
||||
|
@ -204,25 +195,26 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">204</span>
|
||||
<span class="phpdocumentor-element-found-in__line">196</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Displays a Variable.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">debug</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$p_mixed_Value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">debug</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$p_mixed_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_mixed_Value</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_mixed_value</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
<section class="phpdocumentor-description"></section>
|
||||
<section class="phpdocumentor-description"><p>The variable to display.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
@ -234,15 +226,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -254,7 +237,7 @@
|
|||
</dl>
|
||||
|
||||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">mixed</span>
|
||||
<span class="phpdocumentor-signature__response_type">void</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -266,28 +249,28 @@
|
|||
-public
|
||||
-static "
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="method_getArrow">
|
||||
getArrow()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_getArrow" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="method_get_arrow">
|
||||
get_arrow()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_get_arrow" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">182</span>
|
||||
<span class="phpdocumentor-element-found-in__line">172</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Get a html Array short code depending on Arrow-Array key index.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getArrow</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_Index</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|string</span></code>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_arrow</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_index</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_Index</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_index</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
||||
= <span class="phpdocumentor-signature__argument__default-value">-1</span> </dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
@ -304,15 +287,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -337,28 +311,28 @@
|
|||
-public
|
||||
-static "
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="method_Index">
|
||||
Index()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_Index" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="method_index">
|
||||
index()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_index" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">36</span>
|
||||
<span class="phpdocumentor-element-found-in__line">30</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts a integer into the user-defined counter style for the footnotes.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">Index</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_Index</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_ConvertStyle</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">"arabic_plain"</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">index</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_index</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_convert_style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'arabic_plain'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_Index</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_index</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
@ -367,9 +341,9 @@
|
|||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_str_ConvertStyle</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_str_convert_style</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
||||
= <span class="phpdocumentor-signature__argument__default-value">"arabic_plain"</span> </dt>
|
||||
= <span class="phpdocumentor-signature__argument__default-value">'arabic_plain'</span> </dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
<section class="phpdocumentor-description"><p>Style of the new/converted Index.</p>
|
||||
</section>
|
||||
|
@ -384,15 +358,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -428,28 +393,28 @@
|
|||
-public
|
||||
-static "
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="method_toBool">
|
||||
toBool()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toBool" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="method_to_bool">
|
||||
to_bool()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_bool" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">158</span>
|
||||
<span class="phpdocumentor-element-found-in__line">149</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts a string depending on its value to a boolean.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">toBool</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_Value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_bool</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_str_Value</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_str_value</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
@ -466,15 +431,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -499,28 +455,28 @@
|
|||
-private
|
||||
-static "
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="method_toArabicLeading">
|
||||
toArabicLeading()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toArabicLeading" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="method_to_arabic_leading">
|
||||
to_arabic_leading()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_arabic_leading" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">95</span>
|
||||
<span class="phpdocumentor-element-found-in__line">87</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts an integer to a leading-0 integer.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">private</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">toArabicLeading</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_Value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_arabic_leading</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_Value</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_value</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
@ -537,15 +493,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -570,21 +517,21 @@
|
|||
-private
|
||||
-static "
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="method_toLatin">
|
||||
toLatin()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toLatin" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="method_to_latin">
|
||||
to_latin()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_latin" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">64</span>
|
||||
<span class="phpdocumentor-element-found-in__line">57</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts an integer into latin ascii characters, either lower or upper-case.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">private</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">toLatin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_Value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$p_bool_UpperCase</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_latin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Function available from A to ZZ ( means 676 footnotes at 1 page possible).</p>
|
||||
</section>
|
||||
|
@ -592,7 +539,7 @@
|
|||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_Value</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_value</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
@ -601,7 +548,7 @@
|
|||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_bool_UpperCase</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
@ -618,15 +565,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -650,28 +588,28 @@
|
|||
-private
|
||||
-static "
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="method_toRomanic">
|
||||
toRomanic()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_toRomanic" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="method_to_romanic">
|
||||
to_romanic()
|
||||
<a href="classes/MCI-Footnotes-Convert.html#method_to_romanic" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="class/convert.php"><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">114</span>
|
||||
<span class="phpdocumentor-element-found-in__line">106</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Converts an integer to a romanic letter.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">private</span>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">toRomanic</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_Value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$p_bool_UpperCase</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_romanic</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$p_int_value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_Value</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_int_value</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
@ -680,11 +618,13 @@
|
|||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_bool_UpperCase</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
||||
<span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Whether to uppercase.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
@ -695,15 +635,6 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
@ -718,7 +649,7 @@
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.2.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>optionally lowercase (code from Latin) 2020-12-12T1538+0100</p>
|
||||
<section class="phpdocumentor-description"><p>optionally lowercase (code from Latin)</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
|
|
Reference in a new issue