Yaf_Request_Abstract::setModuleName

(Yaf >=1.0.0)

Yaf_Request_Abstract::setModuleName — Set module name

Description

public function Yaf_Request_Abstract::setModuleName(string $module, bool $format_name = true): ?Yaf_Request_Abstract

set module name to request, this is usually used by custom router to set route result module name.

Parameters

module

string module name, it should be in camel style, like "Index" or "Foo_Bar"

format_name

this is introduced in Yaf 3.2.0, by default Yaf will format the name into camel mode, if this is set to false , Yaf will set the original name to request.

Return Values

Returns the request object itself on success, or null on failure.

Examples

Example #1 Yaf_Request_Abstract::setModuleName() example

<?php
class AdminRouter extends Yaf_Route_Interface
{
    public function route(Yaf_Request_Abstract $request)
    {
        // Serve everything under /admin from the Admin module
        if (0 === strpos($request->getRequestUri(), "/admin")) {
            $request->setModuleName("Admin")
                    ->setControllerName("Dashboard")
                    ->setActionName("index");
            return true;
        }

        return false;
    }

    public function assemble(array $info, array $query = null) {}
}
?>

See Also

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug
＋add a note

User Contributed Notes

There are no user contributed notes for this page.