array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'yaf-request-abstract.setactionname.php', 1 => 'Yaf_Request_Abstract::setActionName', 2 => 'Set action name', ), 'up' => array ( 0 => 'class.yaf-request-abstract.php', 1 => 'Yaf_Request_Abstract', ), 'prev' => array ( 0 => 'yaf-request-abstract.isxmlhttprequest.php', 1 => 'Yaf_Request_Abstract::isXmlHttpRequest', ), 'next' => array ( 0 => 'yaf-request-abstract.setbaseuri.php', 1 => 'Yaf_Request_Abstract::setBaseUri', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/yaf/yaf_request_abstract/setactionname.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Yaf_Request_Abstract::setActionName

(Yaf >=1.0.0)

Yaf_Request_Abstract::setActionName — Set action name

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) {}
}
?>

See Also