array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'yaf-dispatcher.setdefaultmodule.php', 1 => 'Yaf_Dispatcher::setDefaultModule', 2 => 'Change default module name', ), 'up' => array ( 0 => 'class.yaf-dispatcher.php', 1 => 'Yaf_Dispatcher', ), 'prev' => array ( 0 => 'yaf-dispatcher.setdefaultcontroller.php', 1 => 'Yaf_Dispatcher::setDefaultController', ), 'next' => array ( 0 => 'yaf-dispatcher.seterrorhandler.php', 1 => 'Yaf_Dispatcher::setErrorHandler', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/yaf/yaf_dispatcher/setdefaultmodule.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Yaf_Dispatcher::setDefaultModule

(Yaf >=1.0.0)

Yaf_Dispatcher::setDefaultModule — Change default module name

Description

public function Yaf_Dispatcher::setDefaultModule(string $module): Yaf_Dispatcher|null|false

Change the module name which is used when a module name can not be extracted from the request URI. The module must be a registered one, see Yaf_Application::getModules().

Parameters

module

The name of a registered module.

Return Values

Returns the Yaf_Dispatcher object itself on success, false if the given module is not registered (and a YAF_ERR_TYPE_ERROR is triggered) or if the application is not initialized, or null otherwise.

Errors/Exceptions

Triggers a YAF_ERR_TYPE_ERROR error if module is not a registered module name.

Examples

Example #1 Yaf_Dispatcher::setDefaultModule() example

<?php
$app = new Yaf_Application(dirname(__FILE__) . "/conf/application.ini");

// "Home" must be a registered module, e.g. via
// application.modules = "Index,Home,Admin" in conf/application.ini
Yaf_Dispatcher::getInstance()->setDefaultModule("Home");

$app->run();
?>

See Also