CommandsBaseController Class Reference
[Controller]

Installs a generic post handler at url /process_commands. More...

Inheritance diagram for CommandsBaseController:

List of all members.

Public Member Functions
	action_commands_post ($page_data)
	Find according commands and redirect.
	get_routes ()
	Return array of IDispatchToken this controller takes responsability.

---

Detailed Description

Installs a generic post handler at url /process_commands.

The list form controller processes one command taken from the POST array. A command is recognized by starting with "cmd_" and usually is a submit button.

A command has a form of cmd_[type]_[action]_[params]. For example a command to disable a user can be named "cmd_user_disable_5", where 5 is the ID of the user. You need to install a handler on the user controller, to process this command, though.

Controllers can install themselves as handlers by registering sub-urls, like for example /process_commands/user. If a command is recognized, the second parameter is interpreted as type and everything is forwarded to an url like

 https://process_commands/[type]/[action]/[params]

If you are interested in handling a command, you must create a matching route. Given the above example of disableing a user, this would be:

 ... new CommandsRoute('https://process_commands/users/{id:ui>}/disable', $this, 'users_disable')

Attention:

Note the route is of type CommandsRoute, which extends ParameterizedRoute. This is extremly important, since it implements protection against Cross Site Request Forgery. You may alternatively add a CommandsRouteRenderDecorator to a custom route to achieve the same effect.

Author:

Gerd Riesselmann

Definition at line 37 of file commands.basecontroller.php.

---

Member Function Documentation

CommandsBaseController::action_commands_post

(

$

page_data

)

Find according commands and redirect.

Definition at line 50 of file commands.basecontroller.php.

                                                         {
                $page_data->in_history = false;
                $err = new Status();
                
                if ($page_data->has_post_data() == true) {
                        $err = $this->redirect_to_handler($page_data);
                }
                else {
                        $err->append(tr('No command data was send', 'core'));
                }
                
                History::go_to(0, $err);
                exit;
        }

CommandsBaseController::get_routes

(

)

Return array of IDispatchToken this controller takes responsability.

Reimplemented from ControllerBase.

Definition at line 41 of file commands.basecontroller.php.

                                     {
                return array(
                        new ExactMatchRoute('https://post_command', $this, 'commands_post', new NoCacheCacheManager()),
                );
        }

---

The documentation for this class was generated from the following file:

• gyro/core/controller/base/commands.basecontroller.php