Docs For Class atkFrontController

static mixed	$s_bridges
static mixed	$s_current
mixed	$m_action
atkFrontControllerBridge	$m_bridge
mixed	$m_cacheableActions
mixed	$m_contentType
mixed	$m_headers
mixed	$m_module
mixed	$m_name
mixed	$m_parent
mixed	$m_partial
mixed	$m_plugins
mixed	$m_rendered
mixed	$m_request
mixed	$m_result
mixed	$m_scriptCodes
mixed	$m_scriptFiles
mixed	$m_session
mixed	$m_styleCodes
mixed	$m_styleSheets
mixed	$m_template
mixed	$m_vars

[ Top ]

Method Summary

static atkFrontController	create()	Create controller based on the given URI.
static atkFrontControllerBridge	createBridge()	Bridge factory method. Returns the currently configured controller bridge.
static string	dispatchRequest()	Dispatch request. Find the right controller, let it handle the request and return it's result.
static atkFrontController	getCurrent()	Returns the current controller instance. This can either be the root or a nested controller.
static void	setCurrent()	Sets the current controller instance.
static array	uriParts()	Returns the parts from the uri like module, controller and action
atkFrontController	__construct()	Constructor.
void	addHeader()	Add response header. (Will only be outputted when renderPartial or renderContent is called for the root controller).
string	buildUrl()	Build url using the given URI and variables.
void	doRedirect()	Redirect to the given url.
string	formVarsFunctionTag()	Smarty function for converting the controller, action etc.
string	getAction()	Returns the action.
atkTmpFile	getActionCacheFile()	Get action cache file.
void	getActionCacheKey()	Get action cache key.
ReflectionMethod	getActionMethod()	Get the method to call for the current request.
string	getFileForTemplate()	Transform the template to use to a filename
void	getLayoutTemplatePath()	Returns the layout template path for this controller.
string	getModule()	Returns the controller module.
string	getname()	Returns the controller name.
atkFrontController	getParent()	Returns the parent controller.
atkDataHolder	getRequest()	Returns the request parameters.
atkFrontController	getRoot()	Returns the root controller.
atkDataHolder	getSession()	Returns the session.
string	getTemplate()	Get current template.
string	getTemplatePath()	Returns the template path for the given template.
string	getUriParam()	Returns the correct key value for the uri in forms and url's Defaults to 'uri'
array	getVars()	Get assigned template variables.
void	handleException()	Handle exception.
result	handleRequest()	Handle action.
void	init()	Init will be called just after preFilter and just before the request is dispatched to the right method.
void	installPlugins()	Install smarty plug-ins.
void	isActionCached()	Is this action cached?
boolean	isRoot()	Is this the root controller?
void	linkBlockTag()	Smarty wrapper function for the url function.
void	loadFromActionCache()	Load from action cache.
void	loadSession()	Load session.
bool	offsetExists()	Checks if a certain offset exists.
mixed	offsetGet()	Returns the value at the given offset.
void	offsetSet()	Sets the given offset with the given value
void	offsetUnset()	Unsets the given offset.
string	partialFunctionTag()	Smarty partial function, render partial template.
void	postFilter()	Will be called just after the request has been dispatched to the right method and the rendering took place but before the result is returned or outputted.
void	preFilter()	Will be called just before the request is dispatched to the right method.
string	redirect()	Redirect to the given url.
void	registerScriptCode()	Register JavaScript code.
void	registerScriptFile()	Register script file.
void	registerStyleCode()	Register stylesheet code.
void	registerStylesAndScripts()	Register styles and scripts using the bridge.
void	registerStyleSheet()	Register stylesheet of the given media type.
void	render()	Render template.
void	renderContent()	Render content.
void	renderPartial()	Render partial.
void	setCacheableActions()	Sets the cacheable actions.
void	setContentType()	Sets the content type (Will only be outputted when renderPartial or renderContent is called for the root controller).
void	setLocale()	Set locale based on the given language.
void	setTemplate()	Set current template.
void	storeInActionCache()	Store current action results in cache.
void	uninstallPlugins()	Uninstall smarty plug-ins.
string	uri()	Build the URI for the given controller and action.
string	url()	Build url or return the current url.
string	urlFunctionTag()	Smarty wrapper function for the url function.
string	_render()	Render template.
unknown	&__get()	Get template variable value.
void	__isset()	Is template variable set?
void	__set()	Template variable assignment.
void	__toString()	To string.

