<!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">8</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-2080703382"></a> <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> </div> <div id="namespace-2080703382" 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 file"> <nav> </nav> <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a> <h1><small>modules</small>feature-comments.php</h1> <p><em></em></p> </div> <aside class="span4 detailsbar"> <dl> <dt>Package</dt> <dd><div class="namespace-wrapper">\Default</div></dd> </dl> <h2>Tags</h2> <table class="table table-condensed"> <tr><td colspan="2"><em>None found</em></td></tr> </table> </aside> </div> <div class="row-fluid"> <section class="span8 content file"> <h2>Functions</h2> </section> <aside class="span4 detailsbar"></aside> </div> <div class="row-fluid"> <div class="span8 content class"> <a id="method_get_comment_filename" name="method_get_comment_filename" class="anchor"></a> <article class="method"> <h3 class=" ">get_comment_filename()</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_comment_filename(string <span class="argument">$pagename</span>) : string</pre> <p><em>Given a page name, returns the absolute file path in which that page's comments are stored.</em></p> <h4>Parameters</h4> <table class="table table-condensed table-hover"> <tr> <td>string</td> <td>$pagename </td> <td><p>The name pf the page to fetch the comments filename for.</p></td> </tr> </table> <h4>Returns</h4> string — <p>The path to the file that the</p> </article> </div> <aside class="span4 detailsbar"> <h1><i class="icon-arrow-down"></i></h1> <dl> <dt>File</dt> <dd><a href=""><div class="path-wrapper">modules/feature-comments.php</div></a></dd> </dl> <h2>Tags</h2> <table class="table table-condensed"> <tr> <th> package </th> <td> <p>feature-comments</p> <p>feature-comments</p> </td> </tr> </table> </aside> </div> <div class="row-fluid"> <div class="span8 content class"> <a id="method_generate_comment_id" name="method_generate_comment_id" class="anchor"></a> <article class="method"> <h3 class=" ">generate_comment_id()</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_comment_id() : string</pre> <p><em>Generates a new random comment id.</em></p> <h4>Returns</h4> string — <p>A new random comment id.</p> </article> </div> <aside class="span4 detailsbar"> <h1><i class="icon-arrow-down"></i></h1> <dl> <dt>File</dt> <dd><a href=""><div class="path-wrapper">modules/feature-comments.php</div></a></dd> </dl> <h2>Tags</h2> <table class="table table-condensed"> <tr> <th> package </th> <td> <p>feature-comments</p> <p>feature-comments</p> </td> </tr> </table> </aside> </div> <div class="row-fluid"> <div class="span8 content class"> <a id="method_find_comment" name="method_find_comment" class="anchor"></a> <article class="method"> <h3 class=" ">find_comment()</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;">find_comment(array <span class="argument">$comment_data</span>, string <span class="argument">$comment_id</span>) : object</pre> <p><em>Finds the comment with specified id by way of an almost-breadth-first search.</em></p> <h4>Parameters</h4> <table class="table table-condensed table-hover"> <tr> <td>array</td> <td>$comment_data </td> <td><p>The comment data to search.</p></td> </tr> <tr> <td>string</td> <td>$comment_id </td> <td><p>The id of the comment to find.</p></td> </tr> </table> <h4>Returns</h4> object — <p>The comment data with the specified id, or false if it wasn't found.</p> </article> </div> <aside class="span4 detailsbar"> <h1><i class="icon-arrow-down"></i></h1> <dl> <dt>File</dt> <dd><a href=""><div class="path-wrapper">modules/feature-comments.php</div></a></dd> </dl> <h2>Tags</h2> <table class="table table-condensed"> <tr> <th> package </th> <td> <p>feature-comments</p> <p>feature-comments</p> </td> </tr> </table> </aside> </div> <div class="row-fluid"> <div class="span8 content class"> <a id="method_delete_comment" name="method_delete_comment" class="anchor"></a> <article class="method"> <h3 class=" ">delete_comment()</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;">delete_comment(array <span class="argument">$comment_data</span>, string <span class="argument">$target_id</span>) : boolean</pre> <p><em>Deletes the first comment found with the specified id.</em></p> <h4>Parameters</h4> <table class="table table-condensed table-hover"> <tr> <td>array</td> <td>$comment_data </td> <td><p>An array of threaded comments to delete the comment from.</p></td> </tr> <tr> <td>string</td> <td>$target_id </td> <td><p>The id of the comment to delete.</p></td> </tr> </table> <h4>Returns</h4> boolean — <p>Whether the comment was found and deleted or not.</p> </article> </div> <aside class="span4 detailsbar"> <h1><i class="icon-arrow-down"></i></h1> <dl> <dt>File</dt> <dd><a href=""><div class="path-wrapper">modules/feature-comments.php</div></a></dd> </dl> <h2>Tags</h2> <table class="table table-condensed"> <tr> <th> package </th> <td> <p>feature-comments</p> <p>feature-comments</p> </td> </tr> </table> </aside> </div> <div class="row-fluid"> <div class="span8 content class"> <a id="method_fetch_comment_thread" name="method_fetch_comment_thread" class="anchor"></a> <article class="method"> <h3 class=" ">fetch_comment_thread()</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;">fetch_comment_thread(array <span class="argument">$comment_data</span>, string <span class="argument">$comment_id</span>) : array<mixed,object></pre> <p><em>Fetches all the parent comments of the specified comment id, including the comment itself at the end.</em></p> <p>Useful for figuring out who needs notifying when a new comment is posted.</p> <h4>Parameters</h4> <table class="table table-condensed table-hover"> <tr> <td>array</td> <td>$comment_data </td> <td><p>The comment data to search.</p></td> </tr> <tr> <td>string</td> <td>$comment_id </td> <td><p>The comment id to fetch the thread for.</p></td> </tr> </table> <h4>Returns</h4> array<mixed,object> — <p>A list of the comments in the thread, with the deepest one at the end.</p> </article> </div> <aside class="span4 detailsbar"> <h1><i class="icon-arrow-down"></i></h1> <dl> <dt>File</dt> <dd><a href=""><div class="path-wrapper">modules/feature-comments.php</div></a></dd> </dl> <h2>Tags</h2> <table class="table table-condensed"> <tr> <th> package </th> <td> <p>feature-comments</p> <p>feature-comments</p> </td> </tr> </table> </aside> </div> <div class="row-fluid"> <div class="span8 content class"> <a id="method_render_comments" name="method_render_comments" class="anchor"></a> <article class="method"> <h3 class=" ">render_comments()</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_comments(array<mixed,object> <span class="argument">$comments_data</span>, integer <span class="argument">$depth</span>) : string</pre> <p><em>Renders a given comments tree to html.</em></p> <h4>Parameters</h4> <table class="table table-condensed table-hover"> <tr> <td>array<mixed,object></td> <td>$comments_data </td> <td><p>The comments tree to render.</p></td> </tr> <tr> <td>integer</td> <td>$depth </td> <td><p>For internal use only. Specifies the depth at which the comments are being rendered.</p></td> </tr> </table> <h4>Returns</h4> string — <p>The given comments tree as html.</p> </article> </div> <aside class="span4 detailsbar"> <h1><i class="icon-arrow-down"></i></h1> <dl> <dt>File</dt> <dd><a href=""><div class="path-wrapper">modules/feature-comments.php</div></a></dd> </dl> <h2>Tags</h2> <table class="table table-condensed"> <tr> <th> package </th> <td> <p>feature-comments</p> <p>feature-comments</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"></h3> </div> <div class="modal-body"> <pre data-src="../files/modules/feature-comments.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 February 24th, 2019 at 16:02. </section> </section> </section> </footer> </div> </body> </html>