atelierspierrot/library

View on GitHub
phpdoc/Library/HttpFundamental/Response.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8" />
    <meta name="robots" content="index, follow, all" />
    <title>Library\HttpFundamental\Response | 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_HttpFundamental_Response" 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/HttpFundamental.html">HttpFundamental</a></li>
    
                <li>Response</li>
            </ol>
        </div>
                <div id="page-content">
                
    <div class="page-header">
        <h1>Response</h1>
    </div>

    <p>    class
    <strong>Response</strong>        implements
        <abbr title="Patterns\Interfaces\ResponseInterface">ResponseInterface</abbr>
</p>

            <div class="description">
            <p>The global HTTP response class</p>                    </div>
    
    
    
            <h2>Properties</h2>

            <table class="table table-condensed">
                    <tr>
                <td class="type" id="property_content_types">
                    static                                                            
    array
                </td>
                <td>$content_types</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">
                    
    
                </div>
                <div class="col-md-8 type">
                    <a href="#method___construct">__construct</a>(
    string|null $content = null, 
    string|null $charset = null)
                                            <p>Constructor : defines the current URL and gets the routes</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    string
                </div>
                <div class="col-md-8 type">
                    <a href="#method___toString">__toString</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_setProtocol">setProtocol</a>($value)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    string
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getProtocol">getProtocol</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_setStatus">setStatus</a>($flag)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    mixed
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getStatus">getStatus</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_setCharset">setCharset</a>($string)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    string
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getCharset">getCharset</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_addContent">addContent</a>(
    string $name, 
    mixed $content)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_setContents">setContents</a>(
    array $contents)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    null
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getContent">getContent</a>($name, 
    null $default = null)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    array
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getContents">getContents</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    string
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getContentsAsString">getContentsAsString</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_setContentType">setContentType</a>(
    string $type)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    object
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getContentType">getContentType</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_guessContentType">guessContentType</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_setHeaders">setHeaders</a>(
    array $params)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_addHeader">addHeader</a>(
    string $name, 
    string $value = null)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    array
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getHeaders">getHeaders</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    string|null
                </div>
                <div class="col-md-8 type">
                    <a href="#method_getHeader">getHeader</a>(
    string $name)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    bool
                </div>
                <div class="col-md-8 type">
                    <a href="#method_hasHeader">hasHeader</a>(
    string $name)
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    void
                </div>
                <div class="col-md-8 type">
                    <a href="#method_renderHeaders">renderHeaders</a>()
                                            <p class="no-description">No description</p>
                                    </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    
                </div>
                <div class="col-md-8 type">
                    <a href="#method_header">header</a>(
    string $str)
                                            <p>Writes a header string if headers had not been sent</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    
    mixed
                </div>
                <div class="col-md-8 type">
                    <a href="#method_send">send</a>(
    null $content = null, 
    null $type = null, 
    bool $return_string = false)
                                            <p>Send the response to the device</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_download">download</a>(
    null $file = null, 
    null $type = null, 
    null $file_name = null)
                                            <p>Force client to download a file</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_flush">flush</a>(
    null $file_content = null, 
    null $type = null)
                                            <p>Flush (display) a file content</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_redirect">redirect</a>(
    string $url, 
    bool $permanent = false)
                                            <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___construct">
        <div class="location">at line 86</div>
        <code>                    
    
    <strong>__construct</strong>(
    string|null $content = null, 
    string|null $charset = null)</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Constructor : defines the current URL and gets the routes</p>                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string|null</td>
                <td>$content</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    string|null</td>
                <td>$charset</td>
                <td>
