mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]
Packages:
mojavi


Files:
mojavi.php
version.php

subpackage action
Action.class.php
ActionStack.class.php
ActionStackEntry.class.php

subpackage config
AutoloadConfigHandler.class.php
CompileConfigHandler.class.php
ConfigCache.class.php
ConfigHandler.class.php
DatabaseConfigHandler.class.php
DefineConfigHandler.class.php
FactoryConfigHandler.class.php
FilterConfigHandler.class.php
IniConfigHandler.class.php
LoggingConfigHandler.class.php
ModuleConfigHandler.class.php
ParameterParser.class.php
RootConfigHandler.class.php
ValidatorConfigHandler.class.php

subpackage controller
ConsoleController.class.php
Controller.class.php
FrontWebController.class.php
PageWebController.class.php
WebController.class.php

subpackage core
Context.class.php
MojaviObject.class.php

subpackage database
CreoleDatabase.class.php
Database.class.php
DatabaseManager.class.php
MySQLDatabase.class.php
PDODatabase.class.php
PostgreSQLDatabase.class.php

subpackage exception
AutoloadException.class.php
CacheException.class.php
ConfigurationException.class.php
ControllerException.class.php
DatabaseException.class.php
FactoryException.class.php
FileException.class.php
FilterException.class.php
ForwardException.class.php
InitializationException.class.php
LoggingException.class.php
MojaviException.class.php
ParseException.class.php
RenderException.class.php
SecurityException.class.php
StorageException.class.php
ValidatorException.class.php
ViewException.class.php

subpackage filter
BasicSecurityFilter.class.php
ExecutionFilter.class.php
ExecutionTimeFilter.class.php
Filter.class.php
FilterChain.class.php
SecurityFilter.class.php

subpackage logging
Appender.class.php
ErrorLogger.class.php
FileAppender.class.php
Layout.class.php
Logger.class.php
LoggerManager.class.php
MailAppender.class.php
Message.class.php
PatternLayout.class.php
StderrAppender.class.php
StdoutAppender.class.php

subpackage model
Model.class.php

subpackage request
ConsoleRequest.class.php
Request.class.php
WebRequest.class.php

subpackage storage
MySQLSessionStorage.class.php
PostgreSQLSessionStorage.class.php
SessionStorage.class.php
Storage.class.php

subpackage user
BasicSecurityUser.class.php
SecurityUser.class.php
User.class.php

subpackage util
ConversionPattern.class.php
ParameterHolder.class.php
Toolkit.class.php

subpackage validator
DateValidator.class.php
EmailValidator.class.php
NumberValidator.class.php
RegexValidator.class.php
StringValidator.class.php
Validator.class.php
ValidatorManager.class.php

subpackage view
PHPView.class.php
SmartyView.class.php
View.class.php

Classes:
action
   Action
   ActionStack
   ActionStackEntry
logging
   Appender
   ErrorLogger
   FileAppender
   Layout
   Logger
   LoggerManager
   MailAppender
   Message
   PatternLayout
   StderrAppender
   StdoutAppender
config
   AutoloadConfigHandler
   CompileConfigHandler
   ConfigCache
   ConfigHandler
   DatabaseConfigHandler
   DefineConfigHandler
   FactoryConfigHandler
   FilterConfigHandler
   IniConfigHandler
   LoggingConfigHandler
   ModuleConfigHandler
   ParameterParser
   RootConfigHandler
   ValidatorConfigHandler
exception
   AutoloadException
   CacheException
   ConfigurationException
   ControllerException
   DatabaseException
   FactoryException
   FileException
   FilterException
   ForwardException
   InitializationException
   LoggingException
   MojaviException
   ParseException
   RenderException
   SecurityException
   StorageException
   ValidatorException
   ViewException
filter
   BasicSecurityFilter
   ExecutionFilter
   ExecutionTimeFilter
   Filter
   FilterChain
   SecurityFilter
user
   BasicSecurityUser
   SecurityUser
   User
controller
   ConsoleController
   Controller
   FrontWebController
   PageWebController
   WebController
request
   ConsoleRequest
   Request
   WebRequest
