Yaf_Controller_Abstract::getInvokeArg

(Yaf >=1.0.0)

Yaf_Controller_Abstract::getInvokeArg — Retrieve one action invocation argument

Description

public function Yaf_Controller_Abstract::getInvokeArg(string $name): ?string

Returns a single invocation argument of the current action, given its name. Invocation arguments are passed to the action through Yaf_Controller_Abstract::forward().

Parameters

name

The name of the invocation argument to retrieve.

Return Values

The argument value, or null if it does not exist.

Examples

Example #1 Yaf_Controller_Abstract::getInvokeArg() example

<?php
class UserController extends Yaf_Controller_Abstract
{
    public function indexAction() {
        // forward to the profile action of this controller,
        // carrying invocation arguments
        $this->forward("profile", array("name" => "laruence"));
        return false; // ends the current flow
    }

    public function profileAction() {
        // retrieve one invocation argument by name
        var_dump($this->getInvokeArg("name"));
        var_dump($this->getInvokeArg("missing"));
    }
}
?>

The above example will output something similar to:

string(8) "laruence"
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.