Yaf_Request_Abstract::setControllerName

(Yaf >=1.0.0)

Yaf_Request_Abstract::setControllerName — Set controller name

Description

public function Yaf_Request_Abstract::setControllerName(string $controller, bool $format_name = true): ?Yaf_Request_Abstract

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

Parameters

controller: string, controller name, this 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::setControllerName() example

<?php
class RestRouter extends Yaf_Route_Interface
{
    public function route(Yaf_Request_Abstract $request)
    {
        if (0 === strpos($request->getRequestUri(), "/api")) {
            // Names are formatted to camel style by default,
            // so "order_item" becomes "Order_Item"
            $request->setControllerName("order_item")
                    ->setActionName("list");
            return true;
        }

        return false;
    }

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

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.