mosController Class Reference

List of all members.

Public Member Functions
	__construct (mosRequest &$request, mosRenderer &$renderer, $commandname='command')
	run ()
	forward ($command)
	setCommand ($command)
	setView ($viewname)
	redirect ($url)
Private Attributes
	$commandname
	$command
	$view
	$request
	$renderer

---

Detailed Description

A controller class modelled on the front controller and application controller design patterns. The Command and View classess are an integral part of this pattern.

Definition at line 9 of file mosRenderer.php.

---

Constructor & Destructor Documentation

mosController::__construct	(	mosRequest &$	request,
		mosRenderer &$	renderer,
		$	commandname = 'command'
	)

Constructor.

Parameters:

	object	$request - A reference to a request object
	object	$renderer - A reference to a renderer object
	string	$commandname - the name of the $_REQUEST variable containing the command name

Returns:

Controller

Definition at line 50 of file mosRenderer.php.

References $commandname.

    {
        $this->request     =& $request;
        $this->renderer    =& $renderer;
        $this->commandname =  $commandname;
    }

---

Member Function Documentation

mosController::run

(

)

Forwards the request to the correct command from the request or the default command, Then forwards to a view.

Definition at line 62 of file mosRenderer.php.

References $_REQUEST, $command, forward(), and setView().

    {
        $command = $this->request->getParam($_REQUEST, $this->commandname, 'default');
        $this->forward($command);
        // get the view from the command
        $this->setView($this->command->getView());
        $this->view->render($this->request, $this->renderer);
    }

mosController::forward

(

$

command

)

sets the current command object and calls its execute method

Parameters:

unknown_type

$command

Definition at line 76 of file mosRenderer.php.

References $command, and setCommand().

Referenced by run().

    {
        $this->setCommand($command);
        $this->command->execute($this, $this->request);
    }

mosController::setCommand

(

$

command

)

Instantiates the command class and sets the current command property. The command classes must extend the Command class and must follow a naming convention. eg. the 'addUser' command class must be named 'addUserCommand'

Parameters:

string

$command

Returns:

bool - triggers an error if the command class isn't found.

Definition at line 90 of file mosRenderer.php.

References $command.

Referenced by forward().

    {
        $commandclass = $command.'Command';
        // instantiate the command class
        if (class_exists($commandclass)) {
            $this->command = new $commandclass();
        } else {
            return trigger_error("Command class '$commandclass' not found.", E_USER_ERROR);
        }
    }

mosController::setView

(

$

viewname

)

Instantiates the view class and sets the current view property The view classes must extend the View class and must follow a naming convention. The view is also associated to the command that sets it. eg. the form view for the 'addUser' command class must be named 'form_addUserView'

Parameters:

string

$viewname - the view name st by the command

Returns:

bool - triggers an error if the view class isn't found.

Definition at line 109 of file mosRenderer.php.

References $commandname.

Referenced by run().

    {
        $commandname = substr(get_class($this->command), 0, -7);
        $viewclass = $viewname.'View';
        if (class_exists($viewclass)) {
            $this->view = new $viewclass();
        } else {
            return trigger_error("View class '$viewclass' not found.", E_USER_ERROR);
        }
    }

mosController::redirect

(

$

url

)

Helper function to redirect the user request. useful for cases where we don't want the user to resend a form

Parameters:

unknown_type

$url

Definition at line 125 of file mosRenderer.php.

    {
        if (headers_sent()) {
            echo "<script>document.location.href='$url';</script>";
        } else {
            if (ob_get_contents()) while (@ob_end_clean()); // clear output buffer if one exists
            header( "Location: $url" );
        }
        exit;
    }

---

Member Data Documentation

mosController::$commandname [private]

Definition at line 16 of file mosRenderer.php.

Referenced by __construct(), and setView().

mosController::$command [private]

Definition at line 22 of file mosRenderer.php.

Referenced by forward(), run(), and setCommand().

mosController::$view [private]

Definition at line 28 of file mosRenderer.php.

mosController::$request [private]

Definition at line 34 of file mosRenderer.php.

mosController::$renderer [private]

Definition at line 40 of file mosRenderer.php.

---

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

• mosRenderer.php