Client
[ class tree: Client ] [ index: Client ] [ all elements ]
Packages:
CartoWeb3
Client
Common
CorePlugins
Htdocs
Plugins
Scripts
Server
Tests


Files:
AjaxHelper.php
Cartoclient.php
CartoserverService.php
ClientMapInfoCache.php
ClientPlugin.php
ClientPluginHelper.php
ClientProjectHandler.php
ExportPlugin.php
FormRenderer.php
HttpRequestHandler.php
Internationalization.php
MapInfoCache.php
ServerMapInfoCache.php
Smarty_Cartoclient.php
Views.php

Classes:
Ajaxable
AjaxException
AjaxPluginResponse
Cartoclient
CartoclientException
CartoForm
CartoserverService
ClientAccountingImpl
ClientConfig
ClientExportRtf
ClientMapInfoCache
ClientPlugin
ClientPluginConfig
ClientPluginHelper
ClientProjectHandler
ClientSession
DhtmlSelectionParser
EncoderInterface
EncoderISO
EncoderUTF
Exportable
ExportConfiguration
ExportOutput
ExportPlugin
FilterProvider
FilterRequestModifier
FormRenderer
GuiProvider
HttpRequestHandler
I18n
I18nDummy
I18nGettext
I18nInterface
InitUser
InitUserHelper
Json
PixelCoordsConverter
PluginEnabler
ServerCaller
ServerCallerHelper
Sessionable
SessionableHelper
Smarty_Cartoclient
Smarty_Plugin
SoapFaultWrapper
ToolDescription
ToolProvider
ToolProviderHelper
ViewContainer
ViewDbContainer
ViewFileContainer
ViewFilter
ViewHooks
ViewManager
ViewUpgrader

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 ]


	
	

	
$customTitle = 

	
[line 60]

  



Tags:





  

    var:  the page title. 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 ]


	
	

	
$specialOutput =  ''

	
[line 65]

  



Tags:





  

    var:  some string to output in addition to regular output
  

  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$tools = 

	
[line 70]

  



Tags:





  

    var:  of activated tools appearing in the interface
  

  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 76]

	

    

    

		FormRenderer __construct(
Cartoclient
$cartoclient)
    

    


	
		Constructor





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        Cartoclient  
        $cartoclient  
        
      

        

    


        
[ Top ]

  

  

	
	
method drawJavascriptFolders [line 242]

	

    

    

		void drawJavascriptFolders(
)
    

    


	
		Sets template variables for displaying the javascript folders.





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method drawMessages [line 222]

	

    

    

		void drawMessages(
array
$messages)
    

    


	
		Draws user and developer messages





Tags:





  

    access:  private
  










        
Parameters:

    

    

          

        array  
        $messages  
        array of messages
      

        

    


        
[ Top ]

  

  

	
	
method drawProjectsChooser [line 254]

	

    

    

		void drawProjectsChooser(
)
    

    


	
		Draw a drop-down list with project names.





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method drawTools [line 116]

	

    

    

		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 284]

	

    

    

		void drawUserAndRoles(
)
    

    


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





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method getDeveloperMessages [line 200]

	

    

    

		array getDeveloperMessages(
array
$messages)
    

    


	
		Returns a developers messages array





Tags:





  

    return:  array of developer messages if any, empty array otherwise
  

  

    access:  private
  










        
Parameters:

    

    

          

        array  
        $messages  
        array of messages
      

        

    


        
[ Top ]

  

  

	
	
method getMessages [line 166]

	

    

    

		array getMessages(
)
    

    


	
		Returns CartoWeb's user and developer messages





Tags:





  

    return:  array of messages (user and developer)
  

  

    access:  private
  

  

    todo:  Factor getUserMessages() and getDeveloperMessages (bug #1345)
  










        
[ Top ]

  

  

	
	
method getSmarty [line 103]

	

    

    

		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 getTools [line 478]

	

    

    

		array getTools(
)
    

    


	
		Return the list of activated tools, see drawTools()





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getUserMessages [line 178]

	

    

    

		array getUserMessages(
array
$messages)
    

    


	
		Returns a user messages array





Tags:





  

    return:  user messages if any, empty array otherwise
  

  

    access:  private
  










        
Parameters:

    

    

          

        array  
        $messages  
        array of messages
      

        

    


        
[ Top ]

  

  

	
	
method render [line 317]

	

    

    

		void render(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method setCustomForm [line 305]

	

    

    

		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. If false, Smarty template  rendering will be completely skipped (usefull if a plugin manages the  html display itself).
      

        

    


        
[ Top ]

  

  

	
	
method setCustomTitle [line 313]

	

    

    

		void setCustomTitle(
string
$customTitle)
    

    


	
		Sets a different title





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $customTitle  
        new title
      

        

    


        
[ Top ]

  

  

	
	
method setSpecialOutput [line 89]

	

    

    

		void setSpecialOutput(
string
$output, [bool
$reset = false])
    

    


	
		Sets special output to display in addition of standard output.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $output  
        
      

          

        bool  
        $reset  
        if true, resets special output container before adding  given content (default: false)
      

        

    


        
[ Top ]

  

  

	
	
method showAjaxPluginResponse [line 399]

	

    

    

		void showAjaxPluginResponse(
)
    

    


	
		Polls and displays all Ajaxable plugins responses,

using the XML basaed smarty template





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method showFailure [line 457]

	

    

    

		string showFailure(
Exception
$exception)
    

    


	
		Displays failure using failure.tpl Smarty templates





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        Exception  
        $exception  
        exception to display
      

        

    


        
[ Top ]

  

  

	
	
method showForm [line 334]

	

    

    

		string showForm(
)
    

    


	
		Displays GUI using cartoclient.tpl Smarty template





Tags:





  

    access:  public
  










        
[ Top ]

  






        

		    

		    Documentation generated on Fri, 21 Sep 2007 13:30:47 +0200 by phpDocumentor 1.3.0RC3