phpDocumentor Naos_Controller
[ class tree: Naos_Controller ] [ index: Naos_Controller ] [ all elements ]

Class: Naos_Controller_Action

Source Location: /Controller/Action.php

Class Naos_Controller_Action

Class Overview

Naos_Controller_Action

Located in /Controller/Action.php [line 24]

Zend_Controller_Action
   |
   --Naos_Controller_Action
Author(s):
Information Tags:
Copyright:  Copyright (c) 2008 Jupiter GmbH
License:  http://www.naos-framework.com/website.naos.framework/en/license

Methods

[ Top ]
Method Summary
Naos_Controller_Action   __construct()   Constructor
void   closeDialog()   Closes an existing dialog instance (at the moment only supported via AJAX)
void   createRenderer()  
void   openDialog()   Creates a new dialog instance (at the moment only supported via AJAX)
void   render()   Render a view
void   renderScript()   Render a given view script
void   triggerCustomOperation()  

[ Top ]
Methods
Constructor __construct  [line 33]

  Naos_Controller_Action __construct( $request, $response, [ $invokeArgs = array()]  )

Constructor

Parameters:
Zend_Controller_Request_Abstract   $request: 
Zend_Controller_Response_Abstract   $response: 
array   $invokeArgs: 

API Tags:
Access:  public


[ Top ]
closeDialog  [line 151]

  void closeDialog( string $dialogId  )

Closes an existing dialog instance (at the moment only supported via AJAX)

Parameters:
string   $dialogId:  dialog identifier

API Tags:
Access:  public


[ Top ]
createRenderer  [line 42]

  void createRenderer( )


API Tags:
Access:  public


[ Top ]
openDialog  [line 133]

  void openDialog( string $dialogId, string $type, string $position, Naos_View $output, [ $templateName = null]  )

Creates a new dialog instance (at the moment only supported via AJAX)

Parameters:
string   $dialogId:  dialog identifier
string   $type:  available types: default, simple, tooltip
string   $position:  available positions: center, mouse, lastlink
Naos_View   $output:  dialog output
   $templateName: 

API Tags:
Access:  public


[ Top ]
render  [line 94]

  void render( [string|null $action = null], [string|null $name = null], [bool $noController = false]  )

Render a view

Renders a view. By default, views are found in the view script path as <controller>/<action>.phtml. You may change the script suffix by resetting $viewSuffix. You may omit the controller directory prefix by specifying boolean true for $noController.

Parameters:
string|null   $action:  Defaults to action registered in request object
string|null   $name:  ignored
bool   $noController:  Defaults to false; i.e. use controller name as subdir in which to search for view script

API Tags:
Access:  public


[ Top ]
renderScript  [line 114]

  void renderScript( string $script, [string|null $name = null]  )

Render a given view script

Similar to render(), this method renders a view script. Unlike render(), however, it does not autodetermine the view script via getViewScript(), but instead renders the script passed to it. Use this if you know the exact view script name and path you wish to use, or if using paths that do not conform to the spec defined with getViewScript().

Parameters:
string   $script: 
string|null   $name:  ignored

API Tags:
Access:  public


[ Top ]
triggerCustomOperation  [line 158]

  void triggerCustomOperation( $type, [ $data = array()]  )

Parameters:
   $type: 
   $data: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Sat, 13 Sep 2008 01:40:35 -0400 by phpDocumentor 1.4.0