php8.5
Home/ Manual/ yaf / yaf_request_abstract/ Yaf_Request_Abstract::setControllerName

Yaf_Request_Abstract::setControllerName

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Set controller name

Description

Yaf_Request_Abstract::setControllerName(string $controller, bool $format_name = true): Yaf_Request_Abstract|null

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

Yaf_Request_Abstract::setControllerName example

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

See Also

  • Yaf_Request_Abstract::setModuleName
  • Yaf_Request_Abstract::setActionName
  • Yaf_Request_Abstract::getControllerName

Source: reference/yaf/yaf_request_abstract/setcontrollername.xml · from the official PHP manual (php/doc-en)