<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-application.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'yaf-application.setappdirectory.php',
    1 => 'Yaf_Application::setAppDirectory',
    2 => 'Change the application directory',
  ),
  'up' => 
  array (
    0 => 'class.yaf-application.php',
    1 => 'Yaf_Application',
  ),
  'prev' => 
  array (
    0 => 'yaf-application.run.php',
    1 => 'Yaf_Application::run',
  ),
  'next' => 
  array (
    0 => 'class.yaf-bootstrap-abstract.php',
    1 => 'Yaf_Bootstrap_Abstract',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/yaf/yaf_application/setappdirectory.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-application.setappdirectory" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yaf_Application::setAppDirectory</h1>
  <p class="verinfo">(Yaf &gt;=2.1.4)</p><p class="refpurpose"><span class="refname">Yaf_Application::setAppDirectory</span> &mdash; <span class="dc-title">Change the application directory</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-application.setappdirectory-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaf_Application::setAppDirectory</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$directory</code></span>): <span class="type"><span class="type"><a href="class.yaf-application.php" class="type Yaf_Application">Yaf_Application</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Change the application directory, under which Yaf looks for
   controllers, views and modules. The new directory must be an absolute
   path.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-application.setappdirectory-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">directory</code></dt>
    <dd>
     <p class="simpara">
      The absolute path of the new application directory.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yaf-application.setappdirectory-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns the <span class="classname"><a href="class.yaf-application.php" class="classname">Yaf_Application</a></span> object itself on
   success, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> if <code class="parameter">directory</code> is empty or not an
   absolute path, or <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> if the application is not properly
   initialized.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-application.setappdirectory-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="methodname"><strong>Yaf_Application::setAppDirectory()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$app </span><span style="color: #007700">= </span><span style="color: #0000BB">Yaf_Application</span><span style="color: #007700">::</span><span style="color: #0000BB">app</span><span style="color: #007700">();

</span><span style="color: #FF8000">/* returns the application itself on success, for chaining */
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$app</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setAppDirectory</span><span style="color: #007700">(</span><span style="color: #DD0000">"/srv/legacy/mvc/app"</span><span style="color: #007700">));
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$app</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getAppDirectory</span><span style="color: #007700">());

</span><span style="color: #FF8000">/* an empty or relative path is rejected */
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$app</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setAppDirectory</span><span style="color: #007700">(</span><span style="color: #DD0000">""</span><span style="color: #007700">));
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$app</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setAppDirectory</span><span style="color: #007700">(</span><span style="color: #DD0000">"relative/path"</span><span style="color: #007700">));
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">object(Yaf_Application)#1 (0) {
}
string(20) &quot;/srv/legacy/mvc/app&quot;
bool(false)
bool(false)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-application.setappdirectory-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="yaf-application.getappdirectory.php" class="methodname" rel="rdfs-seeAlso">Yaf_Application::getAppDirectory()</a> - Get the application directory</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>