core
   Context
   MojaviObject
util
   ConversionPattern
   ParameterHolder
   Toolkit
database
   CreoleDatabase
   Database
   DatabaseManager
   MySQLDatabase
   PDODatabase
   PostgreSQLDatabase
validator
   DateValidator
   EmailValidator
   NumberValidator
   RegexValidator
   StringValidator
   Validator
   ValidatorManager
model
   Model
storage
   MySQLSessionStorage
   PostgreSQLSessionStorage
   SessionStorage
   Storage
view
   PHPView
   SmartyView
   View

Class: Context

Source Location: /core/Context.class.php

Class Overview

MojaviObject
   |
   --Context

Context provides information about the current application context, such as the module and action names and the module directory. References to the current controller, request, and user implementation instances are also provided.


Author(s):

  • Sean Kerr (skerr@mojavi.org)

Version:

  • $Id: Context.class.php 704 2004-12-28 14:23:12Z seank $

Copyright:

Variables

Methods

Inherited Methods

Class: MojaviObject

MojaviObject::toString()
Retrieve a string representation of this object.

Class Details

[line 26]
Context provides information about the current application context, such as the module and action names and the module directory. References to the current controller, request, and user implementation instances are also provided.



Tags:

version:  $Id: Context.class.php 704 2004-12-28 14:23:12Z seank $
since:  3.0.0
copyright:  (c) Sean Kerr, http://www.mojavi.org
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

Class Variables

$controller =  null

[line 35]


Type:   mixed


[ Top ]

$databaseManager =  null

[line 36]


Type:   mixed


[ Top ]

$request =  null

[line 37]


Type:   mixed


[ Top ]

$storage =  null

[line 38]


Type:   mixed


[ Top ]

$user =  null

[line 39]


Type:   mixed


[ Top ]


Class Methods

constructor __construct [line 57]

Context __construct( Controller $controller, Request $request, User $user, Storage $storage, DatabaseManager $databaseManager)

Class constructor.



Tags:

access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


Parameters:

Controller   $controller   The current Controller implementation instance.
Request   $request   The current Request implementation instance.
User   $user   The current User implementation instance.
Storage   $storage   The current Storage implementation instance.
DatabaseManager   $databaseManager   The current DatabaseManager instance.

[ Top ]

method getActionName [line 83]

string getActionName( )

Retrieve the action name for this context.



Tags:

return:  The currently executing action name, if one is set, otherwise null.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method getController [line 103]

Controller getController( )

Retrieve the controller.



Tags:

return:  The current Controller implementation instance.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method getDatabaseConnection [line 130]

mixed getDatabaseConnection( [name $name = 'default'])

Retrieve a database connection from the database manager.

This is a shortcut to manually getting a connection from an existing database implementation instance.

If the MO_USE_DATABASE setting is off, this will return null.




Tags:

return:  A Database instance.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)
throws:  DatabaseException If the requested database name does not exist.


Parameters:

name   $name   A database name.

[ Top ]

method getDatabaseManager [line 154]

DatabaseManager getDatabaseManager( )

Retrieve the database manager.



Tags:

return:  The current DatabaseManager instance.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method getModuleDirectory [line 172]

string getModuleDirectory( )

Retrieve the module directory for this context.



Tags:

return:  An absolute filesystem path to the directory of the currently executing module, if one is set, otherwise null.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method getModuleName [line 193]

string getModuleName( )

Retrieve the module name for this context.



Tags:

return:  The currently executing module name, if one is set, otherwise null.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method getRequest [line 213]

Request getRequest( )

Retrieve the request.



Tags:

return:  The current Request implementation instance.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method getStorage [line 230]

Storage getStorage( )

Retrieve the storage.



Tags:

return:  The current Storage implementation instance.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

method getUser [line 247]

User getUser( )

Retrieve the user.



Tags:

return:  The current User implementation instance.
access:  public
since:  3.0.0
author:  Sean Kerr (skerr@mojavi.org)


[ Top ]

Documentation generated on Tue, 21 Feb 2006 01:45:13 +0900 by phpDocumentor 1.3.0RC5