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

Class: ZNF

Source Location: /ZNF.php

Class ZNF

Class Overview

ZNF provides the controller in the Model-View-Controller (MVC) design pattern for web applications that is commonly known as Model 2.

Located in /ZNF.php [line 41]



		
				Author(s):
		
		
		API Tags:
Access:  public

Information Tags:
Version:  SVN $Id: ZNF.php 44 2007-07-22 23:55:30Z evolic $
Copyright:  2004-2007 The ZNF Development Team
Link:  http://www.zeronotice.org
Since:  Release 0.6.1
License:  LGPL

Methods

[ Top ]
Constant Summary
ACTION_INDEX   Name of the GET attribute used to select the action to execute.
CACHE_DIR   Name of the cache directory.
CHANGE_MODULE_INDEX   Name of the GET attribute used to select persistently the module configuration.
CONFIG_DIR   Name of the config directory.
CREDITS   ZNF credits, don't modify the line below.
DEBUG   Debugging mode, set to true if you want to debug the application.
LANG_DIR   Name of the language directory.
LIB_DIR   Name of the libraries directory.
MODULES_DIR   Name of the modules directory.
MODULE_INDEX   Name of the GET attribute used to select the module configuration.
TEMPLATE_DIR   Name of the package templates directory.
TEMPLATE_OVERLAY_DIR   Name of the package templates overlay directory.
THEME_DIR   Name of the theme directory.
VERSION   Version of the framework.

[ Top ]
Method Summary
ZNF   __construct()   Constructs a new ZNF object.
boolean   process()   Processes the action requested with the correct ZNF_Action_RequestProcessor.
void   updateAction()   Update the name of the action in the request.
void   updateModule()   Update the name of the module in the request.
string   _processModule()   Extracts the name of the module from the request.
string   _processPath()   Extracts the name of the action from the request.
boolean   _startSession()   Starts or reloads the session, setting the proper framework attributes for language, locale, theme and sessionId.

[ Top ]
Methods
Constructor __construct  [line 119]

  ZNF __construct( )

Constructs a new ZNF object.


API Tags:
Access:  public


[ Top ]
process  [line 131]

  boolean process( )

Processes the action requested with the correct ZNF_Action_RequestProcessor.


API Tags:
Access:  public


[ Top ]
updateAction  [line 271]

  void updateAction( string $action  )

Update the name of the action in the request.

This method is used by the ZNF_Action_RequestProcessor to forward the control flow to another module according to the current module configuration.

Parameters:
string   $action: 

API Tags:
Access:  public


[ Top ]
updateModule  [line 286]

  void updateModule( string $module  )

Update the name of the module in the request.

This method is used by the ZNF_Action_RequestProcessor to forward the control flow to another module according to the current module configuration.

Parameters:
string   $module: 

API Tags:
Access:  public


[ Top ]
_processModule  [line 244]

  string _processModule( )

Extracts the name of the module from the request.

This method returns null if no module is found, then the ZNF_Config_ModulesConfig::getInstance() returns the configuration of the default module element from the application configuration file.


API Tags:
Access:  protected


[ Top ]
_processPath  [line 224]

  string _processPath( )

Extracts the name of the action from the request.

This method returns null if no action is found, then the ZNF_Action_RequestProcessor->_processMapping() select the default action element from the module configuration file.


API Tags:
Access:  protected


[ Top ]
_startSession  [line 171]

  boolean _startSession( )

Starts or reloads the session, setting the proper framework attributes for language, locale, theme and sessionId.


API Tags:
Access:  protected


[ Top ]
Constants
ACTION_INDEX = 'znfAction' [line 52]

Name of the GET attribute used to select the action to execute.


[ Top ]
CACHE_DIR = 'cache' [line 67]

Name of the cache directory.


[ Top ]
CHANGE_MODULE_INDEX = 'znfChangeModule' [line 62]

Name of the GET attribute used to select persistently the module configuration.


[ Top ]
CONFIG_DIR = 'config' [line 72]

Name of the config directory.


[ Top ]
CREDITS = 'Powered by <a target="_blank" href="http://www.zeronotice.org">ZNF</a> &raquo; &copy; 2004-2007 The ZNF Development Team &raquo; Released under the <a target="_blank" href="http://www.gnu.org/copyleft/lesser.html">GNU/LGPL</a> license' [line 112]

ZNF credits, don't modify the line below.


[ Top ]
DEBUG = false [line 107]

Debugging mode, set to true if you want to debug the application.


[ Top ]
LANG_DIR = 'lang' [line 77]

Name of the language directory.


[ Top ]
LIB_DIR = 'lib' [line 82]

Name of the libraries directory.


[ Top ]
MODULES_DIR = 'modules' [line 87]

Name of the modules directory.


[ Top ]
MODULE_INDEX = 'znfModule' [line 57]

Name of the GET attribute used to select the module configuration.


[ Top ]
TEMPLATE_DIR = 'templates' [line 92]

Name of the package templates directory.


[ Top ]
TEMPLATE_OVERLAY_DIR = 'packages' [line 97]

Name of the package templates overlay directory.


[ Top ]
THEME_DIR = 'themes' [line 102]

Name of the theme directory.


[ Top ]
VERSION = '0.7.10' [line 47]

Version of the framework.


[ Top ]

Documentation generated on Wed, 14 Nov 2007 23:47:43 +0100 by phpDocumentor 1.4.0