<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.yaf.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'class.yaf-dispatcher.php',
    1 => 'Yaf_Dispatcher',
    2 => 'A classe Yaf_Dispatcher',
  ),
  'up' => 
  array (
    0 => 'book.yaf.php',
    1 => 'Yaf',
  ),
  'prev' => 
  array (
    0 => 'class.yaf-bootstrap-abstract.php',
    1 => 'Yaf_Bootstrap_Abstract',
  ),
  'next' => 
  array (
    0 => 'yaf-dispatcher.autorender.php',
    1 => 'Yaf_Dispatcher::autoRender',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/yaf/yaf-dispatcher.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.yaf-dispatcher.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.yaf-dispatcher" class="reference">

 <h1 class="title">A classe Yaf_Dispatcher</h1>
 

 <div class="partintro"><p class="verinfo">(Yaf &gt;=1.0.0)</p>


  <div class="section" id="yaf-dispatcher.intro">
   <h2 class="title">Introdução</h2>
   <p class="para">
    O objetivo de <span class="classname"><strong class="classname">Yaf_Dispatcher</strong></span> é inicializar
    o ambiente de requisição, rotear a requisição recebida e então despachar
    quaisquer ações descobertas; ele agrega todas as respostas e as retorna
    quando o processo é concluído.
   </p>
   <p class="para">
    <span class="classname"><strong class="classname">Yaf_Dispatcher</strong></span> também implementa o padrão Singleton,
    o que significa que apenas uma única instância dele pode estar disponível a qualquer momento. Isso
    permite que ele também atue como um registro no qual os outros objetos no
    processo de despacho podem recorrer.
   </p>
  </div>


  <div class="section" id="yaf-dispatcher.synopsis">
   <h2 class="title">Resumo da classe</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">final</span>
      <span class="modifier">class</span> <strong class="classname">Yaf_Dispatcher</strong>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Propriedades */</div>
    <div class="fieldsynopsis">
     <span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.router">$<var class="varname">_router</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.view">$<var class="varname">_view</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.request">$<var class="varname">_request</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.plugins">$<var class="varname">_plugins</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
     <span class="modifier">static</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.instance">$<var class="varname">_instance</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.auto-render">$<var class="varname">_auto_render</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.return-response">$<var class="varname">_return_response</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.instantly-flush">$<var class="varname">_instantly_flush</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.default-module">$<var class="varname">_default_module</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.default-controller">$<var class="varname">_default_controller</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-dispatcher.php#yaf-dispatcher.props.default-action">$<var class="varname">_default_action</var></a></var>;</div>



    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Métodos */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.construct.php" class="methodname">__construct</a></span>()</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.autorender.php" class="methodname">autoRender</a></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$flag</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.catchexception.php" class="methodname">catchException</a></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$flag</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.disableview.php" class="methodname">disableView</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.dispatch.php" class="methodname">dispatch</a></span>(<span class="methodparam"><span class="type"><a href="class.yaf-request-abstract.php" class="type Yaf_Request_Abstract">Yaf_Request_Abstract</a></span> <code class="parameter">$request</code></span>): <span class="type"><a href="class.yaf-response-abstract.php" class="type Yaf_Response_Abstract">Yaf_Response_Abstract</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.enableview.php" class="methodname">enableView</a></span>(): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.flushinstantly.php" class="methodname">flushInstantly</a></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$flag</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.getapplication.php" class="methodname">getApplication</a></span>(): <span class="type"><a href="class.yaf-application.php" class="type Yaf_Application">Yaf_Application</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.getdefaultaction.php" class="methodname">getDefaultAction</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.getdefaultcontroller.php" class="methodname">getDefaultController</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.getdefaultmodule.php" class="methodname">getDefaultModule</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="yaf-dispatcher.getinstance.php" class="methodname">getInstance</a></span>(): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.getrequest.php" class="methodname">getRequest</a></span>(): <span class="type"><a href="class.yaf-request-abstract.php" class="type Yaf_Request_Abstract">Yaf_Request_Abstract</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.getrouter.php" class="methodname">getRouter</a></span>(): <span class="type"><a href="class.yaf-router.php" class="type Yaf_Router">Yaf_Router</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.initview.php" class="methodname">initView</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$templates_dir</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="class.yaf-view-interface.php" class="type Yaf_View_Interface">Yaf_View_Interface</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.registerplugin.php" class="methodname">registerPlugin</a></span>(<span class="methodparam"><span class="type"><a href="class.yaf-plugin-abstract.php" class="type Yaf_Plugin_Abstract">Yaf_Plugin_Abstract</a></span> <code class="parameter">$plugin</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.returnresponse.php" class="methodname">returnResponse</a></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$flag</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.setdefaultaction.php" class="methodname">setDefaultAction</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$action</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.setdefaultcontroller.php" class="methodname">setDefaultController</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$controller</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.setdefaultmodule.php" class="methodname">setDefaultModule</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$module</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.seterrorhandler.php" class="methodname">setErrorHandler</a></span>(<span class="methodparam"><span class="type">call</span> <code class="parameter">$callback</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$error_types</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.setrequest.php" class="methodname">setRequest</a></span>(<span class="methodparam"><span class="type"><a href="class.yaf-request-abstract.php" class="type Yaf_Request_Abstract">Yaf_Request_Abstract</a></span> <code class="parameter">$request</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.setview.php" class="methodname">setView</a></span>(<span class="methodparam"><span class="type"><a href="class.yaf-view-interface.php" class="type Yaf_View_Interface">Yaf_View_Interface</a></span> <code class="parameter">$view</code></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-dispatcher.throwexception.php" class="methodname">throwException</a></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$flag</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="class.yaf-dispatcher.php" class="type Yaf_Dispatcher">Yaf_Dispatcher</a></span></div>

   }</div>


  </div>



  <div class="section" id="yaf-dispatcher.props">
   <h2 class="title">Propriedades</h2>
   <dl>
    
     <dt id="yaf-dispatcher.props.router"><var class="varname">_router</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.view"><var class="varname">_view</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.request"><var class="varname">_request</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.plugins"><var class="varname">_plugins</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.instance"><var class="varname">_instance</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.auto-render"><var class="varname">_auto_render</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.return-response"><var class="varname">_return_response</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.instantly-flush"><var class="varname">_instantly_flush</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.default-module"><var class="varname">_default_module</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.default-controller"><var class="varname">_default_controller</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-dispatcher.props.default-action"><var class="varname">_default_action</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
   </dl>
  </div>



 </div>

 








































































































































































<h2>Índice</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-dispatcher.autorender.php">Yaf_Dispatcher::autoRender</a> — Ativa/desativa a renderiza&ccedil;&atilde;o autom&aacute;tica</li><li><a href="yaf-dispatcher.catchexception.php">Yaf_Dispatcher::catchException</a> — Ativa/desativa a captura de exce&ccedil;&otilde;es</li><li><a href="yaf-dispatcher.construct.php">Yaf_Dispatcher::__construct</a> — Construtor de Yaf_Dispatcher</li><li><a href="yaf-dispatcher.disableview.php">Yaf_Dispatcher::disableView</a> — Desativa a renderiza&ccedil;&atilde;o de visualiza&ccedil;&atilde;o</li><li><a href="yaf-dispatcher.dispatch.php">Yaf_Dispatcher::dispatch</a> — Despacha uma requisi&ccedil;&atilde;o</li><li><a href="yaf-dispatcher.enableview.php">Yaf_Dispatcher::enableView</a> — Ativa a renderiza&ccedil;&atilde;o de visualiza&ccedil;&atilde;o</li><li><a href="yaf-dispatcher.flushinstantly.php">Yaf_Dispatcher::flushInstantly</a> — Liga/desliga o descarregamento instant&acirc;nea</li><li><a href="yaf-dispatcher.getapplication.php">Yaf_Dispatcher::getApplication</a> — Obt&eacute;m a aplica&ccedil;&atilde;o</li><li><a href="yaf-dispatcher.getdefaultaction.php">Yaf_Dispatcher::getDefaultAction</a> — Obt&eacute;m o nome da a&ccedil;&atilde;o padr&atilde;o</li><li><a href="yaf-dispatcher.getdefaultcontroller.php">Yaf_Dispatcher::getDefaultController</a> — Obt&eacute;m o nome do controlador padr&atilde;o</li><li><a href="yaf-dispatcher.getdefaultmodule.php">Yaf_Dispatcher::getDefaultModule</a> — Obt&eacute;m o nome do m&oacute;dulo padr&atilde;o</li><li><a href="yaf-dispatcher.getinstance.php">Yaf_Dispatcher::getInstance</a> — Obt&eacute;m a inst&acirc;ncia do despachante</li><li><a href="yaf-dispatcher.getrequest.php">Yaf_Dispatcher::getRequest</a> — Obt&eacute;m a inst&acirc;ncia da requisi&ccedil;&atilde;o</li><li><a href="yaf-dispatcher.getrouter.php">Yaf_Dispatcher::getRouter</a> — Obt&eacute;m a inst&acirc;ncia do roteador</li><li><a href="yaf-dispatcher.initview.php">Yaf_Dispatcher::initView</a> — Inicializa a visualiza&ccedil;&atilde;o e a retorna</li><li><a href="yaf-dispatcher.registerplugin.php">Yaf_Dispatcher::registerPlugin</a> — Registra um plugin</li><li><a href="yaf-dispatcher.returnresponse.php">Yaf_Dispatcher::returnResponse</a> — returnResponse</li><li><a href="yaf-dispatcher.setdefaultaction.php">Yaf_Dispatcher::setDefaultAction</a> — Altera o nome da a&ccedil;&atilde;o padr&atilde;o</li><li><a href="yaf-dispatcher.setdefaultcontroller.php">Yaf_Dispatcher::setDefaultController</a> — Altera o nome do controlador padr&atilde;o</li><li><a href="yaf-dispatcher.setdefaultmodule.php">Yaf_Dispatcher::setDefaultModule</a> — Altera o nome do m&oacute;dulo padr&atilde;o</li><li><a href="yaf-dispatcher.seterrorhandler.php">Yaf_Dispatcher::setErrorHandler</a> — Define o manipulador de erros</li><li><a href="yaf-dispatcher.setrequest.php">Yaf_Dispatcher::setRequest</a> — setRequest</li><li><a href="yaf-dispatcher.setview.php">Yaf_Dispatcher::setView</a> — Define um mecanismo de visualiza&ccedil;&atilde;o customizado</li><li><a href="yaf-dispatcher.throwexception.php">Yaf_Dispatcher::throwException</a> — Ativa/desativa o lan&ccedil;amento de exce&ccedil;&atilde;o</li></ul>
</div>
<?php manual_footer($setup); ?>