miniMVC/docs/classes/Output.html

179 lines
10 KiB
HTML
Raw Normal View History

<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>miniMVC » \Output</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/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"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">miniMVC</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
<li><a href="../packages/miniMVC.html"><i class="icon-folder-open"></i> miniMVC</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">1</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">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">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Initialize the output class"><span class="description">Initialize the output class</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#__destruct" title="__destruct :: PHP magic method called when ending the script
Used for outputing HTML"><span class="description">PHP magic method called when ending the script
Used for outputing HTML</span><pre>__destruct()</pre></a></li>
<li class="method public "><a href="#append_output" title="append_output :: Adds text to the output buffer"><span class="description">Adds text to the output buffer</span><pre>append_output()</pre></a></li>
<li class="method public "><a href="#flush_headers" title="flush_headers :: Sends headers and then removes them"><span class="description">Sends headers and then removes them</span><pre>flush_headers()</pre></a></li>
<li class="method public "><a href="#set_header" title="set_header :: Sets a header for later output"><span class="description">Sets a header for later output</span><pre>set_header()</pre></a></li>
<li class="method public "><a href="#set_output" title="set_output :: Sets the output buffer"><span class="description">Sets the output buffer</span><pre>set_output()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24buffer" title="$buffer :: Content for outputting"><span class="description">Content for outputting</span><pre>$buffer</pre></a></li>
<li class="property private "><a href="#%24headers" title="$headers :: HTTP headers to send"><span class="description">HTTP headers to send</span><pre>$headers</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5COutput" id="\Output"></a><div href="../classes/Output.html" class="element class">
<p class="short_description">Class for displaying output and setting http headers</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="..//packages/miniMVC.System.html">miniMVC</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>System</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Initialize the output class</h2>
<pre>__construct() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="__destruct" id="__destruct"></a><div class="element clickable method public __destruct" data-toggle="collapse" data-target=".__destruct .collapse">
<h2>PHP magic method called when ending the script
Used for outputing HTML</h2>
<pre>__destruct() : void</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="append_output" id="append_output"></a><div class="element clickable method public append_output" data-toggle="collapse" data-target=".append_output .collapse">
<h2>Adds text to the output buffer</h2>
<pre>append_output(string $string) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$string</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="flush_headers" id="flush_headers"></a><div class="element clickable method public flush_headers" data-toggle="collapse" data-target=".flush_headers .collapse">
<h2>Sends headers and then removes them</h2>
<pre>flush_headers() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="set_header" id="set_header"></a><div class="element clickable method public set_header" data-toggle="collapse" data-target=".set_header .collapse">
<h2>Sets a header for later output</h2>
<pre>set_header(string $key, string $val) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$val</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="set_output" id="set_output"></a><div class="element clickable method public set_output" data-toggle="collapse" data-target=".set_output .collapse">
<h2>Sets the output buffer</h2>
<pre>set_output(string $string) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$string</h4>
<code>string</code>
</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24buffer" id="$buffer"> </a><div class="element clickable property private $buffer" data-toggle="collapse" data-target=".$buffer .collapse">
<h2>Content for outputting</h2>
<pre>$buffer : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
<a name="%24headers" id="$headers"> </a><div class="element clickable property private $headers" data-toggle="collapse" data-target=".$headers .collapse">
<h2>HTTP headers to send</h2>
<pre>$headers : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="span8"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a2</a> and<br>
generated on 2012-04-26T15:30:04-04:00.<br></footer></div>
</div>
</body>
</html>