Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update documentation

Browse source
This commit is contained in:
Ben Goldsworthy 2021-05-02 21:27:53 +01:00
parent ebcba982e6
commit 5afd55dba6
56 changed files with 5566 additions and 5217 deletions
Download patch file Download diff file Expand all files Collapse all files

122
docs/classes/footnotes-includes-Template.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,13 @@
Template
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-includes.html">includes</a></li>
</ul>
</div>
</h2>
@ -91,7 +106,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Class defining template rendering.</p>
@ -147,14 +162,14 @@ file content.</p>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Template.html#constant_C_STR_DASHBOARD">C_STR_DASHBOARD</a>
<a href="classes/footnotes-includes-Template.html#constant_DASHBOARD">DASHBOARD</a>
<span>
&nbsp;= &#039;admin/partials&#039; </span>
</dt>
<dd>Directory name for dashboard partials.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Template.html#constant_C_STR_PUBLIC">C_STR_PUBLIC</a>
<a href="classes/footnotes-includes-Template.html#constant_PUBLIC">PUBLIC</a>
<span>
&nbsp;= &#039;public/partials&#039; </span>
</dt>
@ -168,14 +183,14 @@ file content.</p>
<dd>Plugin Directory</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-includes-Template.html#property_a_str_original_content">$a_str_original_content</a>
<a href="classes/footnotes-includes-Template.html#property_original_content">$original_content</a>
<span>
&nbsp;: string </span>
&nbsp;: string|null </span>
</dt>
<dd>Contains the content of the template after initialize.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-includes-Template.html#property_a_str_replaced_content">$a_str_replaced_content</a>
<a href="classes/footnotes-includes-Template.html#property_replaced_content">$replaced_content</a>
<span>
&nbsp;: string </span>
</dt>
@ -184,7 +199,7 @@ file content.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Template.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Class Constructor. Reads and loads the template file without replace any placeholder.</dd>
@ -198,7 +213,7 @@ file content.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Template.html#method_get_template">get_template()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: string|bool </span>
</dt>
<dd>Get the template.</dd>
@ -212,7 +227,7 @@ file content.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Template.html#method_reload">reload()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Reloads the original content of the template file.</dd>
@ -234,15 +249,15 @@ file content.</p>
<a href="classes/footnotes-includes-Template.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_DASHBOARD">
C_STR_DASHBOARD
<a href="classes/footnotes-includes-Template.html#constant_C_STR_DASHBOARD" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_DASHBOARD">
DASHBOARD
<a href="classes/footnotes-includes-Template.html#constant_DASHBOARD" 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-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Directory name for dashboard partials.</p>
@ -250,7 +265,7 @@ file content.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_DASHBOARD</span>
<span class="phpdocumentor-signature__name">DASHBOARD</span>
= <span class="phpdocumentor-signature__default-value">&#039;admin/partials&#039;</span>
</code>
@ -276,15 +291,15 @@ file content.</p>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PUBLIC">
C_STR_PUBLIC
<a href="classes/footnotes-includes-Template.html#constant_C_STR_PUBLIC" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_PUBLIC">
PUBLIC
<a href="classes/footnotes-includes-Template.html#constant_PUBLIC" 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-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Directory name for public partials.</p>
@ -292,7 +307,7 @@ file content.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PUBLIC</span>
<span class="phpdocumentor-signature__name">PUBLIC</span>
= <span class="phpdocumentor-signature__default-value">&#039;public/partials&#039;</span>
</code>
@ -341,7 +356,7 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Plugin Directory</p>
@ -379,24 +394,24 @@ file content.</p>
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_a_str_original_content">
$a_str_original_content
<a href="classes/footnotes-includes-Template.html#property_a_str_original_content" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_original_content">
$original_content
<a href="classes/footnotes-includes-Template.html#property_original_content" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Contains the content of the template after initialize.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$a_str_original_content</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$original_content</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section>
@ -426,16 +441,16 @@ file content.</p>
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_a_str_replaced_content">
$a_str_replaced_content
<a href="classes/footnotes-includes-Template.html#property_a_str_replaced_content" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_replaced_content">
$replaced_content
<a href="classes/footnotes-includes-Template.html#property_replaced_content" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Contains the content of the template after initialize with replaced place holders.</p>
@ -443,7 +458,7 @@ file content.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$a_str_replaced_content</span>
<span class="phpdocumentor-signature__name">$replaced_content</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section>
@ -486,21 +501,21 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
<span class="phpdocumentor-element-found-in__line">81</span>
</aside>
<p class="phpdocumentor-summary">Class Constructor. Reads and loads the template file without replace any placeholder.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_file_type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_file_name</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">$p_str_extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file_type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file_name</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">$extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</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_str_file_type</span>
<span class="phpdocumentor-signature__argument__name">$file_type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -509,7 +524,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_file_name</span>
<span class="phpdocumentor-signature__argument__name">$file_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -518,7 +533,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_extension</span>
<span class="phpdocumentor-signature__argument__name">$extension</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
@ -555,7 +570,7 @@ file content.</p>
</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>
&mdash;
<section class="phpdocumentor-description"></section>
@ -633,21 +648,21 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">183</span>
<span class="phpdocumentor-element-found-in__line">184</span>
</aside>
<p class="phpdocumentor-summary">Get the template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_template</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_file_type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_file_name</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">$p_str_extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">get_template</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file_type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file_name</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">$extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|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_file_type</span>
<span class="phpdocumentor-signature__argument__name">$file_type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -656,7 +671,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_file_name</span>
<span class="phpdocumentor-signature__argument__name">$file_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -665,7 +680,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_extension</span>
<span class="phpdocumentor-signature__argument__name">$extension</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
@ -698,11 +713,20 @@ file content.</p>
<section class="phpdocumentor-description"><p>Refactor templating.</p>
</section>
</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>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">string|bool</span>
&mdash;
<section class="phpdocumentor-description"><p><code class="prettyprint">false</code> or the template path</p>
</section>
@ -799,7 +823,7 @@ file content.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">reload</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">reload</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -831,7 +855,7 @@ file content.</p>
</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>
&mdash;
<section class="phpdocumentor-description"></section>
@ -850,22 +874,22 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
<span class="phpdocumentor-element-found-in__line">109</span>
</aside>
<p class="phpdocumentor-summary">Replace all placeholders specified in array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_arr_placeholders</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<span class="phpdocumentor-signature__name">replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$placeholders</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_arr_placeholders</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__argument__name">$placeholders</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Placeholders (key = placeholder, value = value).</p>