sbrl-github/Pepperminty-Wiki
sbrl-github
/
Pepperminty-Wiki
mirror of https://github.com/sbrl/Pepperminty-Wiki.git
1
0
Fork 0
Code
Pepperminty-Wiki/docs/ModuleApi/files/core.70-parser-engine.html

506 lines
50 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>&#160;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>&#160;Errors <span class="label label-info pull-right">60</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">11</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;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&#160;&#160;<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-868886444"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-868886444" 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>core</small>70-parser-engine.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_add_parser" name="method_add_parser" class="anchor"></a>
<article class="method">
<h3 class=" ">add_parser()</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;">add_parser(string <span class="argument">$name</span>, callable <span class="argument">$parser_code</span>, callable <span class="argument">$hash_generator</span>) </pre>
<p><em>Registers a new parser.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name </td>
<td><p>The name of the new parser to register.</p></td>
</tr>
<tr>
<td>callable</td>
<td>$parser_code </td>
<td><p>The function to register as a new parser.</p></td>
</tr>
<tr>
<td>callable</td>
<td>$hash_generator </td>
<td><p>A function that should take a single argument of the input source text, and return a unique hash for that content. The return value is used as the filename for cache entries, so should be safe to use as such.</p></td>
</tr>
</table>
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293
Call Stack:
0.0007 401624 1. {main}() /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:0
0.0486 2278744 2. require('phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc') /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:10
0.1048 11884520 3. phpDocumentor\Application->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc:23
0.1058 12089344 4. Cilex\Provider\Console\ContainerAwareApplication->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Application.php:183
0.1059 12089344 5. Cilex\Provider\Console\ContainerAwareApplication->doRun() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:126
0.1060 12089344 6. Cilex\Provider\Console\ContainerAwareApplication->doRunCommand() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:195
0.1060 12089344 7. phpDocumentor\Command\Project\RunCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:874
0.1062 12093272 8. phpDocumentor\Command\Project\RunCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.2876 17871696 9. phpDocumentor\Transformer\Command\Project\TransformCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Command/Project/RunCommand.php:275
0.2877 17873864 10. phpDocumentor\Transformer\Command\Project\TransformCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.3309 21077656 11. phpDocumentor\Console\Output\Output->writeTimedLog() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Command/Project/TransformCommand.php:206
0.3310 21077656 12. call_user_func_array:{phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59}() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3310 21077672 13. phpDocumentor\Transformer\Transformer->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3318 21085696 14. phpDocumentor\Transformer\Transformer->transformProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:141
0.8937 24277704 15. phpDocumentor\Transformer\Transformer->applyTransformationToProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:275
0.8937 24277864 16. phpDocumentor\Plugin\Twig\Writer\Twig->transform() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:312
0.9318 25009000 17. Twig_Environment->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Plugin/Twig/Writer/Twig.php:116
0.9320 25018832 18. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php:334
0.9320 25035344 19. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:366
0.9320 25036472 20. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9320 25036472 21. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9320 25036848 22. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:25
0.9321 25037544 23. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9321 25037544 24. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9371 25101048 25. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:312
0.9371 25101048 26. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->block_content() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9381 25120280 27. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:423
0.9381 25120280 28. __TwigTemplate_daae0115ec37e5a0b571749c1314278fe63bff5db2e95ba142e0832d4760b44d->block_method() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9386 25121672 29. twig_length_filter() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:140
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293
Call Stack:
0.0007 401624 1. {main}() /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:0
0.0486 2278744 2. require('phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc') /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:10
0.1048 11884520 3. phpDocumentor\Application->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc:23
0.1058 12089344 4. Cilex\Provider\Console\ContainerAwareApplication->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Application.php:183
0.1059 12089344 5. Cilex\Provider\Console\ContainerAwareApplication->doRun() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:126
0.1060 12089344 6. Cilex\Provider\Console\ContainerAwareApplication->doRunCommand() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:195
0.1060 12089344 7. phpDocumentor\Command\Project\RunCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:874
0.1062 12093272 8. phpDocumentor\Command\Project\RunCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.2876 17871696 9. phpDocumentor\Transformer\Command\Project\TransformCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Command/Project/RunCommand.php:275
0.2877 17873864 10. phpDocumentor\Transformer\Command\Project\TransformCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.3309 21077656 11. phpDocumentor\Console\Output\Output->writeTimedLog() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Command/Project/TransformCommand.php:206
0.3310 21077656 12. call_user_func_array:{phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59}() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3310 21077672 13. phpDocumentor\Transformer\Transformer->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3318 21085696 14. phpDocumentor\Transformer\Transformer->transformProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:141
0.8937 24277704 15. phpDocumentor\Transformer\Transformer->applyTransformationToProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:275
0.8937 24277864 16. phpDocumentor\Plugin\Twig\Writer\Twig->transform() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:312
0.9318 25009000 17. Twig_Environment->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Plugin/Twig/Writer/Twig.php:116
0.9320 25018832 18. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php:334
0.9320 25035344 19. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:366
0.9320 25036472 20. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9320 25036472 21. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9320 25036848 22. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:25
0.9321 25037544 23. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9321 25037544 24. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9371 25101048 25. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:312
0.9371 25101048 26. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->block_content() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9381 25120280 27. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:423
0.9381 25120280 28. __TwigTemplate_daae0115ec37e5a0b571749c1314278fe63bff5db2e95ba142e0832d4760b44d->block_method() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9390 25121672 29. twig_length_filter() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:140
</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">core/70-parser-engine.php</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>core</p>
<p>core</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_parse_page_source" name="method_parse_page_source" class="anchor"></a>
<article class="method">
<h3 class=" ">parse_page_source()</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;">parse_page_source(string <span class="argument">$source</span>, boolean <span class="argument">$untrusted = false</span>, boolean <span class="argument">$use_cache = true</span>) : string</pre>
<p><em>Parses the specified page source using the parser specified in the settings
into HTML.</em></p>
<p>The specified parser may (though it's unlikely) render it to other things.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$source </td>
<td><p>The source to render.</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$untrusted </td>
<td><p>Whether the source string is 'untrusted' - i.e. a user comment. Untrusted source disallows HTML and protects against XSS attacks.</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$use_cache </td>
<td><p>Whether to use the on-disk cache. Has no effect if parser caching is disabled in peppermint.json, or the source string is too small.</p></td>
</tr>
</table>
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293
Call Stack:
0.0007 401624 1. {main}() /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:0
0.0486 2278744 2. require('phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc') /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:10
0.1048 11884520 3. phpDocumentor\Application->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc:23
0.1058 12089344 4. Cilex\Provider\Console\ContainerAwareApplication->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Application.php:183
0.1059 12089344 5. Cilex\Provider\Console\ContainerAwareApplication->doRun() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:126
0.1060 12089344 6. Cilex\Provider\Console\ContainerAwareApplication->doRunCommand() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:195
0.1060 12089344 7. phpDocumentor\Command\Project\RunCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:874
0.1062 12093272 8. phpDocumentor\Command\Project\RunCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.2876 17871696 9. phpDocumentor\Transformer\Command\Project\TransformCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Command/Project/RunCommand.php:275
0.2877 17873864 10. phpDocumentor\Transformer\Command\Project\TransformCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.3309 21077656 11. phpDocumentor\Console\Output\Output->writeTimedLog() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Command/Project/TransformCommand.php:206
0.3310 21077656 12. call_user_func_array:{phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59}() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3310 21077672 13. phpDocumentor\Transformer\Transformer->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3318 21085696 14. phpDocumentor\Transformer\Transformer->transformProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:141
0.8937 24277704 15. phpDocumentor\Transformer\Transformer->applyTransformationToProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:275
0.8937 24277864 16. phpDocumentor\Plugin\Twig\Writer\Twig->transform() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:312
0.9318 25009000 17. Twig_Environment->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Plugin/Twig/Writer/Twig.php:116
0.9320 25018832 18. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php:334
0.9320 25035344 19. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:366
0.9320 25036472 20. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9320 25036472 21. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9320 25036848 22. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:25
0.9321 25037544 23. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9321 25037544 24. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9371 25101048 25. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:312
0.9371 25101048 26. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->block_content() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9398 25136664 27. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:423
0.9398 25136664 28. __TwigTemplate_daae0115ec37e5a0b571749c1314278fe63bff5db2e95ba142e0832d4760b44d->block_method() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9403 25138056 29. twig_length_filter() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:140
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293
Call Stack:
0.0007 401624 1. {main}() /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:0
0.0486 2278744 2. require('phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc') /home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc:10
0.1048 11884520 3. phpDocumentor\Application->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/bin/phpdoc:23
0.1058 12089344 4. Cilex\Provider\Console\ContainerAwareApplication->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Application.php:183
0.1059 12089344 5. Cilex\Provider\Console\ContainerAwareApplication->doRun() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:126
0.1060 12089344 6. Cilex\Provider\Console\ContainerAwareApplication->doRunCommand() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:195
0.1060 12089344 7. phpDocumentor\Command\Project\RunCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Application.php:874
0.1062 12093272 8. phpDocumentor\Command\Project\RunCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.2876 17871696 9. phpDocumentor\Transformer\Command\Project\TransformCommand->run() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Command/Project/RunCommand.php:275
0.2877 17873864 10. phpDocumentor\Transformer\Command\Project\TransformCommand->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/symfony/console/Symfony/Component/Console/Command/Command.php:257
0.3309 21077656 11. phpDocumentor\Console\Output\Output->writeTimedLog() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Command/Project/TransformCommand.php:206
0.3310 21077656 12. call_user_func_array:{phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59}() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3310 21077672 13. phpDocumentor\Transformer\Transformer->execute() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Console/Output/Output.php:59
0.3318 21085696 14. phpDocumentor\Transformer\Transformer->transformProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:141
0.8937 24277704 15. phpDocumentor\Transformer\Transformer->applyTransformationToProject() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:275
0.8937 24277864 16. phpDocumentor\Plugin\Twig\Writer\Twig->transform() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Transformer/Transformer.php:312
0.9318 25009000 17. Twig_Environment->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/src/phpDocumentor/Plugin/Twig/Writer/Twig.php:116
0.9320 25018832 18. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->render() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php:334
0.9320 25035344 19. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:366
0.9320 25036472 20. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9320 25036472 21. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9320 25036848 22. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->display() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:25
0.9321 25037544 23. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayWithErrorHandling() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:355
0.9321 25037544 24. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->doDisplay() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:381
0.9371 25101048 25. __TwigTemplate_e9b916bc8ec0395bf82abe33efb058fa2ccd8b51a970b8ce47218fc40bb2c6c1->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:312
0.9371 25101048 26. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->block_content() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9398 25136664 27. __TwigTemplate_02ba832c2ea972798e806ba44910ce32645ca11f1a2988694d0e257df1bd7d72->displayBlock() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:423
0.9398 25136664 28. __TwigTemplate_daae0115ec37e5a0b571749c1314278fe63bff5db2e95ba142e0832d4760b44d->block_method() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Template.php:167
0.9406 25138056 29. twig_length_filter() phar:///home/sbrl/Documents/code/php/peppermint/build/_tmp/phpdoc/vendor/twig/twig/lib/Twig/Environment.php(390) : eval()'d code:140
<h4>Returns</h4>
string
&mdash; <p>The source rendered to 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">core/70-parser-engine.php</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>core</p>
<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"></h3>
</div>
<div class="modal-body">
<pre data-src="../files/core/70-parser-engine.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 July 5th, 2019 at 19:50.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>
View Git Blame Copy Permalink