<!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>CtextFilter API Documentaion</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">CtextFilter API Documentaion</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown">
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="../namespaces/Mos.html">\Mos</a></li>
</ul>
</li>
<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">2</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">1</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-1881060423"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1881060423" class="accordion-body collapse in">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-815009140"></a>
<a href="../namespaces/Mos.html" style="margin-left: 30px; padding-left: 0">Mos</a>
</div>
<div id="namespace-815009140" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1974148759"></a>
<a href="../namespaces/Mos.TextFilter.html" style="margin-left: 30px; padding-left: 0">TextFilter</a>
</div>
<div id="namespace-1974148759" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Mos.TextFilter.CTextFilter.html">CTextFilter</a></li>
<li class="class"><a href="../classes/Mos.TextFilter.Exception.html">Exception</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
<ul>
</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/Mos.TextFilter.html">\Mos\TextFilter</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>\Mos\TextFilter</small>CTextFilter</h1>
<p><em>Filter and format content.</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/Mos.TextFilter.CTextFilter.html#method_doFilter" class="deprecated">doFilter()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_getFilters" class="">getFilters()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_hasFilter" class="">hasFilter()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_parse" class="">parse()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_jsonFrontMatter" class="">jsonFrontMatter()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_yamlFrontMatter" class="">yamlFrontMatter()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_bbcode2html" class="">bbcode2html()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_makeClickable" class="">makeClickable()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_purify" class="">purify()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_markdown" class="">markdown()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_nl2br" class="">nl2br()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_shortCode" class="">shortCode()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_shortCodeInit" class="">shortCodeInit()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_shortCodeFigure" class="">shortCodeFigure()</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">
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_parseFactory" class="">parseFactory()</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#method_extractFrontMatter" class="">extractFrontMatter()</a><br />
</section>
<section class="span4">
<a href="../classes/Mos.TextFilter.CTextFilter.html#property_filters" class="">$filters</a><br />
<a href="../classes/Mos.TextFilter.CTextFilter.html#property_current" class="">$current</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/CTextFilter.html"><div class="path-wrapper">CTextFilter.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\Mos\TextFilter\CTextFilter</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_filters" name="property_filters" class="anchor"></a>
<article class="property">
<h3 class="private ">$filters</h3>
<pre class="signature">$filters : </pre>
<p><em>Supported filters.</em></p>
<h4>Type</h4>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_current" name="property_current" class="anchor"></a>
<article class="property">
<h3 class="private ">$current</h3>
<pre class="signature">$current : </pre>
<p><em>Current document parsed.</em></p>
<h4>Type</h4>
</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><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_doFilter" name="method_doFilter" class="anchor"></a>
<article class="method">
<h3 class="public deprecated">doFilter()</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;">doFilter(string <span class="argument">$text</span>, string|array <span class="argument">$filters</span>) : string</pre>
<p><em>Call each filter.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>the text to filter.</p></td>
</tr>
<tr>
<td>string|array</td>
<td>$filters </td>
<td><p>as comma separated list of filter,
or filters sent in as array.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>the formatted text.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<aside class="alert alert-block alert-error">
<h4>Deprecated</h4>
deprecated since version 1.2 in favour of parse().
</aside>
<dl>
</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">
<div class="span8 content class">
<a id="method_getFilters" name="method_getFilters" class="anchor"></a>
<article class="method">
<h3 class="public ">getFilters()</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;">getFilters() : array</pre>
<p><em>Return an array of all filters supported.</em></p>
<h4>Returns</h4>
array
— <p>with strings of filters supported.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_hasFilter" name="method_hasFilter" class="anchor"></a>
<article class="method">
<h3 class="public ">hasFilter()</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;">hasFilter(string <span class="argument">$filter</span>) : boolean</pre>
<p><em>Check if filter is supported.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$filter </td>
<td><p>to use.</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\Mos\TextFilter\mos/TextFilter/Exception</dt>
<dd><p>when filter does not exists.</p></dd>
</dl>
<h4>Returns</h4>
boolean
— <p>true if filter exists, false othwerwise.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_parse" name="method_parse" class="anchor"></a>
<article class="method">
<h3 class="public ">parse()</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(string <span class="argument">$text</span>, array <span class="argument">$filter</span>) : array</pre>
<p><em>Call each filter and return array with details of the formatted content.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>the text to filter.</p></td>
</tr>
<tr>
<td>array</td>
<td>$filter </td>
<td><p>array of filters to use.</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\Mos\TextFilter\mos/TextFilter/Exception</dt>
<dd><p>when filterd does not exists.</p></dd>
</dl>
<h4>Returns</h4>
array
— <p>with the formatted text and additional details.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_jsonFrontMatter" name="method_jsonFrontMatter" class="anchor"></a>
<article class="method">
<h3 class="public ">jsonFrontMatter()</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;">jsonFrontMatter(string <span class="argument">$text</span>) : array</pre>
<p><em>Extract JSON front matter from text.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>the text to be parsed.</p></td>
</tr>
</table>
<h4>Returns</h4>
array
— <p>with the formatted text and the front matter.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_yamlFrontMatter" name="method_yamlFrontMatter" class="anchor"></a>
<article class="method">
<h3 class="public ">yamlFrontMatter()</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;">yamlFrontMatter(string <span class="argument">$text</span>) : array</pre>
<p><em>Extract YAML front matter from text.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>the text to be parsed.</p></td>
</tr>
</table>
<h4>Returns</h4>
array
— <p>with the formatted text and the front matter.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_bbcode2html" name="method_bbcode2html" class="anchor"></a>
<article class="method">
<h3 class="public ">bbcode2html()</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;">bbcode2html(string <span class="argument">$text</span>) : string</pre>
<p><em>Helper, BBCode formatting converting to HTML.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>The text to be converted.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>the formatted text.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://dbwebb.se/coachen/reguljara-uttryck-i-php-ger-bbcode-formattering"><span class="namespace-wrapper">http://dbwebb.se/coachen/reguljara-uttryck-i-php-ger-bbcode-formattering</span></a></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">
<div class="span8 content class">
<a id="method_makeClickable" name="method_makeClickable" class="anchor"></a>
<article class="method">
<h3 class="public ">makeClickable()</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;">makeClickable(string <span class="argument">$text</span>) : string</pre>
<p><em>Make clickable links from URLs in text.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>the text that should be formatted.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>with formatted anchors.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>See also</dt>
<dd><a href="http://dbwebb.se/coachen/lat-php-funktion-make-clickable-automatiskt-skapa-klickbara-lankar"><span class="namespace-wrapper">http://dbwebb.se/coachen/lat-php-funktion-make-clickable-automatiskt-skapa-klickbara-lankar</span></a></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">
<div class="span8 content class">
<a id="method_purify" name="method_purify" class="anchor"></a>
<article class="method">
<h3 class="public ">purify()</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;">purify(string <span class="argument">$text</span>) : string</pre>
<p><em>Format text according to HTML Purifier.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>that should be formatted.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>as the formatted html-text.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_markdown" name="method_markdown" class="anchor"></a>
<article class="method">
<h3 class="public ">markdown()</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;">markdown(string <span class="argument">$text</span>) : string</pre>
<p><em>Format text according to Markdown syntax.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>the text that should be formatted.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>as the formatted html-text.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_nl2br" name="method_nl2br" class="anchor"></a>
<article class="method">
<h3 class="public ">nl2br()</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;">nl2br(string <span class="argument">$text</span>) : string</pre>
<p><em>For convenience access to nl2br</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>text to be converted.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>the formatted text.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_shortCode" name="method_shortCode" class="anchor"></a>
<article class="method">
<h3 class="public ">shortCode()</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;">shortCode(string <span class="argument">$text</span>) : string</pre>
<p><em>Shortcode to to quicker format text as HTML.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>text to be converted.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>the formatted text.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_shortCodeInit" name="method_shortCodeInit" class="anchor"></a>
<article class="method">
<h3 class="public ">shortCodeInit()</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;">shortCodeInit(string <span class="argument">$options</span>) : array</pre>
<p><em>Init shortcode handling by preparing the option list to an array, for those using arguments.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$options </td>
<td><p>for the shortcode.</p></td>
</tr>
</table>
<h4>Returns</h4>
array
— <p>with all the options.</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_shortCodeFigure" name="method_shortCodeFigure" class="anchor"></a>
<article class="method">
<h3 class="public ">shortCodeFigure()</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;">shortCodeFigure(string <span class="argument">$options</span>) : array</pre>
<p><em>Shortcode for <figure>.</em></p>
<p>Usage example: [FIGURE src="img/home/me.jpg" caption="Me" alt="Bild på mig" nolink="nolink"]</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$options </td>
<td><p>for the shortcode.</p></td>
</tr>
</table>
<h4>Returns</h4>
array
— <p>with all the options.</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_parseFactory" name="method_parseFactory" class="anchor"></a>
<article class="method">
<h3 class="private ">parseFactory()</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;">parseFactory(string <span class="argument">$filter</span>) : string</pre>
<p><em>Call a specific filter and store its details.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$filter </td>
<td><p>to use.</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\Mos\TextFilter\mos/TextFilter/Exception</dt>
<dd><p>when filter does not exists.</p></dd>
</dl>
<h4>Returns</h4>
string
— <p>the formatted text.</p>
</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><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_extractFrontMatter" name="method_extractFrontMatter" class="anchor"></a>
<article class="method">
<h3 class="private ">extractFrontMatter()</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;">extractFrontMatter(string <span class="argument">$text</span>, string <span class="argument">$startToken</span>, string <span class="argument">$stopToken</span>) : array</pre>
<p><em>Extract front matter from text.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$text </td>
<td><p>the text to be parsed.</p></td>
</tr>
<tr>
<td>string</td>
<td>$startToken </td>
<td><p>the start token.</p></td>
</tr>
<tr>
<td>string</td>
<td>$stopToken </td>
<td><p>the stop token.</p></td>
</tr>
</table>
<h4>Returns</h4>
array
— <p>with the formatted text and the front matter.</p>
</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><td colspan="2"><em>None found</em></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">CTextFilter.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/CTextFilter.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>
<li><a href="../namespaces/Mos.html">\Mos</a></li>
</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 14th, 2016 at 18:53.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>