</td>
            </tr>
            </table>

            
            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method___toString">
        <div class="location">at line 101</div>
        <code>                    
    string
    <strong>__toString</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    string</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_setProtocol">
        <div class="location">at line 114</div>
        <code>                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
    <strong>setProtocol</strong>($value)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td></td>
                <td>$value</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <abbr title="Library\HttpFundamental\$this">$this</abbr></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getProtocol">
        <div class="location">at line 123</div>
        <code>                    
    string
    <strong>getProtocol</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    string</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_setStatus">
        <div class="location">at line 132</div>
        <code>                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
    <strong>setStatus</strong>($flag)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td></td>
                <td>$flag</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <abbr title="Library\HttpFundamental\$this">$this</abbr></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getStatus">
        <div class="location">at line 141</div>
        <code>                    
    mixed
    <strong>getStatus</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <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_setCharset">
        <div class="location">at line 150</div>
        <code>                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
    <strong>setCharset</strong>($string)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td></td>
                <td>$string</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <abbr title="Library\HttpFundamental\$this">$this</abbr></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getCharset">
        <div class="location">at line 159</div>
        <code>                    
    string
    <strong>getCharset</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    string</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_addContent">
        <div class="location">at line 169</div>
        <code>                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
    <strong>addContent</strong>(
    string $name, 
    mixed $content)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string</td>
                <td>$name</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    mixed</td>
                <td>$content</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <abbr title="Library\HttpFundamental\$this">$this</abbr></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_setContents">
        <div class="location">at line 183</div>
        <code>                    
    <abbr title="Library\HttpFundamental\$this">$this</abbr>
    <strong>setContents</strong>(
    array $contents)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    array</td>
                <td>$contents</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <abbr title="Library\HttpFundamental\$this">$this</abbr></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getContent">
        <div class="location">at line 194</div>
        <code>                    
    null
    <strong>getContent</strong>($name, 
    null $default = null)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td></td>
                <td>$name</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    null</td>
                <td>$default</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    null</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getContents">
        <div class="location">at line 202</div>
        <code>                    
    array
    <strong>getContents</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    array</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getContentsAsString">
        <div class="location">at line 210</div>
        <code>                    
    string
    <strong>getContentsAsString</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    string</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_setContentType">
        <div class="location">at line 223</div>
        <code>                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
    <strong>setContentType</strong>(
    string $type)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string</td>
                <td>$type</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getContentType">
        <div class="location">at line 232</div>
        <code>                    
    object
    <strong>getContentType</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    object</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_guessContentType">
        <div class="location">at line 240</div>
        <code>                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
    <strong>guessContentType</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_setHeaders">
        <div class="location">at line 254</div>
        <code>                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
    <strong>setHeaders</strong>(
    array $params)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    array</td>
                <td>$params</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_addHeader">
        <div class="location">at line 265</div>
        <code>                    
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a>
    <strong>addHeader</strong>(
    string $name, 
    string $value = null)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string</td>
                <td>$name</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    string</td>
                <td>$value</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <a href="../../Library/HttpFundamental/Response.html"><abbr title="Library\HttpFundamental\Response">Response</abbr></a></td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getHeaders">
        <div class="location">at line 274</div>
        <code>                    
    array
    <strong>getHeaders</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    array</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_getHeader">
        <div class="location">at line 283</div>
        <code>                    
    string|null
    <strong>getHeader</strong>(
    string $name)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string</td>
                <td>$name</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    string|null</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_hasHeader">
        <div class="location">at line 294</div>
        <code>                    
    bool
    <strong>hasHeader</strong>(
    string $name)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string</td>
                <td>$name</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    bool</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_renderHeaders">
        <div class="location">at line 306</div>
        <code>                    
    void
    <strong>renderHeaders</strong>()</code>
    </h3>
    <div class="details">
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    void</td>
            <td>
</td>
        </tr>
    </table>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_header">
        <div class="location">at line 319</div>
        <code>        static            
    
    <strong>header</strong>(
    string $str)</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Writes a header string if headers had not been sent</p>                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string</td>
                <td>$str</td>
                <td>The header string</td>
            </tr>
            </table>

            
            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_send">
        <div class="location">at line 334</div>
        <code>                    
    mixed
    <strong>send</strong>(
    null $content = null, 
    null $type = null, 
    bool $return_string = false)</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Send the response to the device</p>                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    null</td>
                <td>$content</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    null</td>
                <td>$type</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    bool</td>
                <td>$return_string</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_download">
        <div class="location">at line 360</div>
        <code>                    
    
    <strong>download</strong>(
    null $file = null, 
    null $type = null, 
    null $file_name = null)</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Force client to download a file</p>                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    null</td>
                <td>$file</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    null</td>
                <td>$type</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    null</td>
                <td>$file_name</td>
                <td>
</td>
            </tr>
            </table>

            
            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_flush">
        <div class="location">at line 387</div>
        <code>                    
    
    <strong>flush</strong>(
    null $file_content = null, 
    null $type = null)</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Flush (display) a file content</p>                                </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    null</td>
                <td>$file_content</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    null</td>
                <td>$type</td>
                <td>
</td>
            </tr>
            </table>

            
            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_redirect">
        <div class="location">at line 406</div>
        <code>                    
    
    <strong>redirect</strong>(
    string $url, 
    bool $permanent = false)</code>
    </h3>
    <div class="details">
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    string</td>
                <td>$url</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    bool</td>
                <td>$permanent</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>