Inheritance diagram for DMInternalView:

Public Member Functions

__construct (DMTemplate $template, DMSession $session)
render ()
Include()s the template file.
getFlash ()
Returns and erases the flash message from the user's session.
isFlash ()
getTemplate ()
setTemplate (DMTemplate $template)

Detailed Description

Encapsulates a view that is internal to the dmBridge system, such as within the template engine or control panel. This is in contrast to an external view, which is an abstract view used in the context of custom software that interfaces with the dmBridge PHP API.

The concrete DMInternalView instance can always be accessed within HTML templates via the $view variable.

Author:: Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 21 of file DMInternalView.php.

Constructor & Destructor Documentation

DMInternalView::__construct	(	DMTemplate $	template,
		DMSession $	session
	)

Parameters:

DMTemplate	template
DMUser	user

Reimplemented in DMControlPanelView.

Definition at line 32 of file DMInternalView.php.

Member Function Documentation

DMInternalView::getFlash ( )

Returns and erases the flash message from the user's session.

Do not use this method to check for the presence of a flash message; use isFlash() instead.

Returns:: string The HTML-escaped flash message

See also:: isFlash()

Since:: 0.1

Definition at line 54 of file DMInternalView.php.

Referenced by isFlash().

DMInternalView::getTemplate ( )

Returns:: DMTemplate

Since:: 2.0

Definition at line 77 of file DMInternalView.php.

Referenced by DMFavoritesView::getAccessibleFavorites(), DMTemplateEngineView::getFavoritesView(), DMTemplateEngineView::getLoginView(), DMResultsView::getNumTileViewColumns(), DMTemplateEngineView::getSearchView(), DMObjectView::getViewForNextObject(), DMObjectView::getViewForPreviousObject(), and render().

DMInternalView::isFlash ( )

Returns:: Boolean

See also:: getFlash()

Since:: 0.1

Definition at line 69 of file DMInternalView.php.

DMInternalView::render ( )

Include()s the template file.

Not for public use.

Definition at line 41 of file DMInternalView.php.

DMInternalView::setTemplate ( DMTemplate $ template )

Parameters:

DMTemplate template

Definition at line 84 of file DMInternalView.php.

Referenced by __construct().

The documentation for this class was generated from the following file:

DMInternalView.php