Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/docs/classes/footnotes-includes-Convert.html

804 lines
40 KiB
HTML
Raw Normal View History

docs: update documentation
2021-05-01 20:39:33 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
docs: update documentation
2021-08-09 10:27:33 +00:00
<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=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
docs: update documentation
2021-05-01 20:39:33 +00:00
<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" />
docs: update documentation
2021-08-09 10:27:33 +00:00
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
docs: update documentation
2021-05-01 20:39:33 +00:00
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
docs: update documentation
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
docs: update documentation
2021-05-01 20:39:33 +00:00
<ul class="phpdocumentor-list">
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
<li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li>
</ul>
</section>
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
docs: update documentation
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
docs: update documentation
2021-05-02 20:27:53 +00:00
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-includes.html">includes</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Convert
docs: update documentation
2021-05-02 20:27:53 +00:00
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
docs: update documentation
2021-08-09 10:27:33 +00:00
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
docs: update documentation
2021-05-02 20:27:53 +00:00
</ul>
</div>
docs: update documentation
2021-05-01 20:39:33 +00:00
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">20</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Class providing variable type and value conversion functions.</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Convert.html#method_debug">debug()</a>
<span>
docs: update documentation
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays a variable.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Convert.html#method_get_arrow">get_arrow()</a>
<span>
docs: update documentation
2021-05-02 20:27:53 +00:00
&nbsp;: string|array&lt;string|int, string&gt; </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>Get an HTML array short code depending on Arrow-Array key index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Convert.html#method_index">index()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Converts an integer into the user-defined counter style for the footnotes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Convert.html#method_to_bool">to_bool()</a>
<span>
&nbsp;: 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/footnotes-includes-Convert.html#method_to_arabic_leading">to_arabic_leading()</a>
<span>
&nbsp;: 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/footnotes-includes-Convert.html#method_to_latin">to_latin()</a>
<span>
&nbsp;: 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">
docs: update documentation
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-includes-Convert.html#method_to_roman">to_roman()</a>
docs: update documentation
2021-05-01 20:39:33 +00:00
<span>
&nbsp;: string </span>
</dt>
<dd>Converts an integer to a Roman numeral.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/footnotes-includes-Convert.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_debug">
debug()
<a href="classes/footnotes-includes-Convert.html#method_debug" 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/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">113</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Displays a variable.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<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&nbsp;</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>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<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__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The variable to display.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Replace with proper logging/debug functions.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
&mdash;
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_get_arrow">
get_arrow()
<a href="classes/footnotes-includes-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="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">88</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Get an HTML array short code depending on Arrow-Array key index.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$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">string|array&lt;string|int, string&gt;</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$index</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <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">
<section class="phpdocumentor-description"><p>Index representing the arrow. If empty, all arrows are specified.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.3.2</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Review.</p>
</section>
docs: update documentation
2021-05-02 20:27:53 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Single return type.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">string|array&lt;string|int, string&gt;</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
&mdash;
<section class="phpdocumentor-description"><p>Array of all arrows if index is empty, otherwise HTML tag of a specific arrow.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_index">
index()
<a href="classes/footnotes-includes-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="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">31</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Converts an integer into the user-defined counter style for the footnotes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$index</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$convert_style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;arabic_plain&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$index</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Index to be converted.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$convert_style</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;arabic_plain&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Counter style to use.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-description"><p>The index converted to the defined counter style.</p>
docs: update documentation
2021-05-01 20:39:33 +00:00
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_to_bool">
to_bool()
<a href="classes/footnotes-includes-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="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">58</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<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>
docs: update documentation
2021-05-02 20:27:53 +00:00
<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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$value</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>String to be converted to boolean.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.0-beta</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Replace with built-in type casting.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>Boolean value represented by the string.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_to_arabic_leading">
to_arabic_leading()
<a href="classes/footnotes-includes-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="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">181</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<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>
docs: update documentation
2021-05-02 20:27:53 +00:00
<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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$value</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Value to be converted.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.0-gamma</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Replace with built-in string formatting.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>Value with a leading zero.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_to_latin">
to_latin()
<a href="classes/footnotes-includes-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="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">150</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<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>
docs: update documentation
2021-05-02 20:27:53 +00:00
<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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"><p>This function works from values A–ZZ (meaning there is a limit of 676
gootnotes per Page).</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$value</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Value to be converted.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$upper_case</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Whether to convert the value to upper-case.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.0-gamma</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Replace with built-in char casting.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-private
-static "
>
docs: update documentation
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="method_to_roman">
to_roman()
<a href="classes/footnotes-includes-Convert.html#method_to_roman" class="headerlink"><i class="fas fa-link"></i></a>
docs: update documentation
2021-05-01 20:39:33 +00:00
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">196</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Converts an integer to a Roman numeral.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_roman</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$value</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Value to be converted.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$upper_case</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Whether to convert the value to upper-case.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.0-gamma</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
</section>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
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");
});
});
});
});
</script>
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
<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>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/footnotes-includes-Convert.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
docs: update documentation
2021-08-09 10:27:33 +00:00
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
docs: update documentation
2021-05-01 20:39:33 +00:00
</body>
</html>
Reference in a new issue Copy permalink