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

docs: update readme and PHPDoc settings (#120)

Browse source 
* 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:
Mark Cheret 2021-04-18 21:30:42 +02:00 committed by GitHub
parent 226df694a2
commit 4dd3345685
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
44 changed files with 10272 additions and 12004 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
class/dashboard/subpage-main.php
View file

@ -1,8 +1,9 @@
<?php // phpcs:disable WordPress.Files.FileName.InvalidClassFileName. <?php // phpcs:disable WordPress.Files.FileName.InvalidClassFileName
/** /**
* Includes the Plugin Class to display all Settings. * Includes the Plugin Class to display all Settings.
* *
* @filesource * @filesource
* @package footnotes
* @since 1.5.0 * @since 1.5.0
* *
* @since 2.0.4 restore arrow settings * @since 2.0.4 restore arrow settings

2
composer.json
View file

@ -18,7 +18,7 @@
"lint:js:fix": "npm run lint:js:fix", "lint:js:fix": "npm run lint:js:fix",
"format:js": "npm run format:js", "format:js": "npm run format:js",
"format:js:fix": "npm run format:js:fix", "format:js:fix": "npm run format:js:fix",
"docs": "./vendor/bin/phpdoc -d . -t ./docs --ignore .vendor/ --ignore .node_modules/", "docs": "./vendor/bin/phpdoc",
"commit": "./vendor/bin/php-commitizen commit -- ./.php-commitizen.php", "commit": "./vendor/bin/php-commitizen commit -- ./.php-commitizen.php",
"post-install-cmd": "npm install && ./_tools/setup.sh" "post-install-cmd": "npm install && ./_tools/setup.sh"
}, },

65
docs/classes/MCI-Footnotes-Config.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">22</span> <span class="phpdocumentor-element-found-in__line">17</span>
</aside> </aside>
<p class="phpdocumentor-summary">Contains all Plugin Constants. Contains no Method or Property.</p> <p class="phpdocumentor-summary">Contains all Plugin Constants. Contains no Method or Property.</p>
@ -99,15 +99,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -160,7 +151,7 @@
<dt class="phpdocumentor-table-of-contents__entry -constant -public"> <dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_NAME">C_STR_PLUGIN_NAME</a> <a href="classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_NAME">C_STR_PLUGIN_NAME</a>
<span> <span>
&nbsp;= &quot;footnotes&quot; </span> &nbsp;= &#039;footnotes&#039; </span>
</dt> </dt>
<dd>Internal Plugin name.</dd> <dd>Internal Plugin name.</dd>
@ -190,7 +181,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">65</span> <span class="phpdocumentor-element-found-in__line">56</span>
</aside> </aside>
<p class="phpdocumentor-summary">Html tag for the LOVE symbol.</p> <p class="phpdocumentor-summary">Html tag for the LOVE symbol.</p>
@ -212,15 +203,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -241,7 +223,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">73</span> <span class="phpdocumentor-element-found-in__line">64</span>
</aside> </aside>
<p class="phpdocumentor-summary">HTML code for the &#039;love&#039; symbol used in dashboard heading</p> <p class="phpdocumentor-summary">HTML code for the &#039;love&#039; symbol used in dashboard heading</p>
@ -283,7 +265,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">82</span> <span class="phpdocumentor-element-found-in__line">72</span>
</aside> </aside>
<p class="phpdocumentor-summary">Short code to DON&#039;T display the &#039;LOVE ME&#039; slug on certain pages.</p> <p class="phpdocumentor-summary">Short code to DON&#039;T display the &#039;LOVE ME&#039; slug on certain pages.</p>
@ -305,15 +287,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -334,7 +307,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">56</span> <span class="phpdocumentor-element-found-in__line">48</span>
</aside> </aside>
<p class="phpdocumentor-summary">Public Plugin name for dashboard heading</p> <p class="phpdocumentor-summary">Public Plugin name for dashboard heading</p>
@ -381,7 +354,7 @@ that isn’t translated, and dropping the logo in another, translatable heading.
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">31</span> <span class="phpdocumentor-element-found-in__line">24</span>
</aside> </aside>
<p class="phpdocumentor-summary">Internal Plugin name.</p> <p class="phpdocumentor-summary">Internal Plugin name.</p>
@ -390,7 +363,7 @@ that isn’t translated, and dropping the logo in another, translatable heading.
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PLUGIN_NAME</span> <span class="phpdocumentor-signature__name">C_STR_PLUGIN_NAME</span>
= <span class="phpdocumentor-signature__default-value">&quot;footnotes&quot;</span> = <span class="phpdocumentor-signature__default-value">&#039;footnotes&#039;</span>
</code> </code>
@ -403,15 +376,6 @@ that isn’t translated, and dropping the logo in another, translatable heading.
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -432,7 +396,7 @@ that isn’t translated, and dropping the logo in another, translatable heading.
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">42</span> <span class="phpdocumentor-element-found-in__line">34</span>
</aside> </aside>
<p class="phpdocumentor-summary">Public Plugin name.</p> <p class="phpdocumentor-summary">Public Plugin name.</p>
@ -454,15 +418,6 @@ that isn’t translated, and dropping the logo in another, translatable heading.
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">

187
docs/classes/MCI-Footnotes-Convert.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Converts data types and Footnotes specific values.</p> <p class="phpdocumentor-summary">Converts data types and Footnotes specific values.</p>
@ -99,15 +99,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -132,47 +123,47 @@
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Convert.html#method_debug">debug()</a> <a href="classes/MCI-Footnotes-Convert.html#method_debug">debug()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: void </span>
</dt> </dt>
<dd>Displays a Variable.</dd> <dd>Displays a Variable.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <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> <span>
&nbsp;: array&lt;string|int, mixed&gt;|string </span> &nbsp;: array&lt;string|int, mixed&gt;|string </span>
</dt> </dt>
<dd>Get a html Array short code depending on Arrow-Array key index.</dd> <dd>Get a html Array short code depending on Arrow-Array key index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <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> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Converts a integer into the user-defined counter style for the footnotes.</dd> <dd>Converts a integer into the user-defined counter style for the footnotes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <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> <span>
&nbsp;: bool </span> &nbsp;: bool </span>
</dt> </dt>
<dd>Converts a string depending on its value to a boolean.</dd> <dd>Converts a string depending on its value to a boolean.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private"> <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> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Converts an integer to a leading-0 integer.</dd> <dd>Converts an integer to a leading-0 integer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private"> <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> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Converts an integer into latin ascii characters, either lower or upper-case.</dd> <dd>Converts an integer into latin ascii characters, either lower or upper-case.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private"> <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> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
@ -204,25 +195,26 @@
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Displays a Variable.</p> <p class="phpdocumentor-summary">Displays a Variable.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <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&nbsp;</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&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>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <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> : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"><p>The variable to display.</p>
</section>
</dd> </dd>
</dl> </dl>
@ -234,15 +226,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -254,7 +237,7 @@
</dl> </dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5> <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; &mdash;
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -266,28 +249,28 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_getArrow"> <h4 class="phpdocumentor-element__name" id="method_get_arrow">
getArrow() get_arrow()
<a href="classes/MCI-Footnotes-Convert.html#method_getArrow" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Convert.html#method_get_arrow" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Get a html Array short code depending on Arrow-Array key index.</p> <p class="phpdocumentor-summary">Get a html Array short code depending on Arrow-Array key index.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <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&nbsp;</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&lt;string|int, mixed&gt;|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&nbsp;</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&lt;string|int, mixed&gt;|string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <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__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">-1</span> </dt> = <span class="phpdocumentor-signature__argument__default-value">-1</span> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -304,15 +287,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -337,28 +311,28 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_Index"> <h4 class="phpdocumentor-element__name" id="method_index">
Index() index()
<a href="classes/MCI-Footnotes-Convert.html#method_Index" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Convert.html#method_index" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Converts a integer into the user-defined counter style for the footnotes.</p> <p class="phpdocumentor-summary">Converts a integer into the user-defined counter style for the footnotes.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <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&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_ConvertStyle</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;arabic_plain&quot;</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&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_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>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <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__return-type">int</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -367,9 +341,9 @@
</dd> </dd>
<dt class="phpdocumentor-argument-list__entry"> <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__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&quot;arabic_plain&quot;</span> </dt> = <span class="phpdocumentor-signature__argument__default-value">&#039;arabic_plain&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Style of the new/converted Index.</p> <section class="phpdocumentor-description"><p>Style of the new/converted Index.</p>
</section> </section>
@ -384,15 +358,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -428,28 +393,28 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_toBool"> <h4 class="phpdocumentor-element__name" id="method_to_bool">
toBool() to_bool()
<a href="classes/MCI-Footnotes-Convert.html#method_toBool" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Convert.html#method_to_bool" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Converts a string depending on its value to a boolean.</p> <p class="phpdocumentor-summary">Converts a string depending on its value to a boolean.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <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&nbsp;</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&nbsp;</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> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <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> : <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -466,15 +431,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -499,28 +455,28 @@
-private -private
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_toArabicLeading"> <h4 class="phpdocumentor-element__name" id="method_to_arabic_leading">
toArabicLeading() to_arabic_leading()
<a href="classes/MCI-Footnotes-Convert.html#method_toArabicLeading" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Convert.html#method_to_arabic_leading" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Converts an integer to a leading-0 integer.</p> <p class="phpdocumentor-summary">Converts an integer to a leading-0 integer.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <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&nbsp;</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&nbsp;</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> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <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> : <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -537,15 +493,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -570,21 +517,21 @@
-private -private
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_toLatin"> <h4 class="phpdocumentor-element__name" id="method_to_latin">
toLatin() to_latin()
<a href="classes/MCI-Footnotes-Convert.html#method_toLatin" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Convert.html#method_to_latin" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Converts an integer into latin ascii characters, either lower or upper-case.</p> <p class="phpdocumentor-summary">Converts an integer into latin ascii characters, either lower or upper-case.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <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&nbsp;</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&nbsp;</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&nbsp;</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&nbsp;</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 class="phpdocumentor-description"><p>Function available from A to ZZ ( means 676 footnotes at 1 page possible).</p>
</section> </section>
@ -592,7 +539,7 @@
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <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> : <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -601,7 +548,7 @@
</dd> </dd>
<dt class="phpdocumentor-argument-list__entry"> <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> : <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -618,15 +565,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -650,28 +588,28 @@
-private -private
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_toRomanic"> <h4 class="phpdocumentor-element__name" id="method_to_romanic">
toRomanic() to_romanic()
<a href="classes/MCI-Footnotes-Convert.html#method_toRomanic" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Convert.html#method_to_romanic" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Converts an integer to a romanic letter.</p> <p class="phpdocumentor-summary">Converts an integer to a romanic letter.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <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&nbsp;</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&nbsp;</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&nbsp;</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&nbsp;</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> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <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> : <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -680,10 +618,12 @@
</dd> </dd>
<dt class="phpdocumentor-argument-list__entry"> <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">mixed</span> : <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Whether to uppercase.</p>
</section>
</dd> </dd>
</dl> </dl>
@ -695,15 +635,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -718,7 +649,7 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span> <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> </section>
</dd> </dd>

137
docs/classes/MCI-Footnotes-Hooks.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">19</span> <span class="phpdocumentor-element-found-in__line">15</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers all WordPress Hooks and executes them on demand.</p> <p class="phpdocumentor-summary">Registers all WordPress Hooks and executes them on demand.</p>
@ -99,15 +99,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -130,35 +121,35 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Hooks.html#method_activatePlugin">activatePlugin()</a> <a href="classes/MCI-Footnotes-Hooks.html#method_activate_plugin">activate_plugin()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Executed when the Plugin gets activated.</dd> <dd>Executed when the Plugin gets activated.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Hooks.html#method_deactivatePlugin">deactivatePlugin()</a> <a href="classes/MCI-Footnotes-Hooks.html#method_deactivate_plugin">deactivate_plugin()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Executed when the Plugin gets deactivated.</dd> <dd>Executed when the Plugin gets deactivated.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Hooks.html#method_PluginLinks">PluginLinks()</a> <a href="classes/MCI-Footnotes-Hooks.html#method_plugin_links">plugin_links()</a>
<span> <span>
&nbsp;: array&lt;string|int, mixed&gt; </span> &nbsp;: array&lt;string|int, mixed&gt; </span>
</dt> </dt>
<dd>Add Links to the Plugin in the &quot;installed Plugins&quot; page.</dd> <dd>Add Links to the Plugin in the &quot;installed Plugins&quot; page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Hooks.html#method_registerHooks">registerHooks()</a> <a href="classes/MCI-Footnotes-Hooks.html#method_register_hooks">register_hooks()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Registers all WordPress hooks.</dd> <dd>Registers all WordPress hooks.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Hooks.html#method_uninstallPlugin">uninstallPlugin()</a> <a href="classes/MCI-Footnotes-Hooks.html#method_uninstall_plugin">uninstall_plugin()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
@ -183,21 +174,21 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_activatePlugin"> <h4 class="phpdocumentor-element__name" id="method_activate_plugin">
activatePlugin() activate_plugin()
<a href="classes/MCI-Footnotes-Hooks.html#method_activatePlugin" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Hooks.html#method_activate_plugin" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">39</span> <span class="phpdocumentor-element-found-in__line">33</span>
</aside> </aside>
<p class="phpdocumentor-summary">Executed when the Plugin gets activated.</p> <p class="phpdocumentor-summary">Executed when the Plugin gets activated.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">activatePlugin</span><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">activate_plugin</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -209,15 +200,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -241,21 +223,21 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_deactivatePlugin"> <h4 class="phpdocumentor-element__name" id="method_deactivate_plugin">
deactivatePlugin() deactivate_plugin()
<a href="classes/MCI-Footnotes-Hooks.html#method_deactivatePlugin" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Hooks.html#method_deactivate_plugin" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">49</span> <span class="phpdocumentor-element-found-in__line">42</span>
</aside> </aside>
<p class="phpdocumentor-summary">Executed when the Plugin gets deactivated.</p> <p class="phpdocumentor-summary">Executed when the Plugin gets deactivated.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">deactivatePlugin</span><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">deactivate_plugin</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -267,15 +249,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -299,28 +272,28 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_PluginLinks"> <h4 class="phpdocumentor-element__name" id="method_plugin_links">
PluginLinks() plugin_links()
<a href="classes/MCI-Footnotes-Hooks.html#method_PluginLinks" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Hooks.html#method_plugin_links" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">84</span> <span class="phpdocumentor-element-found-in__line">74</span>
</aside> </aside>
<p class="phpdocumentor-summary">Add Links to the Plugin in the &quot;installed Plugins&quot; page.</p> <p class="phpdocumentor-summary">Add Links to the Plugin in the &quot;installed Plugins&quot; page.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">PluginLinks</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_Links</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_PluginFileName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">plugin_links</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_links</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_plugin_file_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_arr_Links</span> <span class="phpdocumentor-signature__argument__name">$p_arr_links</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span> : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -329,7 +302,7 @@
</dd> </dd>
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_PluginFileName</span> <span class="phpdocumentor-signature__argument__name">$p_str_plugin_file_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -346,15 +319,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -378,21 +342,21 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_registerHooks"> <h4 class="phpdocumentor-element__name" id="method_register_hooks">
registerHooks() register_hooks()
<a href="classes/MCI-Footnotes-Hooks.html#method_registerHooks" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Hooks.html#method_register_hooks" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">27</span> <span class="phpdocumentor-element-found-in__line">22</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers all WordPress hooks.</p> <p class="phpdocumentor-summary">Registers all WordPress hooks.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">registerHooks</span><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">register_hooks</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -404,15 +368,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -436,21 +391,21 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_uninstallPlugin"> <h4 class="phpdocumentor-element__name" id="method_uninstall_plugin">
uninstallPlugin() uninstall_plugin()
<a href="classes/MCI-Footnotes-Hooks.html#method_uninstallPlugin" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Hooks.html#method_uninstall_plugin" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/hooks.php"><a href="files/class-hooks.html"><abbr title="class/hooks.php">hooks.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">62</span> <span class="phpdocumentor-element-found-in__line">55</span>
</aside> </aside>
<p class="phpdocumentor-summary">Executed when the Plugin gets uninstalled.</p> <p class="phpdocumentor-summary">Executed when the Plugin gets uninstalled.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">uninstallPlugin</span><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">uninstall_plugin</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -462,22 +417,12 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span> <span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><p>Edit: ClearAll didn’t actually work.</p> <section class="phpdocumentor-description"></section>
</section>
</dd> </dd>
<dt class="phpdocumentor-tag-list__entry"> <dt class="phpdocumentor-tag-list__entry">
@ -486,7 +431,17 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span> <span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"><p>this function is not called any longer when deleting the plugin</p> <section class="phpdocumentor-description"><p>this function is not called any longer when deleting the plugin.
Note: clear_all() didn't actually work.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>class/settings.php</p>
</section> </section>
</dd> </dd>

94
docs/classes/MCI-Footnotes-Language.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">22</span> <span class="phpdocumentor-element-found-in__line">18</span>
</aside> </aside>
<p class="phpdocumentor-summary">Loads text domain of current or default language for localization.</p> <p class="phpdocumentor-summary">Loads text domain of current or default language for localization.</p>
@ -99,15 +99,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -130,14 +121,14 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Language.html#method_loadTextDomain">loadTextDomain()</a> <a href="classes/MCI-Footnotes-Language.html#method_load_text_domain">load_text_domain()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Loads the text domain for current WordPress language if exists.</dd> <dd>Loads the text domain for current WordPress language if exists.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Language.html#method_registerHooks">registerHooks()</a> <a href="classes/MCI-Footnotes-Language.html#method_register_hooks">register_hooks()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
@ -169,21 +160,21 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_loadTextDomain"> <h4 class="phpdocumentor-element__name" id="method_load_text_domain">
loadTextDomain() load_text_domain()
<a href="classes/MCI-Footnotes-Language.html#method_loadTextDomain" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Language.html#method_load_text_domain" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">68</span> <span class="phpdocumentor-element-found-in__line">61</span>
</aside> </aside>
<p class="phpdocumentor-summary">Loads the text domain for current WordPress language if exists.</p> <p class="phpdocumentor-summary">Loads the text domain for current WordPress language if exists.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">loadTextDomain</span><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">load_text_domain</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Otherwise fallback &quot;en_GB&quot; will be loaded.</p> <section class="phpdocumentor-description"><p>Otherwise fallback &quot;en_GB&quot; will be loaded.</p>
</section> </section>
@ -196,15 +187,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -224,15 +206,6 @@
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">date</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>2020-10-26T1609+0100</p>
</section>
</dd> </dd>
<dt class="phpdocumentor-tag-list__entry"> <dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">contributor</span> <span class="phpdocumentor-tag__name">contributor</span>
@ -247,7 +220,7 @@
<span class="phpdocumentor-tag__name">link</span> <span class="phpdocumentor-tag__name">link</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/error-missing-parameter-if-using-php-7-1-or-later/"> <p>Add 3rd (empty) argument in apply_filters() to prevent PHP from throwing an error: <a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/error-missing-parameter-if-using-php-7-1-or-later/"> <p>Add 3rd (empty) argument in apply_filters() to prevent PHP from throwing an error.
“Fatal error: Uncaught ArgumentCountError: Too few arguments to function apply_filters()”</p> “Fatal error: Uncaught ArgumentCountError: Too few arguments to function apply_filters()”</p>
<p>Yet get_locale() is defined w/o parameters in wp-includes/l10n.php:30, and <p>Yet get_locale() is defined w/o parameters in wp-includes/l10n.php:30, and
apply_filters() is defined as apply_filters( $tag, $value ) in wp-includes/plugin.php:181.</p> apply_filters() is defined as apply_filters( $tag, $value ) in wp-includes/plugin.php:181.</p>
@ -260,7 +233,7 @@ apply_filters() is defined as apply_filters( $tag, $value ) in wp-includes/plugi
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://developer.wordpress.org/reference/functions/apply_filters/"> <p>But apply_filters() is defined with a 3rd parameter (and w/o the first one) in <a class="phpdocumentor-tag-link" href="https://developer.wordpress.org/reference/functions/apply_filters/"> <p>But apply_filters() is defined with a 3rd parameter (and w/o the first one) in
wp-includes/class-wp-hook.php:264, as public function apply_filters( $value, $args ).</p> wp-includes/class-wp-hook.php:264, as public function apply_filters( $value, $args ).</p>
<p>Taking it all together, probably the full function definition would be: <p>Taking it all together, probably the full function definition would be
public function apply_filters( $tag, $value, $args ). public function apply_filters( $tag, $value, $args ).
In the case of get_locale(), $args is empty.</p> In the case of get_locale(), $args is empty.</p>
<p>The bug was lurking in WP. PHP 7.1 promoted the warning to an error.</p> <p>The bug was lurking in WP. PHP 7.1 promoted the warning to an error.</p>
@ -296,21 +269,21 @@ In the case of get_locale(), $args is empty.</p>
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_registerHooks"> <h4 class="phpdocumentor-element__name" id="method_register_hooks">
registerHooks() register_hooks()
<a href="classes/MCI-Footnotes-Language.html#method_registerHooks" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Language.html#method_register_hooks" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">30</span> <span class="phpdocumentor-element-found-in__line">25</span>
</aside> </aside>
<p class="phpdocumentor-summary">Register WordPress Hook.</p> <p class="phpdocumentor-summary">Register WordPress Hook.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">registerHooks</span><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">register_hooks</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -322,15 +295,6 @@ In the case of get_locale(), $args is empty.</p>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -361,21 +325,21 @@ In the case of get_locale(), $args is empty.</p>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/language.php"><a href="files/class-language.html"><abbr title="class/language.php">language.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">99</span> <span class="phpdocumentor-element-found-in__line">90</span>
</aside> </aside>
<p class="phpdocumentor-summary">Loads a specific text domain.</p> <p class="phpdocumentor-summary">Loads a specific text domain.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">load</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_LanguageCode</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">load</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_language_code</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_LanguageCode</span> <span class="phpdocumentor-signature__argument__name">$p_str_language_code</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -392,15 +356,6 @@ In the case of get_locale(), $args is empty.</p>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -417,15 +372,6 @@ In the case of get_locale(), $args is empty.</p>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">date</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>2020-12-08T1931+0100</p>
</section>
</dd> </dd>
<dt class="phpdocumentor-tag-list__entry"> <dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">reporter</span> <span class="phpdocumentor-tag__name">reporter</span>
@ -440,7 +386,7 @@ In the case of get_locale(), $args is empty.</p>
<span class="phpdocumentor-tag__name">link</span> <span class="phpdocumentor-tag__name">link</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/more-feature-ideas/"> <p>That is done by using load_plugin_textdomain(): <a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/more-feature-ideas/"> <p>That is done by using load_plugin_textdomain().
“The .mo file should be named based on the text domain with a dash, and then the locale exactly.”</p> “The .mo file should be named based on the text domain with a dash, and then the locale exactly.”</p>
</a> </a>

2290
docs/classes/MCI-Footnotes-Layout-Diagnostics.html
View file

File diff suppressed because it is too large Load diff

934
docs/classes/MCI-Footnotes-LayoutEngine.html → docs/classes/MCI-Footnotes-Layout-Engine.html
View file

File diff suppressed because it is too large Load diff

284
docs/classes/MCI-Footnotes-Layout-Init.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">17</span> <span class="phpdocumentor-element-found-in__line">15</span>
</aside> </aside>
<p class="phpdocumentor-summary">Handles the Settings interface of the Plugin.</p> <p class="phpdocumentor-summary">Handles the Settings interface of the Plugin.</p>
@ -99,15 +99,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -132,23 +123,23 @@
<dt class="phpdocumentor-table-of-contents__entry -constant -public"> <dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG">C_STR_MAIN_MENU_SLUG</a> <a href="classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG">C_STR_MAIN_MENU_SLUG</a>
<span> <span>
&nbsp;= &quot;mfmmf&quot; </span> &nbsp;= &#039;footnotes&#039; </span>
</dt> </dt>
<dd>Slug for the Plugin main menu.</dd> <dd>Slug for the Plugin main menu.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public"> <dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE">C_STR_MAIN_MENU_TITLE</a> <a href="classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE">C_STR_MAIN_MENU_TITLE</a>
<span> <span>
&nbsp;= &quot;ManFisher&quot; </span> &nbsp;= &#039;ManFisher&#039; </span>
</dt> </dt>
<dd>Plugin main menu name.</dd> <dd>Plugin main menu name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private"> <dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/MCI-Footnotes-Layout-Init.html#property_a_arr_SubPageClasses">$a_arr_SubPageClasses</a> <a href="classes/MCI-Footnotes-Layout-Init.html#property_settings_page">$settings_page</a>
<span> <span>
&nbsp;: array&lt;string|int, mixed&gt; </span> &nbsp;: array&lt;string|int, mixed&gt; </span>
</dt> </dt>
<dd></dd> <dd>Contains the settings layoutEngine</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method___construct">__construct()</a> <a href="classes/MCI-Footnotes-Layout-Init.html#method___construct">__construct()</a>
@ -158,39 +149,25 @@
<dd>Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</dd> <dd>Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_displayOtherPlugins">displayOtherPlugins()</a> <a href="classes/MCI-Footnotes-Layout-Init.html#method_get_plugin_meta_information">get_plugin_meta_information()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays other Plugins from the developers.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_getPluginMetaInformation">getPluginMetaInformation()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</dd> <dd>AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_initializeSettings">initializeSettings()</a> <a href="classes/MCI-Footnotes-Layout-Init.html#method_initialize_settings">initialize_settings()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Initializes all sub pages and registers the settings.</dd> <dd>Registers the settings and initialises the settings page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerMainMenu">registerMainMenu()</a> <a href="classes/MCI-Footnotes-Layout-Init.html#method_register_options_submenu">register_options_submenu()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Registers the new main menu for the WordPress dashboard.</dd> <dd>Registers the footnotes submenu page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerSubPages">registerSubPages()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Registers all SubPages for this Plugin.</dd>
</dl> </dl>
@ -211,7 +188,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">26</span> <span class="phpdocumentor-element-found-in__line">23</span>
</aside> </aside>
<p class="phpdocumentor-summary">Slug for the Plugin main menu.</p> <p class="phpdocumentor-summary">Slug for the Plugin main menu.</p>
@ -220,7 +197,7 @@
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_MAIN_MENU_SLUG</span> <span class="phpdocumentor-signature__name">C_STR_MAIN_MENU_SLUG</span>
= <span class="phpdocumentor-signature__default-value">&quot;mfmmf&quot;</span> = <span class="phpdocumentor-signature__default-value">&#039;footnotes&#039;</span>
</code> </code>
@ -233,15 +210,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -262,7 +230,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">35</span> <span class="phpdocumentor-element-found-in__line">31</span>
</aside> </aside>
<p class="phpdocumentor-summary">Plugin main menu name.</p> <p class="phpdocumentor-summary">Plugin main menu name.</p>
@ -271,7 +239,7 @@
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_MAIN_MENU_TITLE</span> <span class="phpdocumentor-signature__name">C_STR_MAIN_MENU_TITLE</span>
= <span class="phpdocumentor-signature__default-value">&quot;ManFisher&quot;</span> = <span class="phpdocumentor-signature__default-value">&#039;ManFisher&#039;</span>
</code> </code>
@ -284,15 +252,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -319,24 +278,25 @@
-private -private
" "
> >
<h4 class="phpdocumentor-element__name" id="property_a_arr_SubPageClasses"> <h4 class="phpdocumentor-element__name" id="property_settings_page">
$a_arr_SubPageClasses $settings_page
<a href="classes/MCI-Footnotes-Layout-Init.html#property_a_arr_SubPageClasses" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Layout-Init.html#property_settings_page" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers"> <span class="phpdocumentor-element__modifiers">
</span> </span>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">43</span> <span class="phpdocumentor-element-found-in__line">39</span>
</aside> </aside>
<p class="phpdocumentor-summary">Contains the settings layoutEngine</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span> <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$a_arr_SubPageClasses</span> <span class="phpdocumentor-signature__name">$settings_page</span>
= <span class="phpdocumentor-signature__default-value">array()</span></code> </code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -347,15 +307,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -387,7 +338,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">51</span> <span class="phpdocumentor-element-found-in__line">46</span>
</aside> </aside>
<p class="phpdocumentor-summary">Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</p> <p class="phpdocumentor-summary">Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</p>
@ -406,15 +357,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -438,79 +380,21 @@
-public -public
" "
> >
<h4 class="phpdocumentor-element__name" id="method_displayOtherPlugins"> <h4 class="phpdocumentor-element__name" id="method_get_plugin_meta_information">
displayOtherPlugins() get_plugin_meta_information()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_displayOtherPlugins" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Layout-Init.html#method_get_plugin_meta_information" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">143</span> <span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Displays other Plugins from the developers.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">displayOtherPlugins</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<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">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">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getPluginMetaInformation">
getPluginMetaInformation()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_getPluginMetaInformation" 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/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">161</span>
</aside> </aside>
<p class="phpdocumentor-summary">AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</p> <p class="phpdocumentor-summary">AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getPluginMetaInformation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">get_plugin_meta_information</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -522,15 +406,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -554,21 +429,21 @@
-public -public
" "
> >
<h4 class="phpdocumentor-element__name" id="method_initializeSettings"> <h4 class="phpdocumentor-element__name" id="method_initialize_settings">
initializeSettings() initialize_settings()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_initializeSettings" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Layout-Init.html#method_initialize_settings" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">78</span> <span class="phpdocumentor-element-found-in__line">62</span>
</aside> </aside>
<p class="phpdocumentor-summary">Initializes all sub pages and registers the settings.</p> <p class="phpdocumentor-summary">Registers the settings and initialises the settings page.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">initializeSettings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">initialize_settings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -580,15 +455,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -612,24 +478,23 @@
-public -public
" "
> >
<h4 class="phpdocumentor-element__name" id="method_registerMainMenu"> <h4 class="phpdocumentor-element__name" id="method_register_options_submenu">
registerMainMenu() register_options_submenu()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerMainMenu" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Layout-Init.html#method_register_options_submenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">95</span> <span class="phpdocumentor-element-found-in__line">73</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers the new main menu for the WordPress dashboard.</p> <p class="phpdocumentor-summary">Registers the footnotes submenu page.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">registerMainMenu</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">register_options_submenu</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Registers all sub menu pages for the new main menu.</p> <section class="phpdocumentor-description"></section>
</section>
@ -639,15 +504,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -673,64 +529,6 @@
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_registerSubPages">
registerSubPages()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerSubPages" 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/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
</aside>
<p class="phpdocumentor-summary">Registers all SubPages for this Plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">registerSubPages</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<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">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">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article> </article>
</section> </section>

2046
docs/classes/MCI-Footnotes-Layout-Settings.html
View file

File diff suppressed because it is too large Load diff

8848
docs/classes/MCI-Footnotes-Settings.html
View file

File diff suppressed because it is too large Load diff

3179
docs/classes/MCI-Footnotes-Task.html
View file

File diff suppressed because it is too large Load diff

426
docs/classes/MCI-Footnotes-Template.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">39</span> <span class="phpdocumentor-element-found-in__line">19</span>
</aside> </aside>
<p class="phpdocumentor-summary">Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</p> <p class="phpdocumentor-summary">Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</p>
@ -100,15 +100,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -133,14 +124,14 @@
<dt class="phpdocumentor-table-of-contents__entry -constant -public"> <dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Template.html#constant_C_STR_DASHBOARD">C_STR_DASHBOARD</a> <a href="classes/MCI-Footnotes-Template.html#constant_C_STR_DASHBOARD">C_STR_DASHBOARD</a>
<span> <span>
&nbsp;= &quot;dashboard&quot; </span> &nbsp;= &#039;dashboard&#039; </span>
</dt> </dt>
<dd>Directory name for dashboard templates.</dd> <dd>Directory name for dashboard templates.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public"> <dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Template.html#constant_C_STR_PUBLIC">C_STR_PUBLIC</a> <a href="classes/MCI-Footnotes-Template.html#constant_C_STR_PUBLIC">C_STR_PUBLIC</a>
<span> <span>
&nbsp;= &quot;public&quot; </span> &nbsp;= &#039;public&#039; </span>
</dt> </dt>
<dd>Directory name for public templates.</dd> <dd>Directory name for public templates.</dd>
@ -152,14 +143,14 @@
<dd>Plugin Directory</dd> <dd>Plugin Directory</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private"> <dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/MCI-Footnotes-Template.html#property_a_str_OriginalContent">$a_str_OriginalContent</a> <a href="classes/MCI-Footnotes-Template.html#property_a_str_original_content">$a_str_original_content</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Contains the content of the template after initialize.</dd> <dd>Contains the content of the template after initialize.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private"> <dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/MCI-Footnotes-Template.html#property_a_str_ReplacedContent">$a_str_ReplacedContent</a> <a href="classes/MCI-Footnotes-Template.html#property_a_str_replaced_content">$a_str_replaced_content</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
@ -173,25 +164,25 @@
<dd>Class Constructor. Reads and loads the template file without replace any placeholder.</dd> <dd>Class Constructor. Reads and loads the template file without replace any placeholder.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Template.html#method_get_template">get_template()</a> <a href="classes/MCI-Footnotes-Template.html#method_get_content">get_content()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Get the template</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Template.html#method_getContent">getContent()</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Returns the content of the template file with replaced placeholders.</dd> <dd>Returns the content of the template file with replaced placeholders.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Template.html#method_get_template">get_template()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Get the template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Template.html#method_process_template">process_template()</a> <a href="classes/MCI-Footnotes-Template.html#method_process_template">process_template()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Process template file</dd> <dd>Process template file.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Template.html#method_reload">reload()</a> <a href="classes/MCI-Footnotes-Template.html#method_reload">reload()</a>
@ -226,7 +217,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">48</span> <span class="phpdocumentor-element-found-in__line">27</span>
</aside> </aside>
<p class="phpdocumentor-summary">Directory name for dashboard templates.</p> <p class="phpdocumentor-summary">Directory name for dashboard templates.</p>
@ -235,7 +226,7 @@
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_DASHBOARD</span> <span class="phpdocumentor-signature__name">C_STR_DASHBOARD</span>
= <span class="phpdocumentor-signature__default-value">&quot;dashboard&quot;</span> = <span class="phpdocumentor-signature__default-value">&#039;dashboard&#039;</span>
</code> </code>
@ -248,15 +239,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -277,7 +259,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">57</span> <span class="phpdocumentor-element-found-in__line">35</span>
</aside> </aside>
<p class="phpdocumentor-summary">Directory name for public templates.</p> <p class="phpdocumentor-summary">Directory name for public templates.</p>
@ -286,7 +268,7 @@
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PUBLIC</span> <span class="phpdocumentor-signature__name">C_STR_PUBLIC</span>
= <span class="phpdocumentor-signature__default-value">&quot;public&quot;</span> = <span class="phpdocumentor-signature__default-value">&#039;public&#039;</span>
</code> </code>
@ -299,15 +281,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -343,7 +316,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">85</span> <span class="phpdocumentor-element-found-in__line">60</span>
</aside> </aside>
<p class="phpdocumentor-summary">Plugin Directory</p> <p class="phpdocumentor-summary">Plugin Directory</p>
@ -363,15 +336,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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>Patrizia Lutz @misfist</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -390,16 +354,16 @@
-private -private
" "
> >
<h4 class="phpdocumentor-element__name" id="property_a_str_OriginalContent"> <h4 class="phpdocumentor-element__name" id="property_a_str_original_content">
$a_str_OriginalContent $a_str_original_content
<a href="classes/MCI-Footnotes-Template.html#property_a_str_OriginalContent" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Template.html#property_a_str_original_content" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers"> <span class="phpdocumentor-element__modifiers">
</span> </span>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">66</span> <span class="phpdocumentor-element-found-in__line">43</span>
</aside> </aside>
<p class="phpdocumentor-summary">Contains the content of the template after initialize.</p> <p class="phpdocumentor-summary">Contains the content of the template after initialize.</p>
@ -407,8 +371,8 @@
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$a_str_OriginalContent</span> <span class="phpdocumentor-signature__name">$a_str_original_content</span>
= <span class="phpdocumentor-signature__default-value">&quot;&quot;</span></code> = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -419,15 +383,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -446,16 +401,16 @@
-private -private
" "
> >
<h4 class="phpdocumentor-element__name" id="property_a_str_ReplacedContent"> <h4 class="phpdocumentor-element__name" id="property_a_str_replaced_content">
$a_str_ReplacedContent $a_str_replaced_content
<a href="classes/MCI-Footnotes-Template.html#property_a_str_ReplacedContent" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Template.html#property_a_str_replaced_content" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers"> <span class="phpdocumentor-element__modifiers">
</span> </span>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">75</span> <span class="phpdocumentor-element-found-in__line">51</span>
</aside> </aside>
<p class="phpdocumentor-summary">Contains the content of the template after initialize with replaced place holders.</p> <p class="phpdocumentor-summary">Contains the content of the template after initialize with replaced place holders.</p>
@ -463,8 +418,8 @@
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$a_str_ReplacedContent</span> <span class="phpdocumentor-signature__name">$a_str_replaced_content</span>
= <span class="phpdocumentor-signature__default-value">&quot;&quot;</span></code> = <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -475,15 +430,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -515,21 +461,21 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">103</span> <span class="phpdocumentor-element-found-in__line">77</span>
</aside> </aside>
<p class="phpdocumentor-summary">Class Constructor. Reads and loads the template file without replace any placeholder.</p> <p class="phpdocumentor-summary">Class Constructor. Reads and loads the template file without replace any placeholder.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <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_FileType</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_FileName</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">&quot;html&quot;</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">$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>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_FileType</span> <span class="phpdocumentor-signature__argument__name">$p_str_file_type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -538,7 +484,7 @@
</dd> </dd>
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_FileName</span> <span class="phpdocumentor-signature__argument__name">$p_str_file_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -547,11 +493,14 @@
</dd> </dd>
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_Extension</span> <span class="phpdocumentor-signature__argument__name">$p_str_extension</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&quot;html&quot;</span> </dt> = <span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Optional Template file extension (default: html)</p> <section class="phpdocumentor-description"><p>Optional Template file extension (default: html).</p>
<ul>
<li>Adding: Templates: support for custom templates in sibling folder, thanks to @misfist issue report.</li>
</ul>
</section> </section>
</dd> </dd>
@ -564,15 +513,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -587,17 +527,15 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.6</span> <span class="phpdocumentor-tag-link">2.2.6</span>
<section class="phpdocumentor-description"><p>support for custom templates 2020-12-19T0606+0100</p> <section class="phpdocumentor-description"></section>
</section>
</dd> </dd>
<dt class="phpdocumentor-tag-list__entry"> <dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span> <span class="phpdocumentor-tag__name">reporter</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.4.0</span>
<section class="phpdocumentor-description"><p>look for custom template in the active theme first, thanks to @misfist</p> <section class="phpdocumentor-description"><p>@misfist</p>
</section> </section>
</dd> </dd>
@ -607,13 +545,6 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/"> https://wordpress.org/support/topic/template-override-filter/ </a> <a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/"> https://wordpress.org/support/topic/template-override-filter/ </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/#post-13846598"> https://wordpress.org/support/topic/template-override-filter/#post-13846598 </a>
</dd> </dd>
</dl> </dl>
@ -630,107 +561,21 @@
-public -public
" "
> >
<h4 class="phpdocumentor-element__name" id="method_get_template"> <h4 class="phpdocumentor-element__name" id="method_get_content">
get_template() get_content()
<a href="classes/MCI-Footnotes-Template.html#method_get_template" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Template.html#method_get_content" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">219</span> <span class="phpdocumentor-element-found-in__line">143</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_FileType</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_FileName</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">&quot;html&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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_FileType</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_FileName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_Extension</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&quot;html&quot;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></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">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Patrizia Lutz @misfist</p>
</section>
</dd>
<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">2.4.0d3</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"><p>false | template path</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getContent">
getContent()
<a href="classes/MCI-Footnotes-Template.html#method_getContent" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">175</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns the content of the template file with replaced placeholders.</p> <p class="phpdocumentor-summary">Returns the content of the template file with replaced placeholders.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getContent</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <span class="phpdocumentor-signature__name">get_content</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -742,15 +587,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -768,6 +604,116 @@
</section> </section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_template">
get_template()
<a href="classes/MCI-Footnotes-Template.html#method_get_template" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">190</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>
<section class="phpdocumentor-description"><ul>
<li>Adding: Templates: Enable template location stack, thanks to @misfist issue report and code contribution.</li>
</ul>
</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__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The file type of the template.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_file_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The file name of the template.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_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">
<section class="phpdocumentor-description"><p>The file extension of the template.</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">2.4.0d3</span>
<section class="phpdocumentor-description"><p>Contribution.</p>
</section>
</dd>
<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">2.5.0</span>
<section class="phpdocumentor-description"><p>Release.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">contributor</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@misfist</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/#post-13864301"> https://wordpress.org/support/topic/template-override-filter/#post-13864301 </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"><p>false | template path</p>
</section>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -782,10 +728,10 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">196</span> <span class="phpdocumentor-element-found-in__line">161</span>
</aside> </aside>
<p class="phpdocumentor-summary">Process template file</p> <p class="phpdocumentor-summary">Process template file.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
@ -800,7 +746,8 @@
: <span class="phpdocumentor-signature__argument__return-type">string</span> : <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"><p>The template to be processed.</p>
</section>
</dd> </dd>
</dl> </dl>
@ -812,15 +759,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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>Patrizia Lutz @misfist</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -835,7 +773,7 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.0.3</span> <span class="phpdocumentor-tag-link">2.0.3</span>
<section class="phpdocumentor-description"><p>replace tab with a space</p> <section class="phpdocumentor-description"><p>Replace tab with a space.</p>
</section> </section>
</dd> </dd>
@ -845,7 +783,7 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.0.3</span> <span class="phpdocumentor-tag-link">2.0.3</span>
<section class="phpdocumentor-description"><p>replace 2 spaces with 1</p> <section class="phpdocumentor-description"><p>Replace 2 spaces with 1.</p>
</section> </section>
</dd> </dd>
@ -855,7 +793,7 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.0.4</span> <span class="phpdocumentor-tag-link">2.0.4</span>
<section class="phpdocumentor-description"><p>collapse multiple spaces</p> <section class="phpdocumentor-description"><p>Collapse multiple spaces.</p>
</section> </section>
</dd> </dd>
@ -865,7 +803,7 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.6</span> <span class="phpdocumentor-tag-link">2.2.6</span>
<section class="phpdocumentor-description"><p>delete a space before a closing pointy bracket</p> <section class="phpdocumentor-description"><p>Delete a space before a closing pointy bracket.</p>
</section> </section>
</dd> </dd>
@ -875,7 +813,7 @@
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.5.4</span> <span class="phpdocumentor-tag-link">2.5.4</span>
<section class="phpdocumentor-description"><p>collapse HTML comments and PHP/JS docblocks (only)</p> <section class="phpdocumentor-description"><p>Collapse HTML comments and PHP/JS docblocks (only).</p>
</section> </section>
</dd> </dd>
@ -901,7 +839,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">164</span> <span class="phpdocumentor-element-found-in__line">133</span>
</aside> </aside>
<p class="phpdocumentor-summary">Reloads the original content of the template file.</p> <p class="phpdocumentor-summary">Reloads the original content of the template file.</p>
@ -920,15 +858,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -959,21 +888,21 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">141</span> <span class="phpdocumentor-element-found-in__line">111</span>
</aside> </aside>
<p class="phpdocumentor-summary">Replace all placeholders specified in array.</p> <p class="phpdocumentor-summary">Replace all placeholders specified in array.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <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, 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>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_arr_Placeholders</span> <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__return-type">array&lt;string|int, mixed&gt;</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -990,15 +919,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">

163
docs/classes/MCI-Footnotes-WYSIWYG.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -88,6 +88,7 @@
<span class="phpdocumentor-element-found-in__line">15</span> <span class="phpdocumentor-element-found-in__line">15</span>
</aside> </aside>
<p class="phpdocumentor-summary">Handles the WSYIWYG-Buttons.</p>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -98,15 +99,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -129,39 +121,39 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_ajaxCallback">ajaxCallback()</a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_ajax_callback">ajax_callback()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</dd> <dd>AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_includeScripts">includeScripts()</a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_include_scripts">include_scripts()</a>
<span> <span>
&nbsp;: array&lt;string|int, mixed&gt; </span> &nbsp;: array&lt;string|int, mixed&gt; </span>
</dt> </dt>
<dd>Includes the Plugins WYSIWYG editor script.</dd> <dd>Includes the Plugins WYSIWYG editor script.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_newPlainTextEditorButton">newPlainTextEditorButton()</a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_new_plain_text_editor_button">new_plain_text_editor_button()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Add a new button to the plain text editor.</dd> <dd>Add a new button to the plain text editor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_newVisualEditorButton">newVisualEditorButton()</a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_new_visual_editor_button">new_visual_editor_button()</a>
<span> <span>
&nbsp;: array&lt;string|int, mixed&gt; </span> &nbsp;: array&lt;string|int, mixed&gt; </span>
</dt> </dt>
<dd>Append a new Button to the WYSIWYG editor of Posts and Pages.</dd> <dd>Append a new Button to the WYSIWYG editor of Posts and Pages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_registerHooks">registerHooks()</a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_register_hooks">register_hooks()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: void </span>
</dt> </dt>
<dd></dd> <dd>Registers Button hooks.</dd>
</dl> </dl>
@ -182,21 +174,21 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_ajaxCallback"> <h4 class="phpdocumentor-element__name" id="method_ajax_callback">
ajaxCallback() ajax_callback()
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_ajaxCallback" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_ajax_callback" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">72</span> <span class="phpdocumentor-element-found-in__line">87</span>
</aside> </aside>
<p class="phpdocumentor-summary">AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</p> <p class="phpdocumentor-summary">AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">ajaxCallback</span><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">ajax_callback</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Returns an JSON encoded array with the Footnotes start and end short code.</p> <section class="phpdocumentor-description"><p>Returns an JSON encoded array with the Footnotes start and end short code.</p>
</section> </section>
@ -209,15 +201,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -241,28 +224,28 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_includeScripts"> <h4 class="phpdocumentor-element__name" id="method_include_scripts">
includeScripts() include_scripts()
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_includeScripts" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_include_scripts" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">60</span> <span class="phpdocumentor-element-found-in__line">76</span>
</aside> </aside>
<p class="phpdocumentor-summary">Includes the Plugins WYSIWYG editor script.</p> <p class="phpdocumentor-summary">Includes the Plugins WYSIWYG editor script.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">includeScripts</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_Plugins</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">include_scripts</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_plugins</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_arr_Plugins</span> <span class="phpdocumentor-signature__argument__name">$p_arr_plugins</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span> : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -279,15 +262,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -311,21 +285,21 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_newPlainTextEditorButton"> <h4 class="phpdocumentor-element__name" id="method_new_plain_text_editor_button">
newPlainTextEditorButton() new_plain_text_editor_button()
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_newPlainTextEditorButton" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_new_plain_text_editor_button" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">47</span> <span class="phpdocumentor-element-found-in__line">62</span>
</aside> </aside>
<p class="phpdocumentor-summary">Add a new button to the plain text editor.</p> <p class="phpdocumentor-summary">Add a new button to the plain text editor.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">newPlainTextEditorButton</span><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">new_plain_text_editor_button</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -337,15 +311,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -369,28 +334,28 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_newVisualEditorButton"> <h4 class="phpdocumentor-element__name" id="method_new_visual_editor_button">
newVisualEditorButton() new_visual_editor_button()
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_newVisualEditorButton" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_new_visual_editor_button" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">36</span> <span class="phpdocumentor-element-found-in__line">52</span>
</aside> </aside>
<p class="phpdocumentor-summary">Append a new Button to the WYSIWYG editor of Posts and Pages.</p> <p class="phpdocumentor-summary">Append a new Button to the WYSIWYG editor of Posts and Pages.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">newVisualEditorButton</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_Buttons</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">new_visual_editor_button</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_buttons</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_arr_Buttons</span> <span class="phpdocumentor-signature__argument__name">$p_arr_buttons</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span> : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
@ -407,15 +372,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -439,27 +395,72 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="method_registerHooks"> <h4 class="phpdocumentor-element__name" id="method_register_hooks">
registerHooks() register_hooks()
<a href="classes/MCI-Footnotes-WYSIWYG.html#method_registerHooks" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-WYSIWYG.html#method_register_hooks" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/wysiwyg.php"><a href="files/class-wysiwyg.html"><abbr title="class/wysiwyg.php">wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">17</span> <span class="phpdocumentor-element-found-in__line">30</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers Button hooks.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">registerHooks</span><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">register_hooks</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<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>
<section class="phpdocumentor-description"><ul>
<li>Bugfix: Editor buttons: debug button by reverting name change in PHP file while JS file and HTML template remained unsynced, thanks to @gova bug report.</li>
</ul>
</section>
</dd>
<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">2.6.5</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">reporter</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@gova</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/back-end-footnotes-not-working-400-bad-erro/"> https://wordpress.org/support/topic/back-end-footnotes-not-working-400-bad-erro/ </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5> <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; &mdash;
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>

109
docs/classes/MCI-Footnotes-WidgetBase.html → docs/classes/MCI-Footnotes-Widget-Base.html
View file

@ -70,12 +70,12 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title"> <h2 class="phpdocumentor-content__title">
MCI_Footnotes_WidgetBase MCI_Footnotes_Widget_Base
<span class="phpdocumentor-element__extends"> <span class="phpdocumentor-element__extends">
extends <abbr title="\WP_Widget">WP_Widget</abbr> extends <abbr title="\WP_Widget">WP_Widget</abbr>
@ -88,7 +88,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">24</span> <span class="phpdocumentor-element-found-in__line">21</span>
</aside> </aside>
<p class="phpdocumentor-summary">Base Class for all Plugin Widgets. Registers each Widget to WordPress.</p> <p class="phpdocumentor-summary">Base Class for all Plugin Widgets. Registers each Widget to WordPress.</p>
@ -136,35 +136,35 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-WidgetBase.html#method___construct">__construct()</a> <a href="classes/MCI-Footnotes-Widget-Base.html#method___construct">__construct()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Class Constructor. Registers the child Widget to WordPress.</dd> <dd>Class Constructor. Registers the child Widget to WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getDescription">getDescription()</a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_description">get_description()</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Returns the Description of the child widget.</dd> <dd>Returns the Description of the child widget.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getID">getID()</a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_id">get_id()</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Returns an unique ID as string used for the Widget Base ID.</dd> <dd>Returns an unique ID as string used for the Widget Base ID.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getName">getName()</a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_name">get_name()</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Returns the Public name of child Widget to be displayed in the Configuration page.</dd> <dd>Returns the Public name of child Widget to be displayed in the Configuration page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getWidgetWidth">getWidgetWidth()</a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_widget_width">get_widget_width()</a>
<span> <span>
&nbsp;: int </span> &nbsp;: int </span>
</dt> </dt>
@ -181,7 +181,7 @@
<section class="phpdocumentor-methods"> <section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods"> <h3 class="phpdocumentor-elements__header" id="methods">
Methods Methods
<a href="classes/MCI-Footnotes-WidgetBase.html#methods" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3> </h3>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -191,12 +191,12 @@
> >
<h4 class="phpdocumentor-element__name" id="method___construct"> <h4 class="phpdocumentor-element__name" id="method___construct">
__construct() __construct()
<a href="classes/MCI-Footnotes-WidgetBase.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">77</span> <span class="phpdocumentor-element-found-in__line">69</span>
</aside> </aside>
<p class="phpdocumentor-summary">Class Constructor. Registers the child Widget to WordPress.</p> <p class="phpdocumentor-summary">Class Constructor. Registers the child Widget to WordPress.</p>
@ -215,15 +215,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -276,21 +267,21 @@
-protected -protected
-abstract " -abstract "
> >
<h4 class="phpdocumentor-element__name" id="method_getDescription"> <h4 class="phpdocumentor-element__name" id="method_get_description">
getDescription() get_description()
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getDescription" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_description" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">51</span> <span class="phpdocumentor-element-found-in__line">45</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns the Description of the child widget.</p> <p class="phpdocumentor-summary">Returns the Description of the child widget.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getDescription</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">get_description</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -302,15 +293,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -334,21 +316,21 @@
-protected -protected
-abstract " -abstract "
> >
<h4 class="phpdocumentor-element__name" id="method_getID"> <h4 class="phpdocumentor-element__name" id="method_get_id">
getID() get_id()
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getID" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_id" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">33</span> <span class="phpdocumentor-element-found-in__line">29</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p> <p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getID</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">get_id</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -360,15 +342,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -392,21 +365,21 @@
-protected -protected
-abstract " -abstract "
> >
<h4 class="phpdocumentor-element__name" id="method_getName"> <h4 class="phpdocumentor-element__name" id="method_get_name">
getName() get_name()
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getName" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_name" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">42</span> <span class="phpdocumentor-element-found-in__line">37</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns the Public name of child Widget to be displayed in the Configuration page.</p> <p class="phpdocumentor-summary">Returns the Public name of child Widget to be displayed in the Configuration page.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getName</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">get_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -418,15 +391,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -450,21 +414,21 @@
-protected -protected
" "
> >
<h4 class="phpdocumentor-element__name" id="method_getWidgetWidth"> <h4 class="phpdocumentor-element__name" id="method_get_widget_width">
getWidgetWidth() get_widget_width()
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getWidgetWidth" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_widget_width" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">60</span> <span class="phpdocumentor-element-found-in__line">53</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p> <p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getWidgetWidth</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <span class="phpdocumentor-signature__name">get_widget_width</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -476,15 +440,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -518,7 +473,7 @@
</section> </section>
</div> </div>
</div> </div>
<a href="classes/MCI-Footnotes-WidgetBase.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main> </main>

163
docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html → docs/classes/MCI-Footnotes-Widget-Reference-Container.html
View file

@ -70,15 +70,15 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title"> <h2 class="phpdocumentor-content__title">
MCI_Footnotes_Widget_ReferenceContainer MCI_Footnotes_Widget_Reference_Container
<span class="phpdocumentor-element__extends"> <span class="phpdocumentor-element__extends">
extends <a href="classes/MCI-Footnotes-WidgetBase.html"><abbr title="\MCI_Footnotes_WidgetBase">MCI_Footnotes_WidgetBase</abbr></a> extends <a href="classes/MCI-Footnotes-Widget-Base.html"><abbr title="\MCI_Footnotes_Widget_Base">MCI_Footnotes_Widget_Base</abbr></a>
</span> </span>
@ -88,7 +88,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">19</span> <span class="phpdocumentor-element-found-in__line">15</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers a Widget to put the Reference Container to the widget area.</p> <p class="phpdocumentor-summary">Registers a Widget to put the Reference Container to the widget area.</p>
@ -102,15 +102,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -133,49 +124,49 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-WidgetBase.html#method___construct">__construct()</a> <a href="classes/MCI-Footnotes-Widget-Base.html#method___construct">__construct()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Class Constructor. Registers the child Widget to WordPress.</dd> <dd>Class Constructor. Registers the child Widget to WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_form">form()</a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_form">form()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Outputs the Settings of the Widget.</dd> <dd>Outputs the Settings of the Widget.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_widget">widget()</a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_widget">widget()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Outputs the Content of the Widget.</dd> <dd>Outputs the Content of the Widget.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getDescription">getDescription()</a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_description">get_description()</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Returns the Description of the child widget.</dd> <dd>Returns the Description of the child widget.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getID">getID()</a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_id">get_id()</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Returns an unique ID as string used for the Widget Base ID.</dd> <dd>Returns an unique ID as string used for the Widget Base ID.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getName">getName()</a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_name">get_name()</a>
<span> <span>
&nbsp;: string </span> &nbsp;: string </span>
</dt> </dt>
<dd>Returns the Public name of the Widget to be displayed in the Configuration page.</dd> <dd>Returns the Public name of the Widget to be displayed in the Configuration page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected"> <dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getWidgetWidth">getWidgetWidth()</a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_widget_width">get_widget_width()</a>
<span> <span>
&nbsp;: int </span> &nbsp;: int </span>
</dt> </dt>
@ -192,7 +183,7 @@
<section class="phpdocumentor-methods"> <section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods"> <h3 class="phpdocumentor-elements__header" id="methods">
Methods Methods
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#methods" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3> </h3>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -202,12 +193,12 @@
> >
<h4 class="phpdocumentor-element__name" id="method___construct"> <h4 class="phpdocumentor-element__name" id="method___construct">
__construct() __construct()
<a href="classes/MCI-Footnotes-WidgetBase.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">77</span> <span class="phpdocumentor-element-found-in__line">69</span>
</aside> </aside>
<p class="phpdocumentor-summary">Class Constructor. Registers the child Widget to WordPress.</p> <p class="phpdocumentor-summary">Class Constructor. Registers the child Widget to WordPress.</p>
@ -226,15 +217,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -289,12 +271,12 @@
> >
<h4 class="phpdocumentor-element__name" id="method_form"> <h4 class="phpdocumentor-element__name" id="method_form">
form() form()
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_form" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_form" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">66</span> <span class="phpdocumentor-element-found-in__line">58</span>
</aside> </aside>
<p class="phpdocumentor-summary">Outputs the Settings of the Widget.</p> <p class="phpdocumentor-summary">Outputs the Settings of the Widget.</p>
@ -312,7 +294,8 @@
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"><p>The instance of the widget.</p>
</section>
</dd> </dd>
</dl> </dl>
@ -324,15 +307,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -346,7 +320,7 @@
<h5 class="phpdocumentor-return-value__heading">Return values</h5> <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span> <span class="phpdocumentor-signature__response_type">void</span>
&mdash; &mdash;
<section class="phpdocumentor-description"><p>Edit: curly quotes 2.2.0 2020-12-12T2130+0100</p> <section class="phpdocumentor-description"><p>Edit: curly quotes 2.2.0</p>
</section> </section>
@ -359,12 +333,12 @@
> >
<h4 class="phpdocumentor-element__name" id="method_widget"> <h4 class="phpdocumentor-element__name" id="method_widget">
widget() widget()
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_widget" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_widget" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">78</span> <span class="phpdocumentor-element-found-in__line">69</span>
</aside> </aside>
<p class="phpdocumentor-summary">Outputs the Content of the Widget.</p> <p class="phpdocumentor-summary">Outputs the Content of the Widget.</p>
@ -382,7 +356,8 @@
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"><p>The widget's arguments.</p>
</section>
</dd> </dd>
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
@ -390,7 +365,8 @@
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"><p>The instance of the widget.</p>
</section>
</dd> </dd>
</dl> </dl>
@ -402,15 +378,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -434,21 +401,21 @@
-protected -protected
" "
> >
<h4 class="phpdocumentor-element__name" id="method_getDescription"> <h4 class="phpdocumentor-element__name" id="method_get_description">
getDescription() get_description()
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getDescription" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_description" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">52</span> <span class="phpdocumentor-element-found-in__line">45</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns the Description of the child widget.</p> <p class="phpdocumentor-summary">Returns the Description of the child widget.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getDescription</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <span class="phpdocumentor-signature__name">get_description</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -460,15 +427,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -482,7 +440,7 @@
<h5 class="phpdocumentor-return-value__heading">Return values</h5> <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span> <span class="phpdocumentor-signature__response_type">string</span>
&mdash; &mdash;
<section class="phpdocumentor-description"><p>Edit: curly quotes 2.2.0 2020-12-12T2130+0100</p> <section class="phpdocumentor-description"><p>Edit: curly quotes 2.2.0</p>
</section> </section>
@ -493,21 +451,21 @@
-protected -protected
" "
> >
<h4 class="phpdocumentor-element__name" id="method_getID"> <h4 class="phpdocumentor-element__name" id="method_get_id">
getID() get_id()
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getID" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_id" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">28</span> <span class="phpdocumentor-element-found-in__line">23</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p> <p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getID</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <span class="phpdocumentor-signature__name">get_id</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -519,15 +477,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -551,21 +500,21 @@
-protected -protected
" "
> >
<h4 class="phpdocumentor-element__name" id="method_getName"> <h4 class="phpdocumentor-element__name" id="method_get_name">
getName() get_name()
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getName" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_name" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/reference-container.php"><a href="files/class-widgets-reference-container.html"><abbr title="class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">39</span> <span class="phpdocumentor-element-found-in__line">33</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns the Public name of the Widget to be displayed in the Configuration page.</p> <p class="phpdocumentor-summary">Returns the Public name of the Widget to be displayed in the Configuration page.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getName</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code> <span class="phpdocumentor-signature__name">get_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -577,15 +526,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -609,21 +549,21 @@
-protected -protected
" "
> >
<h4 class="phpdocumentor-element__name" id="method_getWidgetWidth"> <h4 class="phpdocumentor-element__name" id="method_get_widget_width">
getWidgetWidth() get_widget_width()
<a href="classes/MCI-Footnotes-WidgetBase.html#method_getWidgetWidth" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes-Widget-Base.html#method_get_widget_width" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/widgets/base.php"><a href="files/class-widgets-base.html"><abbr title="class/widgets/base.php">base.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">60</span> <span class="phpdocumentor-element-found-in__line">53</span>
</aside> </aside>
<p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p> <p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getWidgetWidth</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code> <span class="phpdocumentor-signature__name">get_widget_width</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -635,15 +575,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -677,7 +608,7 @@
</section> </section>
</div> </div>
</div> </div>
<a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> <a href="classes/MCI-Footnotes-Widget-Reference-Container.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main> </main>

461
docs/classes/MCI-Footnotes.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -class"> <article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">33</span> <span class="phpdocumentor-element-found-in__line">29</span>
</aside> </aside>
<p class="phpdocumentor-summary">Entry point of the Plugin. Loads the Dashboard and executes the Task.</p> <p class="phpdocumentor-summary">Entry point of the Plugin. Loads the Dashboard and executes the Task.</p>
@ -99,15 +99,6 @@
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -130,35 +121,49 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -public"> <dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/MCI-Footnotes.html#property_a_bool_AlternativeTooltipsEnabled">$a_bool_AlternativeTooltipsEnabled</a> <a href="classes/MCI-Footnotes.html#property_a_bool_alternative_tooltips_enabled">$a_bool_alternative_tooltips_enabled</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/MCI-Footnotes.html#property_a_bool_TooltipsEnabled">$a_bool_TooltipsEnabled</a>
<span> <span>
&nbsp;: bool </span> &nbsp;: bool </span>
</dt> </dt>
<dd>Template process and script / stylesheet load optimization.</dd> <dd>Allows to determine whether alternative tooltips are enabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public"> <dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/MCI-Footnotes.html#property_a_obj_Task">$a_obj_Task</a> <a href="classes/MCI-Footnotes.html#property_a_bool_amp_enabled">$a_bool_amp_enabled</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Allows to determine whether AMP compatibility mode is enabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/MCI-Footnotes.html#property_a_bool_tooltips_enabled">$a_bool_tooltips_enabled</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Allows to determine whether tooltips are enabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/MCI-Footnotes.html#property_a_obj_task">$a_obj_task</a>
<span> <span>
&nbsp;: null|<a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a> </span> &nbsp;: null|<a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a> </span>
</dt> </dt>
<dd>Reference to the Plugin Task object.</dd> <dd>Reference to the Plugin Task object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/MCI-Footnotes.html#property_a_str_script_mode">$a_str_script_mode</a>
<span>
&nbsp;: <abbr title="\str">str</abbr> </span>
</dt>
<dd>Allows to determine the script mode among jQuery or plain JS.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes.html#method_initializeWidgets">initializeWidgets()</a> <a href="classes/MCI-Footnotes.html#method_initialize_widgets">initialize_widgets()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Initializes all Widgets of the Plugin.</dd> <dd>Initializes all Widgets of the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes.html#method_registerPublic">registerPublic()</a> <a href="classes/MCI-Footnotes.html#method_register_public">register_public()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
@ -172,14 +177,14 @@
<dd>Executes the Plugin.</dd> <dd>Executes the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private"> <dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/MCI-Footnotes.html#method_initializeDashboard">initializeDashboard()</a> <a href="classes/MCI-Footnotes.html#method_initialize_dashboard">initialize_dashboard()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
<dd>Initializes the Dashboard of the Plugin and loads them.</dd> <dd>Initializes the Dashboard of the Plugin and loads them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private"> <dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/MCI-Footnotes.html#method_initializeTask">initializeTask()</a> <a href="classes/MCI-Footnotes.html#method_initialize_task">initialize_task()</a>
<span> <span>
&nbsp;: mixed </span> &nbsp;: mixed </span>
</dt> </dt>
@ -204,27 +209,81 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="property_a_bool_AlternativeTooltipsEnabled"> <h4 class="phpdocumentor-element__name" id="property_a_bool_alternative_tooltips_enabled">
$a_bool_AlternativeTooltipsEnabled $a_bool_alternative_tooltips_enabled
<a href="classes/MCI-Footnotes.html#property_a_bool_AlternativeTooltipsEnabled" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes.html#property_a_bool_alternative_tooltips_enabled" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers"> <span class="phpdocumentor-element__modifiers">
</span> </span>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">65</span> <span class="phpdocumentor-element-found-in__line">74</span>
</aside> </aside>
<p class="phpdocumentor-summary">Allows to determine whether alternative tooltips are enabled.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">mixed</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$a_bool_AlternativeTooltipsEnabled</span> <span class="phpdocumentor-signature__name">$a_bool_alternative_tooltips_enabled</span>
= <span class="phpdocumentor-signature__default-value"> alse</span></code> = <span class="phpdocumentor-signature__default-value"> alse</span></code>
<section class="phpdocumentor-description"><ul>
<li>Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.</li>
</ul>
</section>
<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">2.1.1</span>
<section class="phpdocumentor-description"></section>
</dd>
<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">2.4.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">reporter</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@andreasra</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566"> https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566 </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">contributor</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Patrizia Lutz @misfist</p>
</section>
</dd>
</dl>
</article> </article>
<article <article
@ -234,27 +293,137 @@
-public -public
-static " -static "
> >
<h4 class="phpdocumentor-element__name" id="property_a_bool_TooltipsEnabled"> <h4 class="phpdocumentor-element__name" id="property_a_bool_amp_enabled">
$a_bool_TooltipsEnabled $a_bool_amp_enabled
<a href="classes/MCI-Footnotes.html#property_a_bool_TooltipsEnabled" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes.html#property_a_bool_amp_enabled" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers"> <span class="phpdocumentor-element__modifiers">
</span> </span>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">64</span> <span class="phpdocumentor-element-found-in__line">96</span>
</aside> </aside>
<p class="phpdocumentor-summary">Template process and script / stylesheet load optimization.</p> <p class="phpdocumentor-summary">Allows to determine whether AMP compatibility mode is enabled.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$a_bool_TooltipsEnabled</span> <span class="phpdocumentor-signature__name">$a_bool_amp_enabled</span>
= <span class="phpdocumentor-signature__default-value"> alse</span></code> = <span class="phpdocumentor-signature__default-value"> alse</span></code>
<section class="phpdocumentor-description"><ul> <section class="phpdocumentor-description"><ul>
<li>Adding: Tooltips: make display work purely by style rules for AMP compatibility, thanks to @milindmore22 code contribution.</li>
<li>Bugfix: Tooltips: enable accessibility by keyboard navigation, thanks to @westonruter code contribution.</li>
<li>Adding: Reference container: get expanding and collapsing to work also in AMP compatibility mode, thanks to @westonruter code contribution.</li>
</ul>
</section>
<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">2.5.11</span>
<section class="phpdocumentor-description"><p>(draft)</p>
</section>
</dd>
<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">2.6.0</span>
<section class="phpdocumentor-description"><p>(release)</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">contributor</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@milindmore22</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">contributor</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@westonruter</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933"> https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655"> https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/markcheret/footnotes/issues/48#issuecomment-799580854"> https://github.com/markcheret/footnotes/issues/48#issuecomment-799580854 </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/markcheret/footnotes/issues/48#issuecomment-799582394"> https://github.com/markcheret/footnotes/issues/48#issuecomment-799582394 </a>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="property_a_bool_tooltips_enabled">
$a_bool_tooltips_enabled
<a href="classes/MCI-Footnotes.html#property_a_bool_tooltips_enabled" 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="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Allows to determine whether tooltips are enabled.</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__type">bool</span>
<span class="phpdocumentor-signature__name">$a_bool_tooltips_enabled</span>
= <span class="phpdocumentor-signature__default-value"> alse</span></code>
<section class="phpdocumentor-description"><p>The actual value of these properties is configurable.</p>
<ul>
<li>Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution.</li> <li>Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution.</li>
</ul> </ul>
</section> </section>
@ -275,16 +444,7 @@
</dd> </dd>
<dt class="phpdocumentor-tag-list__entry"> <dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">date</span> <span class="phpdocumentor-tag__name">contributor</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>2021-01-04T1355+0100</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -325,16 +485,16 @@
-public -public
" "
> >
<h4 class="phpdocumentor-element__name" id="property_a_obj_Task"> <h4 class="phpdocumentor-element__name" id="property_a_obj_task">
$a_obj_Task $a_obj_task
<a href="classes/MCI-Footnotes.html#property_a_obj_Task" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes.html#property_a_obj_task" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers"> <span class="phpdocumentor-element__modifiers">
</span> </span>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">42</span> <span class="phpdocumentor-element-found-in__line">37</span>
</aside> </aside>
<p class="phpdocumentor-summary">Reference to the Plugin Task object.</p> <p class="phpdocumentor-summary">Reference to the Plugin Task object.</p>
@ -342,7 +502,7 @@
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">null|<a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></span> <span class="phpdocumentor-signature__type">null|<a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></span>
<span class="phpdocumentor-signature__name">$a_obj_Task</span> <span class="phpdocumentor-signature__name">$a_obj_task</span>
= <span class="phpdocumentor-signature__default-value"> = <span class="phpdocumentor-signature__default-value">
ull</span></code> ull</span></code>
@ -355,15 +515,6 @@ ull</span></code>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -374,6 +525,88 @@ ull</span></code>
</dd> </dd>
</dl> </dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="property_a_str_script_mode">
$a_str_script_mode
<a href="classes/MCI-Footnotes.html#property_a_str_script_mode" 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="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>
<p class="phpdocumentor-summary">Allows to determine the script mode among jQuery or plain JS.</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__type"><abbr title="\str">str</abbr></span>
<span class="phpdocumentor-signature__name">$a_str_script_mode</span>
= <span class="phpdocumentor-signature__default-value">&#039;js&#039;</span></code>
<section class="phpdocumentor-description"><ul>
<li>Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.</li>
</ul>
</section>
<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">2.5.6</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">reporter</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@hopper87it</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">reporter</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@pkverma99</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/footnotes-wp-rocket/"> https://wordpress.org/support/topic/footnotes-wp-rocket/ </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/footnotes-wp-rocket/#post-14076188"> https://wordpress.org/support/topic/footnotes-wp-rocket/#post-14076188 </a>
</dd>
</dl>
</article> </article>
</section> </section>
@ -388,21 +621,21 @@ ull</span></code>
-public -public
" "
> >
<h4 class="phpdocumentor-element__name" id="method_initializeWidgets"> <h4 class="phpdocumentor-element__name" id="method_initialize_widgets">
initializeWidgets() initialize_widgets()
<a href="classes/MCI-Footnotes.html#method_initializeWidgets" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes.html#method_initialize_widgets" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">134</span> <span class="phpdocumentor-element-found-in__line">180</span>
</aside> </aside>
<p class="phpdocumentor-summary">Initializes all Widgets of the Plugin.</p> <p class="phpdocumentor-summary">Initializes all Widgets of the Plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">initializeWidgets</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">initialize_widgets</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -414,15 +647,6 @@ ull</span></code>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -514,7 +738,7 @@ and use the bare register_widget() here.</p>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\self::run()">self::run()</abbr></span> <span class="phpdocumentor-tag-link"><abbr title="\self::run()">self::run()</abbr></span>
<section class="phpdocumentor-description"><p>Also, the visibility of initializeWidgets() is not private any longer.</p> <section class="phpdocumentor-description"><p>Also, the visibility of initialize_widgets() is not private any longer.</p>
</section> </section>
</dd> </dd>
@ -533,21 +757,21 @@ and use the bare register_widget() here.</p>
-public -public
" "
> >
<h4 class="phpdocumentor-element__name" id="method_registerPublic"> <h4 class="phpdocumentor-element__name" id="method_register_public">
registerPublic() register_public()
<a href="classes/MCI-Footnotes.html#method_registerPublic" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes.html#method_register_public" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">171</span> <span class="phpdocumentor-element-found-in__line">214</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers and enqueues scripts and stylesheets to the public pages.</p> <p class="phpdocumentor-summary">Registers and enqueues scripts and stylesheets to the public pages.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">registerPublic</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">register_public</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -559,15 +783,6 @@ and use the bare register_widget() here.</p>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -592,7 +807,7 @@ and use the bare register_widget() here.</p>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.0.3</span> <span class="phpdocumentor-tag-link">2.0.3</span>
<section class="phpdocumentor-description"><p>add versioning of public.css for cache busting 2020-10-29T1413+0100</p> <section class="phpdocumentor-description"><p>add versioning of public.css for cache busting</p>
</section> </section>
</dd> </dd>
@ -602,7 +817,7 @@ and use the bare register_widget() here.</p>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.0.4</span> <span class="phpdocumentor-tag-link">2.0.4</span>
<section class="phpdocumentor-description"><p>add jQuery UI from WordPress 2020-11-01T1902+0100</p> <section class="phpdocumentor-description"><p>add jQuery UI from WordPress</p>
</section> </section>
</dd> </dd>
@ -612,7 +827,7 @@ and use the bare register_widget() here.</p>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.1.4</span> <span class="phpdocumentor-tag-link">2.1.4</span>
<section class="phpdocumentor-description"><p>automate passing version number for cache busting 2020-11-30T0646+0100</p> <section class="phpdocumentor-description"><p>automate passing version number for cache busting</p>
</section> </section>
</dd> </dd>
@ -622,7 +837,7 @@ and use the bare register_widget() here.</p>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.1.4</span> <span class="phpdocumentor-tag-link">2.1.4</span>
<section class="phpdocumentor-description"><p>optionally enqueue an extra stylesheet 2020-12-04T2231+0100</p> <section class="phpdocumentor-description"><p>optionally enqueue an extra stylesheet</p>
</section> </section>
</dd> </dd>
@ -648,7 +863,7 @@ and use the bare register_widget() here.</p>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">83</span> <span class="phpdocumentor-element-found-in__line">131</span>
</aside> </aside>
<p class="phpdocumentor-summary">Executes the Plugin.</p> <p class="phpdocumentor-summary">Executes the Plugin.</p>
@ -667,15 +882,6 @@ and use the bare register_widget() here.</p>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -708,6 +914,13 @@ and use the bare register_widget() here.</p>
<dt class="phpdocumentor-tag-list__entry"> <dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span> <span class="phpdocumentor-tag__name">link</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/benleyjyc/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793"> https://github.com/benleyjyc/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793"> https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 </a> <a class="phpdocumentor-tag-link" href="https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793"> https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 </a>
@ -716,7 +929,7 @@ and use the bare register_widget() here.</p>
<span class="phpdocumentor-tag__name">see</span> <span class="phpdocumentor-tag__name">see</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\self::initializeWidgets()">self::initializeWidgets()</abbr></span> <span class="phpdocumentor-tag-link"><abbr title="\self::initialize_widgets()">self::initialize_widgets()</abbr></span>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -736,21 +949,21 @@ and use the bare register_widget() here.</p>
-private -private
" "
> >
<h4 class="phpdocumentor-element__name" id="method_initializeDashboard"> <h4 class="phpdocumentor-element__name" id="method_initialize_dashboard">
initializeDashboard() initialize_dashboard()
<a href="classes/MCI-Footnotes.html#method_initializeDashboard" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes.html#method_initialize_dashboard" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">144</span> <span class="phpdocumentor-element-found-in__line">189</span>
</aside> </aside>
<p class="phpdocumentor-summary">Initializes the Dashboard of the Plugin and loads them.</p> <p class="phpdocumentor-summary">Initializes the Dashboard of the Plugin and loads them.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">initializeDashboard</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">initialize_dashboard</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -762,15 +975,6 @@ and use the bare register_widget() here.</p>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
@ -794,21 +998,21 @@ and use the bare register_widget() here.</p>
-private -private
" "
> >
<h4 class="phpdocumentor-element__name" id="method_initializeTask"> <h4 class="phpdocumentor-element__name" id="method_initialize_task">
initializeTask() initialize_task()
<a href="classes/MCI-Footnotes.html#method_initializeTask" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/MCI-Footnotes.html#method_initialize_task" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="class/init.php"><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">154</span> <span class="phpdocumentor-element-found-in__line">198</span>
</aside> </aside>
<p class="phpdocumentor-summary">Initializes the Plugin Task and registers the Task hooks.</p> <p class="phpdocumentor-summary">Initializes the Plugin Task and registers the Task hooks.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">initializeTask</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">initialize_task</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -820,15 +1024,6 @@ and use the bare register_widget() here.</p>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry"> <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> <span class="phpdocumentor-tag__name">since</span>
</dt> </dt>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">

2
docs/files/class-config.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

2
docs/files/class-convert.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

2
docs/files/class-dashboard-init.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

4
docs/files/class-dashboard-layout.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">
@ -85,7 +85,7 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-LayoutEngine.html"><abbr title="\MCI_Footnotes_LayoutEngine">MCI_Footnotes_LayoutEngine</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Engine.html"><abbr title="\MCI_Footnotes_Layout_Engine">MCI_Footnotes_Layout_Engine</abbr></a></dt>
<dd>Layout Engine for the administration dashboard.</dd> <dd>Layout Engine for the administration dashboard.</dd>
</dl> </dl>

2
docs/files/class-dashboard-subpage-main.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

2
docs/files/class-hooks.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

2
docs/files/class-init.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

2
docs/files/class-language.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

2
docs/files/class-settings.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

4
docs/files/class-task.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">
@ -86,7 +86,7 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt>
<dd>Searches and replaces the footnotes.</dd> <dd>Searches and replaces the footnotes and generates the reference container.</dd>
</dl> </dl>

2
docs/files/class-template.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">

4
docs/files/class-widgets-base.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">
@ -85,7 +85,7 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WidgetBase.html"><abbr title="\MCI_Footnotes_WidgetBase">MCI_Footnotes_WidgetBase</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Base.html"><abbr title="\MCI_Footnotes_Widget_Base">MCI_Footnotes_Widget_Base</abbr></a></dt>
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd> <dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
</dl> </dl>

4
docs/files/class-widgets-reference-container.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">
@ -85,7 +85,7 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html"><abbr title="\MCI_Footnotes_Widget_ReferenceContainer">MCI_Footnotes_Widget_ReferenceContainer</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Reference-Container.html"><abbr title="\MCI_Footnotes_Widget_Reference_Container">MCI_Footnotes_Widget_Reference_Container</abbr></a></dt>
<dd>Registers a Widget to put the Reference Container to the widget area.</dd> <dd>Registers a Widget to put the Reference Container to the widget area.</dd>
</dl> </dl>

4
docs/files/class-wysiwyg.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <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> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">
@ -86,7 +86,7 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt>
<dd></dd> <dd>Handles the WSYIWYG-Buttons.</dd>
</dl> </dl>

110
docs/files/footnotes.html
View file

@ -1,110 +0,0 @@
<!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">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<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="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></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">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
</section>
<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="packages/Default.html">Default</a></li>
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">footnotes.php</h2>
</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="files/footnotes.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>

190
docs/files/includes.html
View file

@ -1,190 +0,0 @@
<!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">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<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="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></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">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
</section>
<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="packages/Default.html">Default</a></li>
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">includes.php</h2>
<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 -function -">
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles">MCI_Footnotes_requirePhpFiles()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Requires (require_once) all *.php files inside a specific Directory.</dd>
</dl>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="files/includes.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_MCI_Footnotes_requirePhpFiles">
MCI_Footnotes_requirePhpFiles()
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes.php"><a href="files/includes.html"><abbr title="includes.php">includes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<p class="phpdocumentor-summary">Requires (require_once) all *.php files inside a specific Directory.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">MCI_Footnotes_requirePhpFiles</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_Directory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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_Directory</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Absolute Directory path to lookup for *.php files</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">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">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
</section>
</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="files/includes.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>

92
docs/index.html
View file

@ -87,10 +87,8 @@
<dd>Converts data types and Footnotes specific values.</dd> <dd>Converts data types and Footnotes specific values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt>
<dd>Handles the Settings interface of the Plugin.</dd> <dd>Handles the Settings interface of the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-LayoutEngine.html"><abbr title="\MCI_Footnotes_LayoutEngine">MCI_Footnotes_LayoutEngine</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Engine.html"><abbr title="\MCI_Footnotes_Layout_Engine">MCI_Footnotes_Layout_Engine</abbr></a></dt>
<dd>Layout Engine for the administration dashboard.</dd> <dd>Layout Engine for the administration dashboard.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Diagnostics.html"><abbr title="\MCI_Footnotes_Layout_Diagnostics">MCI_Footnotes_Layout_Diagnostics</abbr></a></dt>
<dd>Displays Diagnostics of the web server, PHP and WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt>
<dd>Displays and handles all Settings of the Plugin.</dd> <dd>Displays and handles all Settings of the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt>
@ -102,102 +100,22 @@
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt>
<dd>Loads the settings values, sets to default values if undefined.</dd> <dd>Loads the settings values, sets to default values if undefined.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt>
<dd>Searches and replaces the footnotes.</dd> <dd>Searches and replaces the footnotes and generates the reference container.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt>
<dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd> <dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WidgetBase.html"><abbr title="\MCI_Footnotes_WidgetBase">MCI_Footnotes_WidgetBase</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Base.html"><abbr title="\MCI_Footnotes_Widget_Base">MCI_Footnotes_Widget_Base</abbr></a></dt>
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd> <dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html"><abbr title="\MCI_Footnotes_Widget_ReferenceContainer">MCI_Footnotes_Widget_ReferenceContainer</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Reference-Container.html"><abbr title="\MCI_Footnotes_Widget_Reference_Container">MCI_Footnotes_Widget_Reference_Container</abbr></a></dt>
<dd>Registers a Widget to put the Reference Container to the widget area.</dd> <dd>Registers a Widget to put the Reference Container to the widget area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt>
<dd></dd> <dd>Handles the WSYIWYG-Buttons.</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 -function -">
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles">MCI_Footnotes_requirePhpFiles()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Requires (require_once) all *.php files inside a specific Directory.</dd>
</dl> </dl>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_MCI_Footnotes_requirePhpFiles">
MCI_Footnotes_requirePhpFiles()
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes.php"><a href="files/includes.html"><abbr title="includes.php">includes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<p class="phpdocumentor-summary">Requires (require_once) all *.php files inside a specific Directory.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">MCI_Footnotes_requirePhpFiles</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_Directory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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_Directory</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Absolute Directory path to lookup for *.php files</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">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">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
</section>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog"> <section class="phpdocumentor-search-results__dialog">

8
docs/indices/files.html
View file

@ -79,10 +79,6 @@
<ul class="phpdocumentor-list"> <ul class="phpdocumentor-list">
<li><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></li> <li><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></li>
<li><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></li> <li><a href="files/class-convert.html"><abbr title="class/convert.php">convert.php</abbr></a></li>
</ul>
<h3>F</h3>
<ul class="phpdocumentor-list">
<li><a href="files/footnotes.html"><abbr title="footnotes.php">footnotes.php</abbr></a></li>
</ul> </ul>
<h3>H</h3> <h3>H</h3>
<ul class="phpdocumentor-list"> <ul class="phpdocumentor-list">
@ -90,9 +86,8 @@
</ul> </ul>
<h3>I</h3> <h3>I</h3>
<ul class="phpdocumentor-list"> <ul class="phpdocumentor-list">
<li><a href="files/includes.html"><abbr title="includes.php">includes.php</abbr></a></li>
<li><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></li>
<li><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></li> <li><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></li>
<li><a href="files/class-init.html"><abbr title="class/init.php">init.php</abbr></a></li>
</ul> </ul>
<h3>L</h3> <h3>L</h3>
<ul class="phpdocumentor-list"> <ul class="phpdocumentor-list">
@ -106,7 +101,6 @@
<h3>S</h3> <h3>S</h3>
<ul class="phpdocumentor-list"> <ul class="phpdocumentor-list">
<li><a href="files/class-settings.html"><abbr title="class/settings.php">settings.php</abbr></a></li> <li><a href="files/class-settings.html"><abbr title="class/settings.php">settings.php</abbr></a></li>
<li><a href="files/class-dashboard-subpage-diagnostics.html"><abbr title="class/dashboard/subpage-diagnostics.php">subpage-diagnostics.php</abbr></a></li>
<li><a href="files/class-dashboard-subpage-main.html"><abbr title="class/dashboard/subpage-main.php">subpage-main.php</abbr></a></li> <li><a href="files/class-dashboard-subpage-main.html"><abbr title="class/dashboard/subpage-main.php">subpage-main.php</abbr></a></li>
</ul> </ul>
<h3>T</h3> <h3>T</h3>

1558
docs/js/searchIndex.js
View file

File diff suppressed because it is too large Load diff

92
docs/namespaces/default.html
View file

@ -90,10 +90,8 @@
<dd>Converts data types and Footnotes specific values.</dd> <dd>Converts data types and Footnotes specific values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt>
<dd>Handles the Settings interface of the Plugin.</dd> <dd>Handles the Settings interface of the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-LayoutEngine.html"><abbr title="\MCI_Footnotes_LayoutEngine">MCI_Footnotes_LayoutEngine</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Engine.html"><abbr title="\MCI_Footnotes_Layout_Engine">MCI_Footnotes_Layout_Engine</abbr></a></dt>
<dd>Layout Engine for the administration dashboard.</dd> <dd>Layout Engine for the administration dashboard.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Diagnostics.html"><abbr title="\MCI_Footnotes_Layout_Diagnostics">MCI_Footnotes_Layout_Diagnostics</abbr></a></dt>
<dd>Displays Diagnostics of the web server, PHP and WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt>
<dd>Displays and handles all Settings of the Plugin.</dd> <dd>Displays and handles all Settings of the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt>
@ -105,102 +103,22 @@
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt>
<dd>Loads the settings values, sets to default values if undefined.</dd> <dd>Loads the settings values, sets to default values if undefined.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt>
<dd>Searches and replaces the footnotes.</dd> <dd>Searches and replaces the footnotes and generates the reference container.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt>
<dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd> <dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WidgetBase.html"><abbr title="\MCI_Footnotes_WidgetBase">MCI_Footnotes_WidgetBase</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Base.html"><abbr title="\MCI_Footnotes_Widget_Base">MCI_Footnotes_Widget_Base</abbr></a></dt>
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd> <dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html"><abbr title="\MCI_Footnotes_Widget_ReferenceContainer">MCI_Footnotes_Widget_ReferenceContainer</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Reference-Container.html"><abbr title="\MCI_Footnotes_Widget_Reference_Container">MCI_Footnotes_Widget_Reference_Container</abbr></a></dt>
<dd>Registers a Widget to put the Reference Container to the widget area.</dd> <dd>Registers a Widget to put the Reference Container to the widget area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt>
<dd></dd> <dd>Handles the WSYIWYG-Buttons.</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 -function -">
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles">MCI_Footnotes_requirePhpFiles()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Requires (require_once) all *.php files inside a specific Directory.</dd>
</dl> </dl>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_MCI_Footnotes_requirePhpFiles">
MCI_Footnotes_requirePhpFiles()
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes.php"><a href="files/includes.html"><abbr title="includes.php">includes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<p class="phpdocumentor-summary">Requires (require_once) all *.php files inside a specific Directory.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">MCI_Footnotes_requirePhpFiles</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_Directory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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_Directory</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Absolute Directory path to lookup for *.php files</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">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">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
</section>
</article> </article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">

2
docs/packages/default.html
View file

@ -81,7 +81,7 @@
</h3> </h3>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></dt>
</dl> </dl>

18
docs/files/class-dashboard-subpage-diagnostics.html → docs/packages/footdnotes.html
View file

@ -51,9 +51,13 @@
<section class="phpdocumentor-sidebar__category"> <section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2> <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
</section> </section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footdnotes.html"><abbr title="\footdnotes">footdnotes</abbr></a></h3>
</section>
<section class="phpdocumentor-sidebar__category"> <section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2> <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -70,11 +74,10 @@
<div class="phpdocumentor-column -eight phpdocumentor-content"> <div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs"> <ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
</ul> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -package">
<h2 class="phpdocumentor-content__title">subpage-diagnostics.php</h2> <h2 class="phpdocumentor-content__title">footdnotes</h2>
@ -85,8 +88,8 @@
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Diagnostics.html"><abbr title="\MCI_Footnotes_Layout_Diagnostics">MCI_Footnotes_Layout_Diagnostics</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt>
<dd>Displays Diagnostics of the web server, PHP and WordPress.</dd> <dd>Registers all WordPress Hooks and executes them on demand.</dd>
</dl> </dl>
@ -95,7 +98,6 @@
</article> </article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog"> <section class="phpdocumentor-search-results__dialog">
@ -110,7 +112,7 @@
</section> </section>
</div> </div>
</div> </div>
<a href="files/class-dashboard-subpage-diagnostics.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> <a href="packages/footdnotes.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main> </main>

96
docs/packages/Default.html → docs/packages/footnotes.html
View file

@ -73,7 +73,7 @@
</ul> </ul>
<article class="phpdocumentor-element -package"> <article class="phpdocumentor-element -package">
<h2 class="phpdocumentor-content__title">Default</h2> <h2 class="phpdocumentor-content__title">footnotes</h2>
@ -90,10 +90,8 @@
<dd>Converts data types and Footnotes specific values.</dd> <dd>Converts data types and Footnotes specific values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt>
<dd>Handles the Settings interface of the Plugin.</dd> <dd>Handles the Settings interface of the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-LayoutEngine.html"><abbr title="\MCI_Footnotes_LayoutEngine">MCI_Footnotes_LayoutEngine</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Engine.html"><abbr title="\MCI_Footnotes_Layout_Engine">MCI_Footnotes_Layout_Engine</abbr></a></dt>
<dd>Layout Engine for the administration dashboard.</dd> <dd>Layout Engine for the administration dashboard.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Diagnostics.html"><abbr title="\MCI_Footnotes_Layout_Diagnostics">MCI_Footnotes_Layout_Diagnostics</abbr></a></dt>
<dd>Displays Diagnostics of the web server, PHP and WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt>
<dd>Displays and handles all Settings of the Plugin.</dd> <dd>Displays and handles all Settings of the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt>
@ -105,102 +103,22 @@
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt>
<dd>Loads the settings values, sets to default values if undefined.</dd> <dd>Loads the settings values, sets to default values if undefined.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt>
<dd>Searches and replaces the footnotes.</dd> <dd>Searches and replaces the footnotes and generates the reference container.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt>
<dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd> <dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WidgetBase.html"><abbr title="\MCI_Footnotes_WidgetBase">MCI_Footnotes_WidgetBase</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Base.html"><abbr title="\MCI_Footnotes_Widget_Base">MCI_Footnotes_Widget_Base</abbr></a></dt>
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd> <dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html"><abbr title="\MCI_Footnotes_Widget_ReferenceContainer">MCI_Footnotes_Widget_ReferenceContainer</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Reference-Container.html"><abbr title="\MCI_Footnotes_Widget_Reference_Container">MCI_Footnotes_Widget_Reference_Container</abbr></a></dt>
<dd>Registers a Widget to put the Reference Container to the widget area.</dd> <dd>Registers a Widget to put the Reference Container to the widget area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt>
<dd></dd> <dd>Handles the WSYIWYG-Buttons.</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 -function -">
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles">MCI_Footnotes_requirePhpFiles()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Requires (require_once) all *.php files inside a specific Directory.</dd>
</dl> </dl>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="packages/Default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_MCI_Footnotes_requirePhpFiles">
MCI_Footnotes_requirePhpFiles()
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes.php"><a href="files/includes.html"><abbr title="includes.php">includes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<p class="phpdocumentor-summary">Requires (require_once) all *.php files inside a specific Directory.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">MCI_Footnotes_requirePhpFiles</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_Directory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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_Directory</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Absolute Directory path to lookup for *.php files</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">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">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
</section>
</article> </article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
@ -216,7 +134,7 @@
</section> </section>
</div> </div>
</div> </div>
<a href="packages/Default.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> <a href="packages/footnotes.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main> </main>

43
docs/reports/errors.html
View file

@ -84,11 +84,11 @@
<td class="phpdocumentor-cell">1</td> <td class="phpdocumentor-cell">1</td>
</tr> </tr>
<tr> <tr>
<td class="phpdocumentor-cell"><a href="reports/errors.html#class/language.php">class/language.php</a></td> <td class="phpdocumentor-cell"><a href="reports/errors.html#class/hooks.php">class/hooks.php</a></td>
<td class="phpdocumentor-cell">1</td> <td class="phpdocumentor-cell">1</td>
</tr> </tr>
<tr> <tr>
<td class="phpdocumentor-cell"><a href="reports/errors.html#class/settings.php">class/settings.php</a></td> <td class="phpdocumentor-cell"><a href="reports/errors.html#class/language.php">class/language.php</a></td>
<td class="phpdocumentor-cell">1</td> <td class="phpdocumentor-cell">1</td>
</tr> </tr>
</table> </table>
@ -108,8 +108,25 @@
<tr> <tr>
<td class="phpdocumentor-cell">ERROR</td> <td class="phpdocumentor-cell">ERROR</td>
<td class="phpdocumentor-cell">0</td> <td class="phpdocumentor-cell">0</td>
<td class="phpdocumentor-cell">Tag &quot;see&quot; with body &quot;@see templates/dashboard/customize-css.html <td class="phpdocumentor-cell">Tag &quot;see&quot; with body &quot;@see templates/dashboard/customize-css.html&quot; has error &quot;\templates/dashboard/customize-css.html&quot; is not a valid Fqsen.</td>
2020-12-09T1113+0100&quot; has error &quot;\templates/dashboard/customize-css.html&quot; is not a valid Fqsen.</td> </tr>
</tbody>
</table>
<a id="class/hooks.php"></a>
<h3><abbr title="class/hooks.php">hooks.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">ERROR</td>
<td class="phpdocumentor-cell">0</td>
<td class="phpdocumentor-cell">Tag &quot;see&quot; with body &quot;@see class/settings.php&quot; has error &quot;\class/settings.php&quot; is not a valid Fqsen.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -131,24 +148,6 @@
</tr> </tr>
</tbody> </tbody>
</table> </table>
<a id="class/settings.php"></a>
<h3><abbr title="class/settings.php">settings.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">ERROR</td>
<td class="phpdocumentor-cell">0</td>
<td class="phpdocumentor-cell">Tag &quot;since&quot; with body &quot;@since ditched trimming whitespace from text box content in response to user request.&quot; has error </td>
</tr>
</tbody>
</table>
</div> </div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog"> <section class="phpdocumentor-search-results__dialog">

28
docs/reports/markers.html
View file

@ -77,32 +77,10 @@
<div class="phpdocumentor-row"> <div class="phpdocumentor-row">
<h2 class="phpdocumentor-content__title">Markers</h2> <h2 class="phpdocumentor-content__title">Markers</h2>
<h3>Table of Contents</h3> <div class="phpdocumentor-admonition phpdocumentor-admonition--success">
<table class="phpdocumentor-table_of_contents"> No markers have been found in this project.
<tr> </div>
<td class="phpdocumentor-cell"><a href="reports/markers.html#class/settings.php">class/settings.php</a></td>
<td class="phpdocumentor-cell">1</td>
</tr>
</table>
<a id="class/settings.php"></a>
<h3><abbr title="class/settings.php">settings.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">89</td>
<td class="phpdocumentor-cell">Eventually change misleading variable names C_BOOL_… to C_STR_… (that’s how Hungarian screws things up).</td>
</tr>
</tbody>
</table>
</div> </div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog"> <section class="phpdocumentor-search-results__dialog">

29
phpdoc.dist.xml Normal file
View file

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
configVersion="3.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://www.phpdoc.org"
xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
>
<paths>
<output>docs</output>
</paths>
<version number="3.0">
<api format="php">
<source dsn=".">
<path>class</path>
</source>
<output>docs</output>
<ignore hidden="true" symlinks="true">
<path>vendor/*</path>
<path>node-modules/*</path>
</ignore>
<extensions>
<extension>php</extension>
</extensions>
<default-package-name>Footnotes</default-package-name>
<include-source>true</include-source>
</api>
</version>
</phpdocumentor>

9
readme.txt
View file

@ -10,14 +10,13 @@ License URI: https://www.gnu.org/licenses/gpl-3.0.html
== Description == == Description ==
Featured on wpmudev: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/
Cheers for the review, folks!
https://www.youtube.com/watch?v=HzHaMAAJwbI
**footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of defaults while also empowering you to control how your footnotes are being displayed. **footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of defaults while also empowering you to control how your footnotes are being displayed.
**footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts, as well as in post excerpts with fully functional tooltips if enabled. **footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts, as well as in post excerpts with fully functional tooltips if enabled.
Featured on wpmudev: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/ Cheers for the review, folks!
https://www.youtube.com/watch?v=HzHaMAAJwbI
= Main Features = = Main Features =
- Fully customizable **footnote** start and end shortcodes; - Fully customizable **footnote** start and end shortcodes;
- Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text; - Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text;