<!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 owner and user passwords for the document</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="harudoc.setpagesconfiguration.html">HaruDoc::setPagesConfiguration</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harudoc.setpermission.html">HaruDoc::setPermission</a></div>
<div class="up"><a href="class.harudoc.html">HaruDoc</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="harudoc.setpassword" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruDoc::setPassword</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruDoc::setPassword</span> — <span class="dc-title">Set owner and user passwords for the document</span></p>
</div>
<div class="refsect1 description" id="refsect1-harudoc.setpassword-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>HaruDoc::setPassword</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$owner_password</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$user_password</code></span>
)</div>
<p class="para rdfs-comment">
Defines owner and user passwords for the document.
Setting the passwords makes the document contents encrypted.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-harudoc.setpassword-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">owner_password</code></em></span>
<dd>
<p class="para">
The password of the owner, which can change permissions of the
document. Empty password is not accepted. Owner's password cannot be
the same as the user's password.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">user_password</code></em></span>
<dd>
<p class="para">
The password of the user. Can be empty.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-harudoc.setpassword-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-harudoc.setpassword-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.html" class="classname">HaruException</a> on error.</p>
</div>
<div class="refsect1 seealso" id="refsect1-harudoc.setpassword-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="harudoc.setencryptionmode.html" class="methodname" rel="rdfs-seeAlso">HaruDoc::setEncryptionMode()</a> - Set encryption mode for the document</span></li>
<li class="member"> <span class="methodname"><a href="harudoc.setpermission.html" class="methodname" rel="rdfs-seeAlso">HaruDoc::setPermission()</a> - Set permissions for the document</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="harudoc.setpagesconfiguration.html">HaruDoc::setPagesConfiguration</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harudoc.setpermission.html">HaruDoc::setPermission</a></div>
<div class="up"><a href="class.harudoc.html">HaruDoc</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