[ Top ]

Properties

static mixed $s_bridges = array() [line 35]

API Tags:

Access:

private

[ Top ]

static mixed $s_current = null [line 34]

API Tags:

Access:

private

[ Top ]

mixed $m_action [line 44]

API Tags:

Access:

protected

[ Top ]

atkFrontControllerBridge $m_bridge [line 40]

API Tags:

Access:

protected

[ Top ]

mixed $m_cacheableActions = array() [line 62]

API Tags:

Access:

protected

[ Top ]

mixed $m_contentType [line 60]

API Tags:

Access:

protected

[ Top ]

mixed $m_headers = array() [line 59]

API Tags:

Access:

protected

[ Top ]

mixed $m_module [line 42]

API Tags:

Access:

protected

[ Top ]

mixed $m_name [line 43]

API Tags:

Access:

protected

[ Top ]

mixed $m_parent [line 45]

API Tags:

Access:

protected

[ Top ]

mixed $m_partial = false [line 55]

API Tags:

Access:

protected

[ Top ]

mixed $m_plugins = NULL [line 53]

API Tags:

Access:

protected

[ Top ]

mixed $m_rendered = false [line 57]

API Tags:

Access:

protected

[ Top ]

mixed $m_request [line 47]

API Tags:

Access:

protected

[ Top ]

mixed $m_result = "" [line 56]

API Tags:

Access:

protected

[ Top ]

mixed $m_scriptCodes = array() [line 68]

API Tags:

Access:

protected

[ Top ]

mixed $m_scriptFiles = array() [line 67]

API Tags:

Access:

protected

[ Top ]

mixed $m_session [line 48]

API Tags:

Access:

protected

[ Top ]

mixed $m_styleCodes = array() [line 65]

API Tags:

Access:

protected

[ Top ]

mixed $m_styleSheets = array() [line 64]

API Tags:

Access:

protected

[ Top ]

mixed $m_template = "" [line 51]

API Tags:

Access:

protected

[ Top ]

mixed $m_vars = array() [line 50]

API Tags:

Access:

protected

[ Top ]

Methods

static method create [line 142]

static atkFrontController create(
string
$uri, [atkFrontController
$parent = NULL] 
)

Create controller based on the given URI.

Parameters:

string	$uri:	uri string
atkFrontController	$parent:	parent controller

API Tags:

Return:	the controller
Access:	protected

[ Top ]

static method createBridge [line 189]

static atkFrontControllerBridge createBridge(
)

Bridge factory method. Returns the currently configured controller bridge.

If an instance already exists, re-uses it, else a new bridge will be created.

API Tags:

Return:	front controller bridge
Access:	protected

[ Top ]

static method dispatchRequest [line 81]

static string dispatchRequest(
[array
$vars = array()], [bool
$merge = true] 
)

Dispatch request. Find the right controller, let it handle the request and return it's result.

Parameters:

array	$vars:	custom variables, will be merged with the request variables and overwrite existing (request) variables with the same name unless $merge is set to false
bool	$merge:	merge custom and request variables?

API Tags:

Return:	controller result
Access:	public

[ Top ]

static method getCurrent [line 168]

static atkFrontController getCurrent(
)

Returns the current controller instance. This can either be the root or a nested controller.

API Tags:

Return:	current controller instance
Access:	protected

[ Top ]

static method setCurrent [line 178]

static void setCurrent(
atkFrontController
$controller 
)

Sets the current controller instance.

Parameters:

atkFrontController

$controller:

current controller instance

API Tags:

Access:

protected

[ Top ]

static method uriParts [line 127]

static array uriParts(
string
$uri 
)

Returns the parts from the uri like module, controller and action

Parameters:

string

$uri:

API Tags:

Return:	array(module,controller,action)
Access:	protected

[ Top ]

Constructor __construct [line 210]

atkFrontController __construct(
string
$module, string
$name, string
$action, [atkFrontController
$parent = NULL] 
)

