<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set content disposition</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="httpresponse.setcachecontrol.html">HttpResponse::setCacheControl</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httpresponse.setcontenttype.html">HttpResponse::setContentType</a></div>
<div class="up"><a href="class.httpresponse.html">HttpResponse</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="httpresponse.setcontentdisposition" class="refentry">
<div class="refnamediv">
<h1 class="refname">HttpResponse::setContentDisposition</h1>
<p class="verinfo">(PECL pecl_http >= 0.10.0)</p><p class="refpurpose"><span class="refname">HttpResponse::setContentDisposition</span> — <span class="dc-title">Set content disposition</span></p>
</div>
<div class="refsect1 description" id="refsect1-httpresponse.setcontentdisposition-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><strong>HttpResponse::setContentDisposition</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$inline</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Set the <em>Content-Disposition</em>.
The <em>Content-Disposition</em>
header is very useful if the data actually being sent came from a file or
something similar, that should be "saved" by the client/user (i.e. by
the browser's "Save as..." popup window).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-httpresponse.setcontentdisposition-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
the file name the "Save as..." dialog should display
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">inline</code></em></span>
<dd>
<p class="para">
if set to true and the user agent knows how to handle the content type,
it will probably not cause the popup window to be shown
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-httpresponse.setcontentdisposition-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-httpresponse.setcontentdisposition-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="httpresponse.getcontentdisposition.html" class="methodname" rel="rdfs-seeAlso">HttpResponse::getContentDisposition()</a> - Get content disposition</span></li>
<li class="member"> <span class="methodname"><a href="httpresponse.getcontenttype.html" class="methodname" rel="rdfs-seeAlso">HttpResponse::getContentType()</a> - Get content type</span></li>
<li class="member"> <span class="methodname"><a href="httpresponse.setcontenttype.html" class="methodname" rel="rdfs-seeAlso">HttpResponse::setContentType()</a> - Set content type</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="httpresponse.setcachecontrol.html">HttpResponse::setCacheControl</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httpresponse.setcontenttype.html">HttpResponse::setContentType</a></div>
<div class="up"><a href="class.httpresponse.html">HttpResponse</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
