Client
[ class tree: Client ] [ index: Client ] [ all elements ]

Class: FormRenderer

Source Location: /client/FormRenderer.php

Class Overview


Class responsible for GUI display


Variables

Methods



Class Details

[line 34]
Class responsible for GUI display



[ Top ]


Class Variables

$cartoclient =

[line 44]



Tags:

access:  private

Type:   Cartoclient


[ Top ]

$customForm =

[line 55]



Tags:

var:  the name of a Smarty template resource (in templates directory). To be used instead of the default one.
access:  private

Type:   string


[ Top ]

$log =

[line 39]



Tags:

access:  private

Type:   Logger


[ Top ]

$smarty =

[line 49]



Tags:

var:  the smarty instance used to template rendering
access:  private

Type:   Smarty


[ Top ]



Class Methods


constructor __construct [line 61]

FormRenderer __construct( Cartoclient $cartoclient)

Constructor



Tags:

access:  public


Parameters:

Cartoclient   $cartoclient  

[ Top ]

method drawJavascriptFolders [line 161]

void drawJavascriptFolders( )

Sets template variables for displaying the javascript folders.



Tags:

access:  private


[ Top ]

method drawMessages [line 135]

void drawMessages( array $messages)

Draws user and developer messages



Tags:

access:  private


Parameters:

array   $messages   array of messages

[ Top ]

method drawProjectsChooser [line 173]

void drawProjectsChooser( )

Draw a drop-down list with project names.



Tags:

access:  private


[ Top ]

method drawTools [line 87]

void drawTools( Cartoclient $cartoclient)

Draws tool bar

Tools are ordered thanks to weight system.




Tags:

access:  private


Parameters:

Cartoclient   $cartoclient   Cartoclient

[ Top ]

method drawUserAndRoles [line 203]

void drawUserAndRoles( )

Sets some variables in the template about the current user and its roles.



Tags:

access:  private


[ Top ]

method getSmarty [line 74]

Smarty_Cartoclient getSmarty( )

Returns the Smarty template object used for template rendering. It may be used by plugins if they want to override the template display.



Tags:

access:  public


[ Top ]

method setCustomForm [line 221]

void setCustomForm( string $customForm)

Sets a different template resource to be used for display. If false, the Smarty display will be skipped. This is needed if a plugin does the html output on its own.



Tags:

access:  public


Parameters:

string   $customForm   the string name of a Smarty template resource file to use instead of the default cartoclient.tpl.

[ Top ]

method showFailure [line 269]

void showFailure( Exception $exception)

Displays failure using failure.tpl Smarty templates



Tags:

access:  public


Parameters:

Exception   $exception   exception to display

[ Top ]

method showForm [line 228]

void showForm( )

Displays GUI using cartoclient.tpl Smarty template



Tags:

access:  public


[ Top ]


Documentation generated on Wed, 6 Apr 2005 12:06:39 +0200 by phpDocumentor 1.3.0RC3