Constructor.

Parameters:

string	$module:	module name
string	$name:	controller name
string	$action:
atkFrontController	$parent:

API Tags:

Access:

protected

[ Top ]

addHeader [line 320]

void addHeader(
string
$header 
)

Add response header. (Will only be outputted when renderPartial or renderContent is called for the root controller).

Parameters:

string

$header:

The header to add

API Tags:

Access:

protected

[ Top ]

buildUrl [line 765]

string buildUrl(
string
$uri, array
$vars 
)

Build url using the given URI and variables.

Parameters:

string	$uri:	The controller URI.
array	$vars:	Request vars.

API Tags:

Return:	url
Access:	protected

[ Top ]

doRedirect [line 887]

void doRedirect(
string
$url 
)

Redirect to the given url.

Parameters:

string

$url:

The URL.

API Tags:

Access:

protected

[ Top ]

formVarsFunctionTag [line 826]

string formVarsFunctionTag(
array
$params, Smarty
$smarty 
)

Smarty function for converting the controller, action etc.

to hidden form vars.

Parameters:

array	$params:	parameters
Smarty	$smarty:	smarty reference

API Tags:

Return:	hidden form vars html
Access:	public

[ Top ]

getAction [line 308]

string getAction(
)

Returns the action.

API Tags:

Return:	action
Access:	protected

[ Top ]

getActionCacheFile [line 363]

atkTmpFile getActionCacheFile(
)

Get action cache file.

API Tags:

Access:

protected

[ Top ]

getActionCacheKey [line 353]

void getActionCacheKey(
)

Get action cache key.

API Tags:

Access:

protected

[ Top ]

getActionMethod [line 529]

ReflectionMethod getActionMethod(
)

Get the method to call for the current request.

API Tags:

Return:	The method.
Access:	protected

[ Top ]

getFileForTemplate [line 1112]

string getFileForTemplate(
string
$template, array
$vars, [bool
$partial = false] 
)

Transform the template to use to a filename

example: getFileForTemplate('tekno'): module/controller/tekno.tpl

Parameters:

string	$template:
array	$vars:
bool	$partial:

API Tags:

Return:	Filename for the template
Access:	protected

[ Top ]

getLayoutTemplatePath [line 1088]

void getLayoutTemplatePath(
)

Returns the layout template path for this controller.

API Tags:

Access:

protected

[ Top ]

getModule [line 298]

string getModule(
)

Returns the controller module.

API Tags:

Return:	controller module
Access:	protected

[ Top ]

getname [line 288]

string getname(
)

Returns the controller name.

API Tags:

Return:	controller name
Access:	protected

[ Top ]

getParent [line 237]

atkFrontController getParent(
)

Returns the parent controller.

API Tags:

Return:	parent
Access:	protected

[ Top ]

getRequest [line 268]

atkDataHolder getRequest(
)

Returns the request parameters.

API Tags:

Return:	request parameters
Access:	protected

[ Top ]

getRoot [line 257]

atkFrontController getRoot(
)

Returns the root controller.

API Tags:

Return:	root
Access:	protected

[ Top ]

getSession [line 278]

atkDataHolder getSession(
)

Returns the session.

API Tags:

Return:	session
Access:	protected

[ Top ]

getTemplate [line 620]

string getTemplate(
)

Get current template.

API Tags:

Return:	template name
Access:	protected

[ Top ]

getTemplatePath [line 1064]

string getTemplatePath(
string
$template, [string
$directory = 'templates'] 
)

Returns the template path for the given template.

Parameters:

string	$template:	template name
string	$directory:	the base template directory

API Tags:

Return:	template path
Access:	protected

[ Top ]

getUriParam [line 777]

string getUriParam(
)

Returns the correct key value for the uri in forms and url's Defaults to 'uri'

API Tags:

Return:	uri_key
Access:	protected

[ Top ]

getVars [line 640]

array getVars(
)

Get assigned template variables.

API Tags:

Return:	template variables
Access:	protected

[ Top ]

handleException [line 569]

void handleException(
Exception
$exception 
)

Handle exception.

Parameters:

Exception

$exception:

exception

API Tags:

Access:

protected

[ Top ]

handleRequest [line 445]

