Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 7164

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!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>Create a HaruOutline instance</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="harudoc.construct.html">HaruDoc::__construct</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="harudoc.getcurrentencoder.html">HaruDoc::getCurrentEncoder</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.createoutline" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">HaruDoc::createOutline</h1>
  <p class="verinfo">(PECL haru &gt;= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruDoc::createOutline</span> &mdash; <span class="dc-title">Create a <a href="class.haruoutline.html" class="classname">HaruOutline</a> instance</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-harudoc.createoutline-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">object</span> <span class="methodname"><strong>HaruDoc::createOutline</strong></span>
    ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$title</code></span>
   [, <span class="methodparam"><span class="type">object</span> <code class="parameter">$parent_outline</code></span>
   [, <span class="methodparam"><span class="type">object</span> <code class="parameter">$encoder</code></span>
  ]] )</div>

  <p class="para rdfs-comment">
   Create a <a href="class.haruoutline.html" class="classname">HaruOutline</a> instance.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-harudoc.createoutline-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

     <span class="term"><em><code class="parameter">title</code></em></span>
     <dd>

      <p class="para">
       The caption of new outline object.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">parent_outline</code></em></span>
     <dd>

      <p class="para">
       A valid <a href="class.haruoutline.html" class="classname">HaruOutline</a> instance or <strong><code>NULL</code></strong>.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">encoder</code></em></span>
     <dd>

      <p class="para">
       A valid <a href="class.haruencoder.html" class="classname">HaruEncoder</a> instance or <strong><code>NULL</code></strong>.
      </p>
     </dd>

    </dt>

   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-harudoc.createoutline-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns a new <a href="class.haruoutline.html" class="classname">HaruOutline</a> instance.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-harudoc.createoutline-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><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="harudoc.construct.html">HaruDoc::__construct</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="harudoc.getcurrentencoder.html">HaruDoc::getCurrentEncoder</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>