mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-11-22 16:33:00 +00:00
954 lines
52 KiB
HTML
954 lines
52 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
||
<meta charset="utf-8"/>
|
||
<title>Pepperminty Wiki Module API</title>
|
||
<meta name="author" content=""/>
|
||
<meta name="description" content=""/>
|
||
|
||
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
|
||
<link href="../css/font-awesome.min.css" rel="stylesheet">
|
||
<link href="../css/prism.css" rel="stylesheet" media="all"/>
|
||
<link href="../css/template.css" rel="stylesheet" media="all"/>
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="../js/html5.js"></script>
|
||
<![endif]-->
|
||
<script src="../js/jquery-1.11.0.min.js"></script>
|
||
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
|
||
<script src="../js/bootstrap.min.js"></script>
|
||
<script src="../js/jquery.smooth-scroll.js"></script>
|
||
<script src="../js/prism.min.js"></script>
|
||
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
|
||
<script type="text/javascript">
|
||
function loadExternalCodeSnippets() {
|
||
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
|
||
var src = pre.getAttribute('data-src');
|
||
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
||
var language = 'php';
|
||
|
||
var code = document.createElement('code');
|
||
code.className = 'language-' + language;
|
||
|
||
pre.textContent = '';
|
||
|
||
code.textContent = 'Loading…';
|
||
|
||
pre.appendChild(code);
|
||
|
||
var xhr = new XMLHttpRequest();
|
||
|
||
xhr.open('GET', src, true);
|
||
|
||
xhr.onreadystatechange = function () {
|
||
if (xhr.readyState == 4) {
|
||
|
||
if (xhr.status < 400 && xhr.responseText) {
|
||
code.textContent = xhr.responseText;
|
||
|
||
Prism.highlightElement(code);
|
||
}
|
||
else if (xhr.status >= 400) {
|
||
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
||
}
|
||
else {
|
||
code.textContent = '✖ Error: File does not exist or is empty';
|
||
}
|
||
}
|
||
};
|
||
|
||
xhr.send(null);
|
||
});
|
||
}
|
||
|
||
$(document).ready(function(){
|
||
loadExternalCodeSnippets();
|
||
});
|
||
$('#source-view').on('shown', function () {
|
||
loadExternalCodeSnippets();
|
||
})
|
||
</script>
|
||
|
||
<link rel="shortcut icon" href="../images/favicon.ico"/>
|
||
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
|
||
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
|
||
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
|
||
</head>
|
||
<body>
|
||
|
||
<div class="navbar navbar-fixed-top">
|
||
<div class="navbar-inner">
|
||
<div class="container">
|
||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
||
<i class="icon-ellipsis-vertical"></i>
|
||
</a>
|
||
<a class="brand" href="../index.html">Pepperminty Wiki Module API</a>
|
||
|
||
<div class="nav-collapse">
|
||
<ul class="nav pull-right">
|
||
<li class="dropdown" id="charts-menu">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||
Charts <b class="caret"></b>
|
||
</a>
|
||
<ul class="dropdown-menu">
|
||
<li>
|
||
<a href="../graphs/class.html">
|
||
<i class="icon-list-alt"></i> Class hierarchy diagram
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="dropdown" id="reports-menu">
|
||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||
Reports <b class="caret"></b>
|
||
</a>
|
||
<ul class="dropdown-menu">
|
||
<li>
|
||
<a href="../reports/errors.html">
|
||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">47</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../reports/markers.html">
|
||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">6</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../reports/deprecated.html">
|
||
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span>
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<!--<div class="go_to_top">-->
|
||
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
|
||
<!--</div>-->
|
||
</div>
|
||
|
||
<div id="___" class="container-fluid">
|
||
<section class="row-fluid">
|
||
<div class="span2 sidebar">
|
||
<div class="accordion" style="margin-bottom: 0">
|
||
<div class="accordion-group">
|
||
<div class="accordion-heading">
|
||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-855065177"></a>
|
||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||
</div>
|
||
<div id="namespace-855065177" class="accordion-body collapse in">
|
||
<div class="accordion-inner">
|
||
|
||
|
||
<ul>
|
||
<li class="class"><a href="../classes/ids.html">ids</a></li>
|
||
<li class="class"><a href="../classes/page_renderer.html">page_renderer</a></li>
|
||
<li class="class"><a href="../classes/PeppermintParsedown.html">PeppermintParsedown</a></li>
|
||
<li class="class"><a href="../classes/search.html">search</a></li>
|
||
<li class="class"><a href="../classes/Slimdown.html">Slimdown</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</section>
|
||
<section class="row-fluid">
|
||
<div class="span10 offset2">
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<nav>
|
||
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
|
||
</nav>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
|
||
|
||
<h1><small>\</small>page_renderer</h1>
|
||
<p><em>Renders the HTML page that is sent to the client.</em></p>
|
||
|
||
|
||
|
||
<section id="summary">
|
||
<h2>Summary</h2>
|
||
<section class="row-fluid heading">
|
||
<section class="span4">
|
||
<a href="#methods">Methods</a>
|
||
</section>
|
||
<section class="span4">
|
||
<a href="#properties">Properties</a>
|
||
</section>
|
||
<section class="span4">
|
||
<a href="#constants">Constants</a>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid public">
|
||
<section class="span4">
|
||
<a href="../classes/page_renderer.html#method_register_part_preprocessor" class="">register_part_preprocessor()</a><br />
|
||
<a href="../classes/page_renderer.html#method_render" class="">render()</a><br />
|
||
<a href="../classes/page_renderer.html#method_render_main" class="">render_main()</a><br />
|
||
<a href="../classes/page_renderer.html#method_render_minimal" class="">render_minimal()</a><br />
|
||
<a href="../classes/page_renderer.html#method_get_header_html" class="">get_header_html()</a><br />
|
||
<a href="../classes/page_renderer.html#method_get_css_as_html" class="">get_css_as_html()</a><br />
|
||
<a href="../classes/page_renderer.html#method_AddJSLink" class="">AddJSLink()</a><br />
|
||
<a href="../classes/page_renderer.html#method_AddJSSnippet" class="">AddJSSnippet()</a><br />
|
||
<a href="../classes/page_renderer.html#method_render_navigation_bar" class="">render_navigation_bar()</a><br />
|
||
<a href="../classes/page_renderer.html#method_render_username" class="">render_username()</a><br />
|
||
<a href="../classes/page_renderer.html#method_generate_all_pages_datalist" class="">generate_all_pages_datalist()</a><br />
|
||
</section>
|
||
<section class="span4">
|
||
<a href="../classes/page_renderer.html#property_html_template" class="">$html_template</a><br />
|
||
<a href="../classes/page_renderer.html#property_main_content_template" class="">$main_content_template</a><br />
|
||
<a href="../classes/page_renderer.html#property_minimal_content_template" class="">$minimal_content_template</a><br />
|
||
<a href="../classes/page_renderer.html#property_nav_divider" class="">$nav_divider</a><br />
|
||
</section>
|
||
<section class="span4">
|
||
<em>No constants found</em>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid protected">
|
||
<section class="span4">
|
||
<em>No protected methods found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>No protected properties found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>N/A</em>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid private">
|
||
<section class="span4">
|
||
<em>No private methods found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>No private properties found</em>
|
||
</section>
|
||
<section class="span4">
|
||
<em>N/A</em>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
|
||
|
||
<dl>
|
||
<dt>File</dt>
|
||
<dd><a href="../files/core.html"><div class="path-wrapper">core.php</div></a></dd>
|
||
<dt>Package</dt>
|
||
<dd><div class="namespace-wrapper">core</div></dd>
|
||
<dt>Class hierarchy</dt>
|
||
<dd class="hierarchy">
|
||
<div class="namespace-wrapper">\page_renderer</div>
|
||
</dd>
|
||
|
||
|
||
|
||
|
||
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
|
||
<a id="properties" name="properties"></a>
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<h2>Properties</h2>
|
||
</div>
|
||
<aside class="span4 detailsbar"></aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="property_html_template" name="property_html_template" class="anchor"></a>
|
||
<article class="property">
|
||
<h3 class="public ">$html_template</h3>
|
||
<pre class="signature">$html_template : string</pre>
|
||
<p><em>The root HTML template that all pages are built from.</em></p>
|
||
|
||
|
||
<h4>Type</h4>
|
||
string
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="property_main_content_template" name="property_main_content_template" class="anchor"></a>
|
||
<article class="property">
|
||
<h3 class="public ">$main_content_template</h3>
|
||
<pre class="signature">$main_content_template : string</pre>
|
||
<p><em>The main content template that is used to render normal wiki pages.</em></p>
|
||
|
||
|
||
<h4>Type</h4>
|
||
string
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="property_minimal_content_template" name="property_minimal_content_template" class="anchor"></a>
|
||
<article class="property">
|
||
<h3 class="public ">$minimal_content_template</h3>
|
||
<pre class="signature">$minimal_content_template : string</pre>
|
||
<p><em>A specially minified content template that doesn't include the navbar and
|
||
other elements not suiltable for printing.</em></p>
|
||
|
||
|
||
<h4>Type</h4>
|
||
string
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="property_nav_divider" name="property_nav_divider" class="anchor"></a>
|
||
<article class="property">
|
||
<h3 class="public ">$nav_divider</h3>
|
||
<pre class="signature">$nav_divider : string</pre>
|
||
<p><em>The navigation bar divider.</em></p>
|
||
|
||
|
||
<h4>Type</h4>
|
||
string
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
|
||
<a id="methods" name="methods"></a>
|
||
<div class="row-fluid">
|
||
<div class="span8 content class"><h2>Methods</h2></div>
|
||
<aside class="span4 detailsbar"></aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_register_part_preprocessor" name="method_register_part_preprocessor" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">register_part_preprocessor()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">register_part_preprocessor(\function <span class="argument">$function</span>) </pre>
|
||
<p><em>Registers a function as a part post processor.</em></p>
|
||
<p>This function's use is more complicated to explain. Pepperminty Wiki
|
||
renders pages with a very simple templating system. For example, in the
|
||
template a page's content is denoted by <code>{content}</code>. A function
|
||
registered here will be passed all the components of a page <em>just</em>
|
||
before they are dropped into the template. Note that the function you
|
||
pass in here should take a <em>reference</em> to the components, as the return
|
||
value of the function passed is discarded.</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>\function</td>
|
||
<td>$function </td>
|
||
<td><p>The part preprocessor to register.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_render" name="method_render" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">render()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">render(string <span class="argument">$title</span>, string <span class="argument">$content</span>, boolean <span class="argument">$body_template = false</span>) : string</pre>
|
||
<p><em>Renders a HTML page with the content specified.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$title </td>
|
||
<td><p>The title of the page.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$content </td>
|
||
<td><p>The (HTML) content of the page.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>boolean</td>
|
||
<td>$body_template </td>
|
||
<td><p>The HTML content template to use.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The rendered HTML, ready to send to the client :-)</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_render_main" name="method_render_main" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">render_main()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">render_main(string <span class="argument">$title</span>, string <span class="argument">$content</span>) : string</pre>
|
||
<p><em>Renders a normal HTML page.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$title </td>
|
||
<td><p>The title of the page.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$content </td>
|
||
<td><p>The content of the page.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The rendered page.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_render_minimal" name="method_render_minimal" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">render_minimal()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">render_minimal(string <span class="argument">$title</span>, string <span class="argument">$content</span>) : string</pre>
|
||
<p><em>Renders a minimal HTML page. Useful for printable pages.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$title </td>
|
||
<td><p>The title of the page.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$content </td>
|
||
<td><p>The content of the page.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The rendered page.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_header_html" name="method_get_header_html" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">get_header_html()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_header_html() : string</pre>
|
||
<p><em>Renders the header HTML.</em></p>
|
||
|
||
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The rendered HTML that goes in the header.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_get_css_as_html" name="method_get_css_as_html" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">get_css_as_html()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">get_css_as_html() : string</pre>
|
||
<p><em>Renders all the CSS as HTML.</em></p>
|
||
|
||
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The css as HTML, ready to be included in the HTML header.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_AddJSLink" name="method_AddJSLink" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">AddJSLink()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">AddJSLink(string <span class="argument">$scriptUrl</span>) </pre>
|
||
<p><em>Adds the specified url to a javascript file as a reference to the page.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$scriptUrl </td>
|
||
<td><p>The url of the javascript file to reference.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_AddJSSnippet" name="method_AddJSSnippet" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">AddJSSnippet()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">AddJSSnippet(string <span class="argument">$script</span>) </pre>
|
||
<p><em>Adds a javascript snippet to the page.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$script </td>
|
||
<td><p>The snippet of javascript to add.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_render_navigation_bar" name="method_render_navigation_bar" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">render_navigation_bar()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">render_navigation_bar(array <span class="argument">$nav_links</span>, array <span class="argument">$nav_links_extra</span>, string <span class="argument">$class = ""</span>) </pre>
|
||
<p><em>Renders a navigation bar from an array of links. See
|
||
$settings->nav_links for format information.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$nav_links </td>
|
||
<td><p>The links to add to the navigation bar.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$nav_links_extra </td>
|
||
<td><p>The extra nav links to add to
|
||
the "More..." menu.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$class </td>
|
||
<td><p>The class(es) to assign to the rendered
|
||
navigation bar.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_render_username" name="method_render_username" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">render_username()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">render_username(string <span class="argument">$name</span>) : string</pre>
|
||
<p><em>Renders a username for inclusion in a page.</em></p>
|
||
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$name </td>
|
||
<td><p>The username to render.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The username rendered in HTML.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
<div class="row-fluid">
|
||
<div class="span8 content class">
|
||
<a id="method_generate_all_pages_datalist" name="method_generate_all_pages_datalist" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">generate_all_pages_datalist()</h3>
|
||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
<pre class="signature" style="margin-right: 54px;">generate_all_pages_datalist() : string</pre>
|
||
<p><em>Renders the datalist for the search box as HTML.</em></p>
|
||
|
||
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The search box datalist as HTML.</p>
|
||
|
||
</article>
|
||
</div>
|
||
<aside class="span4 detailsbar">
|
||
<h1><i class="icon-arrow-down"></i></h1>
|
||
<span class="label label-info">static</span>
|
||
<dl>
|
||
</dl>
|
||
<h2>Tags</h2>
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<th>
|
||
package
|
||
</th>
|
||
<td>
|
||
<p>core</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</aside>
|
||
</div>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
|
||
<div class="modal-header">
|
||
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
||
<h3 id="source-view-label">core.php</h3>
|
||
</div>
|
||
<div class="modal-body">
|
||
<pre data-src="../files/core.php.txt" class="language-php line-numbers"></pre>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="row-fluid">
|
||
<section class="span10 offset2">
|
||
<section class="row-fluid">
|
||
<section class="span10 offset1">
|
||
<section class="row-fluid footer-sections">
|
||
<section class="span4">
|
||
<h1><i class="icon-code"></i></h1>
|
||
<div>
|
||
<ul>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section class="span4">
|
||
<h1><i class="icon-bar-chart"></i></h1>
|
||
<div>
|
||
<ul>
|
||
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section class="span4">
|
||
<h1><i class="icon-pushpin"></i></h1>
|
||
<div>
|
||
<ul>
|
||
<li><a href="../reports/errors.html">Errors</a></li>
|
||
<li><a href="../reports/markers.html">Markers</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
<section class="row-fluid">
|
||
<section class="span10 offset1">
|
||
<hr />
|
||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||
on May 5th, 2018 at 20:53.
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</footer>
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|