request/quipcontrollerrequest.class.php

Includes Classes 
package
quip
Classes
QuipControllerRequest

Description

Quip

Copyright 2010-11 by Shaun McCormick shaun@modx.com

This file is part of Quip, a simple commenting component for MODx Revolution.

Quip is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Quip is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Quip; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

\QuipControllerRequest

Extends from
\modRequest
extends
modRequest
package
quip
subpackage
request
Properties
$action
$actionVar
$defaultAction
$quip
Methods
__construct
_respond
handleRequest

Description

Encapsulates the interaction of MODx manager with an HTTP request.

Properties

$action

string $action = ''

The currently loaded action

Details

string
visibility
public
default
final
false
static
false

$actionVar

string $actionVar = 'action'

The action key to use

Details

string
visibility
public
default
action
final
false
static
false

$defaultAction

string $defaultAction = 'home'

The default controller to load if none is specified

Details

string
visibility
public
default
home
final
false
static
false

$quip

\Quip $quip = 'null'

A reference to the Quip instance

Details

\Quip
visibility
public
default
null
final
false
static
false

Methods

__construct

__construct( \Quip $quip ) :

Arguments
$quip
\Quip
A reference to the Quip instance
Details
visibility
public
final
false
static
false

_respond

_respond( ) : boolean

Prepares the MODx response to a mgr request that is being handled.

Output
boolean
True if the response is properly prepared.
Details
visibility
private
final
false
static
false
access
public

handleRequest

handleRequest( ) : string

Extends modRequest::handleRequest and loads the proper error handler and actionVar value.

Output
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox 0.11.2.