PHP Manual: Yaf_Request_Abstract::setActionName

Description

public function Yaf_Request_Abstract::setActionName(string $action, bool $format_name = true): ?Yaf_Request_Abstract

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

Parameters

action: string, action name, it should in lower case style, like "index" or "foo_bar"
format_name: this is introduced in Yaf 3.2.0, by default Yaf will format the name into lower case style, 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::setActionName() example

<?php
class RestRouter extends Yaf_Route_Interface
{
    public function route(Yaf_Request_Abstract $request)
    {
        // Route any /api request to ApiController::ordersAction
        if (0 === strpos($request->getRequestUri(), "/api")) {
            $request->setControllerName("Api")
                    ->setActionName("orders");
            return true;
        }

        return false;
    }

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

Yaf_Request_Abstract::setActionName

Description

Parameters

Return Values

Examples

See Also