code/libraries/koowa/controller/page.php

Classes

category: Koowa
copyright: Copyright (C) 2007 - 2010 Johan Janssens. All rights reserved.
license: GNU GPLv3 <http://www.gnu.org/licenses/gpl.html>
link: http://www.nooku.org
package: Koowa_Controller
version: $Id: page.php 3263 2011-05-08 22:33:06Z johanjanssens $
Classes: KControllerPage

Description

KControllerPage
jump to top

Extends from: KControllerAbstract
author: Johan Janssens <[email protected]>
category: Koowa
package: Koowa_Controller
uses: KInflector
Properties: $_redirect; $_redirect_message; $_redirect_type; $_view; $_model
Methods: __construct; _initialize; getView; setView; getModel; setModel; setRedirect; getRedirect; _actionGet; __set; __call

Description

Abstract View Controller Class

Properties

$_model
jump to class

string|object $_model = ''

Model object or identifier (APP::com.COMPONENT.model.NAME)

Details

$_model: string|object
visibility: protected
default
final: false
static: false

$_redirect
jump to class

string $_redirect = 'null'

URL for redirection.

Details

$_redirect: string
visibility: protected
default: null
final: false
static: false

$_redirect_message
jump to class

string $_redirect_message = 'null'

Redirect message.

Details

$_redirect_message: string
visibility: protected
default: null
final: false
static: false

$_redirect_type
jump to class

string $_redirect_type = 'message'

Redirect message type.

Details

$_redirect_type: string
visibility: protected
default: message
final: false
static: false

$_view
jump to class

string|object $_view = ''

View object or identifier (APP::com.COMPONENT.view.NAME.FORMAT)

Details

$_view: string|object
visibility: protected
default
final: false
static: false

Methods

__call
jump to class

__call(
          string $method, array $args
          )
        
        :
        KControllerBread

Supports a simple form Fluent Interfaces. Allows you to set the request properties by using the request property name as the method name.

For example : $controller->view('name')->limit(10)->browse();

Arguments

$method: string
Method name
$args: array
Array containing all the arguments for the original call

Output

KControllerBread

Details

visibility: public
final: false
static: false
see: http://martinfowler.com/bliki/FluentInterface.html

__construct
jump to class

__construct(
          object $config
          )
        
        :

Constructor

Arguments

$config: object
An optional KConfig object with configuration options.

Details

visibility: public
final: false
static: false

__set
jump to class

__set(
          string $property, mixed $value
          )
        
        :

Set a request properties

This function also pushes any request changes into the model

Arguments

$property: string
The property name.
$value: mixed
The property value.

Details

visibility: public
final: false
static: false

_actionGet
jump to class

_actionGet(
          KCommandContext $context
          )
        
        :
        string|false

Specialised display function.

Arguments

$context: KCommandContext
A command context object

Output

string|false: The rendered output of the view or false if something went wrong

Details

visibility: protected
final: false
static: false

_initialize
jump to class

_initialize(
          object $config
          )
        
        :
        void

Initializes the default configuration for the object

Called from {@link __construct()} as a first step of object instantiation.

Arguments

$config: object
An optional KConfig object with configuration options.

Details

visibility: protected
final: false
static: false

getModel
jump to class

getModel(
          )
        
        :
        KModelAbstract

Get the model object attached to the contoller

Output

KModelAbstract

Details

visibility: public
final: false
static: false

getRedirect
jump to class

getRedirect(
          )
        
        :
        array

Returns an array with the redirect url, the message and the message type

Output

array: Named array containing url, message and messageType, or null if no redirect was set

Details

visibility: public
final: false
static: false

getView
jump to class

getView(
          )
        
        :
        KViewAbstract

Get the view object attached to the controller

Output

KViewAbstract

Details

visibility: public
final: false
static: false

setModel
jump to class

setModel(
          mixed $model
          )
        
        :
        KControllerAbstract

Method to set a model object attached to the controller

Arguments

$model: mixed
An object that implements KObjectIdentifiable, an object that implements KIndentifierInterface or valid identifier string

Output

KControllerAbstract

Details

visibility: public
final: false
static: false
throws: If the identifier is not a model identifier

setRedirect
jump to class

setRedirect(
          string $url, string $msg
              =
              null, string $type
              =
              message
          )
        
        :
        KControllerAbstract

Set a URL for browser redirection.

Arguments

$url: string
URL to redirect to.
$msg: string
Message to display on redirect. Optional, defaults to value set internally by controller, if any.
$type: string
Message type. Optional, defaults to 'message'.

Output

KControllerAbstract

Details

visibility: public
final: false
static: false

setView
jump to class

setView(
          mixed $view
          )
        
        :
        KControllerAbstract

Method to set a view object attached to the controller

Arguments

$view: mixed
An object that implements KObjectIdentifiable, an object that implements KIndentifierInterface or valid identifier string

Output

KControllerAbstract

Details

visibility: public
final: false
static: false
throws: If the identifier is not a view identifier

code/libraries/koowa/controller/page.php

Description

KControllerPagejump to top

Description

Properties

$_modeljump to class

Details

$_redirectjump to class

Details

$_redirect_messagejump to class

Details

$_redirect_typejump to class

Details

$_viewjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

__setjump to class

Arguments

Details

_actionGetjump to class

Arguments

Output

Details

_initializejump to class

Arguments

Details

getModeljump to class

Output

Details

getRedirectjump to class

Output

Details

getViewjump to class

Output

Details

setModeljump to class

Arguments

Output

Details

setRedirectjump to class

Arguments

Output

Details

setViewjump to class

Arguments

Output

Details

KControllerPage
jump to top

$_model
jump to class

$_redirect
jump to class

$_redirect_message
jump to class

$_redirect_type
jump to class

$_view
jump to class

__call
jump to class

__construct
jump to class

__set
jump to class

_actionGet
jump to class

_initialize
jump to class

getModel
jump to class

getRedirect
jump to class

getView
jump to class

setModel
jump to class

setRedirect
jump to class

setView
jump to class