mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-12-23 01:55:01 +00:00
536 lines
32 KiB
HTML
536 lines
32 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">44</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-778800744"></a>
|
||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||
</div>
|
||
<div id="namespace-778800744" 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>ids</h1>
|
||
<p><em>Provides an interface to interact with page ids.</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/ids.html#method_getid" class="">getid()</a><br />
|
||
<a href="../classes/ids.html#method_getpagename" class="">getpagename()</a><br />
|
||
<a href="../classes/ids.html#method_movepagename" class="">movepagename()</a><br />
|
||
<a href="../classes/ids.html#method_deletepagename" class="">deletepagename()</a><br />
|
||
<a href="../classes/ids.html#method_clear" class="">clear()</a><br />
|
||
</section>
|
||
<section class="span4">
|
||
<em>No public properties found</em>
|
||
</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">\ids</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="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_getid" name="method_getid" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">getid()</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;">getid(string <span class="argument">$pagename</span>) : integer</pre>
|
||
<p><em>Gets the page id associated with the given page name.</em></p>
|
||
<p>If it doesn't exist in the id index, it will be added.</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$pagename </td>
|
||
<td><p>The name of the page to fetch the id for.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
integer
|
||
— <p>The id for the specified page name.</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_getpagename" name="method_getpagename" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">getpagename()</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;">getpagename(integer <span class="argument">$id</span>) : string</pre>
|
||
<p><em>Gets the page name associated with the given page id.</em></p>
|
||
<p>Be warned that if the id index is cleared (e.g. when the search index is
|
||
rebuilt from scratch), the id associated with a page name may change!</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>integer</td>
|
||
<td>$id </td>
|
||
<td><p>The id to fetch the page name for.</p></td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Returns</h4>
|
||
string
|
||
— <p>The page name currently associated with the specified id.</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_movepagename" name="method_movepagename" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">movepagename()</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;">movepagename(string <span class="argument">$oldpagename</span>, string <span class="argument">$newpagename</span>) </pre>
|
||
<p><em>Moves a page in the id index from $oldpagename to $newpagename.</em></p>
|
||
<p>Note that this function doesn't perform any special checks to make sure
|
||
that the destination name doesn't already exist.</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$oldpagename </td>
|
||
<td><p>The old page name to move.</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$newpagename </td>
|
||
<td><p>The new page name to move the old page name to.</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_deletepagename" name="method_deletepagename" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">deletepagename()</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;">deletepagename(string <span class="argument">$pagename</span>) </pre>
|
||
<p><em>Removes the given page name from the id index.</em></p>
|
||
<p>Note that this function doesn't handle multiple entries with the same
|
||
name. Also note that it may get re-added during a search reindex if the
|
||
page still exists.</p>
|
||
|
||
<h4>Parameters</h4>
|
||
<table class="table table-condensed table-hover">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$pagename </td>
|
||
<td><p>The page name to delete from the id index.</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_clear" name="method_clear" class="anchor"></a>
|
||
<article class="method">
|
||
<h3 class="public ">clear()</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;">clear() </pre>
|
||
<p><em>Clears the id index completely.</em></p>
|
||
<p>Will break the inverted search index! Make sure you rebuild the search
|
||
index (if the search module is installed, of course) if you want search
|
||
to still work. Of course, note that will re-add all the pages to the id
|
||
index.</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 December 12th, 2018 at 23:20.
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</footer>
|
||
</div>
|
||
|
||
</body>
|
||
</html>
|