result handleRequest(
array
$request 
)

Handle action.

Parameters:

array

$request:

request variables

API Tags:

Return:	of action
Access:	protected

[ Top ]

init [line 553]

void init(
)

Init will be called just after preFilter and just before the request is dispatched to the right method.

API Tags:

Access:

protected

[ Top ]

installPlugins [line 593]

void installPlugins(
)

Install smarty plug-ins.

API Tags:

Access:

protected

[ Top ]

isActionCached [line 375]

void isActionCached(
)

Is this action cached?

API Tags:

Access:

protected

[ Top ]

isRoot [line 247]

boolean isRoot(
)

Is this the root controller?

API Tags:

Return:	is root controller?
Access:	protected

[ Top ]

linkBlockTag [line 858]

void linkBlockTag(
array
$params, string
$content, Smarty
$smarty, 
&$repeat, boolean
$repeat 
)

Smarty wrapper function for the url function.

Parameters:

array	$params:	parameters
string	$content:	content between link tags
Smarty	$smarty:	smarty reference
boolean	$repeat:	true first time
	&$repeat:

API Tags:

Access:

public

[ Top ]

loadFromActionCache [line 387]

void loadFromActionCache(
)

Load from action cache.

API Tags:

Access:

protected

[ Top ]

loadSession [line 585]

void loadSession(
)

Load session.

API Tags:

Access:

protected

[ Top ]

offsetExists [line 683]

bool offsetExists(
mixed
$offset 
)

Checks if a certain offset exists.

Parameters:

mixed

$offset:

offset

API Tags:

Return:	offset exists?
Access:	public

Implementation of:

ArrayAccess::offsetExists

[ Top ]

offsetGet [line 694]

mixed offsetGet(
mixed
$offset 
)

Returns the value at the given offset.

Parameters:

mixed

$offset:

API Tags:

Return:	value
Access:	public

Implementation of:

ArrayAccess::offsetGet

[ Top ]

offsetSet [line 705]

void offsetSet(
mixed
$offset, mixed
$value 
)

Sets the given offset with the given value

Parameters:

mixed	$offset:	offset
mixed	$value:	value

API Tags:

Access:

public

Implementation of:

ArrayAccess::offsetSet

[ Top ]

offsetUnset [line 715]

void offsetUnset(
mixed
$offset 
)

Unsets the given offset.

Parameters:

mixed

$offset:

offset

API Tags:

Access:

public

Implementation of:

ArrayAccess::offsetUnset

[ Top ]

partialFunctionTag [line 875]

string partialFunctionTag(
array
$params, Smarty
$smarty 
)

Smarty partial function, render partial template.

Parameters:

array	$params:	parameters
Smarty	$smarty:	smarty instance

API Tags:

Return:	rendered partial
Access:	public

[ Top ]

postFilter [line 561]

void postFilter(
)

Will be called just after the request has been dispatched to the right method and the rendering took place but before the result is returned or outputted.

API Tags:

Access:

protected

[ Top ]

preFilter [line 546]

void preFilter(
)

Will be called just before the request is dispatched to the right method.

API Tags:

Access:

protected

[ Top ]

redirect [line 901]

string redirect(
[string
$controller = NULL], [string
$action = NULL], [array
$vars = array()], [bool
$force = FALSE] 
)

Redirect to the given url.

Parameters:

