phpdoc/Library/Converter/Html2Text.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\Converter\Html2Text | Library</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Library_Converter_Html2Text" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Library</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../Library.html">Library</a></li>
<li><a href="../../Library/Converter.html">Converter</a></li>
<li>Html2Text</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Html2Text</h1>
</div>
<p> class
<strong>Html2Text</strong> extends <a href="../../Library/Converter/AbstractConverter.html"><abbr title="Library\Converter\AbstractConverter">AbstractConverter</abbr></a>
</p>
<div class="description">
<p>HTML to plain text converter</p> <p>Freely (but mostly) inspired by the work of Jon Abernathy <a href="mailto:jon@chuggnutt.com">jon@chuggnutt.com</a>
and his "class.html2text.inc" (see <a href="http://www.chuggnutt.com/html2text">http://www.chuggnutt.com/html2text</a>).</p> </div>
<h2>Properties</h2>
<table class="table table-condensed">
<tr>
<td class="type" id="property_correspondances">
static
</td>
<td>$correspondances</td>
<td class="last">
</td>
<td></td>
</tr>
<tr>
<td class="type" id="property_allowed_tags">
</td>
<td>$allowed_tags</td>
<td class="last">
</td>
<td></td>
</tr>
<tr>
<td class="type" id="property_line_width">
</td>
<td>$line_width</td>
<td class="last">
</td>
<td></td>
</tr>
</table>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method_convert">convert</a>(
mixed $content, $allowed_tags = null, $line_width = null)
<p>Process a content conversion</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_setAllowedTags">setAllowedTags</a>($tags)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_setLineWidth">setLineWidth</a>($line_width)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_convert">
<div class="location">at line 98</div>
<code> static
mixed
<strong>convert</strong>(
mixed $content, $allowed_tags = null, $line_width = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Process a content conversion</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$content</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$allowed_tags</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$line_width</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setAllowedTags">
<div class="location">at line 88</div>
<code>
<strong>setAllowedTags</strong>($tags)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$tags</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setLineWidth">
<div class="location">at line 93</div>
<code>
<strong>setLineWidth</strong>($line_width)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$line_width</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>