string	$controller:	controller name (uses current if empty)
string	$action:	action name (uses current if empty and controller isn't changed, uses index if empty and other controller)
array	$vars:	request vars
bool	$force:	Force redirect?

API Tags:

Return:	url
Access:	protected

[ Top ]

registerScriptCode [line 983]

void registerScriptCode(
string
$code 
)

Parameters:

string

$code:

API Tags:

Access:

protected

[ Top ]

registerScriptFile [line 970]

void registerScriptFile(
string
$file 
)

Parameters:

string

$file:

script filename

API Tags:

Access:

protected

[ Top ]

registerStyleCode [line 957]

void registerStyleCode(
string
$code 
)

Parameters:

string

$code:

stylesheet code

API Tags:

Access:

protected

[ Top ]

registerStylesAndScripts [line 426]

void registerStylesAndScripts(
)

API Tags:

Access:

protected

[ Top ]

registerStyleSheet [line 944]

void registerStyleSheet(
string
$file, [string
$media = 'all'] 
)

Parameters:

string	$file:	stylesheet filename
string	$media:	media type (defaults to 'all')

API Tags:

Access:

protected

[ Top ]

render [line 1030]

void render(
[string
$template = NULL], [array
$vars = NULL], [boolean
$partial = false] 
)

Render template.

Will assign the partial and result variables and will prevent double rendering!

Parameters:

string	$template:	template name
array	$vars:	template variables
boolean	$partial:	render partial?

API Tags:

Access:

protected

[ Top ]

renderContent [line 1013]

void renderContent(
string
$content 
)

Render content.

Will assign the partial and result variables and will prevent double rendering!

Parameters:

string

$content:

content to render

API Tags:

Access:

protected

[ Top ]

renderPartial [line 1000]

void renderPartial(
[string
$template = NULL], [array
$vars = NULL] 
)

Render partial.

Will assign the partial and result variables and will prevent double rendering!

Parameters:

string	$template:	template name
array	$vars:	template variables

API Tags:

Access:

protected

[ Top ]

setCacheableActions [line 343]

void setCacheableActions(
array|string
$actions, ...
1 
)

Sets the cacheable actions.

Parameters:

array\|string	$actions:	cacheable actions
...	1:

API Tags:

Access:

protected

[ Top ]

setContentType [line 332]

void setContentType(
string
$contentType 
)

Sets the content type (Will only be outputted when renderPartial or renderContent is called for the root controller).

Parameters:

string

$contentType:

API Tags:

Access:

protected

[ Top ]

setLocale [line 920]

void setLocale(
string
$lng 
)

Set locale based on the given language.

Parameters:

string

$lng:

language (ISO code)

API Tags:

Access:

protected

[ Top ]

setTemplate [line 630]

void setTemplate(
string
$template 
)

Set current template.

Parameters:

string

$template:

template name

API Tags:

Access:

protected

[ Top ]

storeInActionCache [line 404]

void storeInActionCache(
)

Store current action results in cache.

API Tags:

Access:

protected

[ Top ]

uninstallPlugins [line 607]

void uninstallPlugins(
)

Uninstall smarty plug-ins.

API Tags:

Access:

protected

[ Top ]

uri [line 727]

string uri(
string
$controller, string
$action 
)

Build the URI for the given controller and action.

Parameters:

string	$controller:	controller name (uses current if empty)
string	$action:	action name (uses current if empty and controller isn't changed, uses index if empty and other controller)

API Tags:

Return:	uri
Access:	protected

[ Top ]

url [line 790]

string url(
[string
$controller = NULL], [string
$action = NULL], [array
$vars = array()] 
)

Build url or return the current url.

Parameters:

string	$controller:	controller name (uses current if empty)
string	$action:	action name (uses current if empty and controller isn't changed, uses index if empty and other controller)
array	$vars:	request vars

API Tags:

Return:	url
Access:	protected

[ Top ]

urlFunctionTag [line 803]

string urlFunctionTag(
array
$params, Smarty
$smarty 
)

Smarty wrapper function for the url function.

Parameters:

array	$params:	parameters
Smarty	$smarty:	smarty reference

API Tags:

Return:	url
Access:	public

[ Top ]

_render [line 1136]

string _render(
string
$template, array
$vars, boolean
$partial 
)

Render template.

Parameters:

string	$template:	template name
array	$vars:	template variables
boolean	$partial:	render partial?

API Tags:

Return:	rendered template
Access:	protected

[ Top ]

__get [line 672]

unknown &__get(
string
$name 
)

Get template variable value.

Parameters:

string

$name:

variable name

API Tags:

Access:

public

[ Top ]

__isset [line 650]

void __isset(
string
$name 
)

Is template variable set?

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]

__set [line 661]

void __set(
string
$name, unknown
$value 
)

Template variable assignment.

Parameters:

string	$name:	variable name
unknown	$value:	variable value

API Tags:

Access:

public

[ Top ]

__toString [line 1170]

void __toString(
)

To string.

API Tags:

Access:

public

[ Top ]