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


Files:
ClientAuth.php
ClientCheckInstall.php
ClientCheckInstall.php
ClientCheckInstall.php
ClientDemoRouting.php
ClientEdit.php
ClientExportCsv.php
ClientExportDxf.php
ClientExportHtml.php
ClientExportPdf.php
ClientFilterIdrecenter.php
ClientGeostat.php
ClientHello.php
ClientLayerReorder.php
ClientLocate.php
ClientMapOverlay.php
ClientOutline.php
ClientRouting.php
ClientTestMainTableRules.php
ClientViews.php
ClientWmsBrowser.php
CwFpdf.php
Edit.php
ExportPdf.php
ExportPdfObjects.php
Geostat.php
LayerReorder.php
MapOverlay.php
Outline.php
PdfLibLite.php
QueryableLayer.php
Routing.php
ServerDemoRouting.php
ServerEdit.php
ServerExportPdf.php
ServerGeostat.php
ServerHilight.php
ServerLayerReorder.php
ServerMapOverlay.php
ServerOutline.php
ServerProjectGeotoolsRouting.php
ServerProjectPostgresRouting.php
ServerProjectRouting.php
ServerRouting.php
ServerTestMainGeotoolsRouting.php
ServerTestMainPostgresRouting.php
ServerTestMainRouting.php
ServerToolTips.php
ServerWmsBrowser.php
ToolTips.php
ToolTipsService.php

Classes:
Attribute
BasicOverlay
ByIdQueryableLayer
ByXyQueryableLayer
cFPDF
ClassOverlay
ClientAuth
ClientCheckInstall
ClientDemoRouting
ClientEdit
ClientExportCsv
ClientExportDxf
ClientExportHtml
ClientExportPdf
ClientFilterIdrecenter
ClientGeostat
ClientHello
ClientLayerReorder
ClientLocate
ClientMapOverlay
ClientOutline
ClientRouting
ClientToolTips
ClientViews
ClientWmsBrowser
ColorOverlay
CwFpdf
DbSecurityContainer
DxfShape
Edge
EditRequest
EditResult
EditState
ExportPdfInit
ExportPdfState
GeostatChoropleth
GeostatClientState
GeostatInit
GeostatLayerParams
GeostatRequest
GeostatResult
ImagemapFeature
IniSecurityContainer
LabelOverlay
LayerOverlay
LayerReorderInit
LayerReorderRequest
LayerReorderResult
LayerReorderState
LayerTransparency
MapOverlay
MetadataOverlay
Node
OutlineDefaultValue
OutlineInit
OutlineRequest
OutlineResult
OutlineState
OutlineV1ToV2
OutlineV2ToV3
Parameter
PdfBlock
PdfFormat
PdfGeneral
PdfLibLite
PdfWriter
PositionOverlay
PostgresGraph
PrintTools
ProxyAuthContainer
QueryableLayer
RoutingRequest
RoutingResult
RoutingState
ServerDemoRouting
ServerEdit
ServerExportPdf
ServerGeostat
ServerGeotoolsRouting
ServerHilight
ServerLayerReorder
ServerMapOverlay
ServerOutline
ServerPostgresRouting
ServerProjectGeotoolsRouting
ServerProjectPostgresRouting
ServerProjectRouting
ServerRouting
ServerTestMainGeotoolsRouting
ServerTestMainPostgresRouting
ServerTestMainRouting
ServerToolTips
ServerWmsBrowser
SpaceManager
Step
StyledShape
StyleOverlay
TableElement
ToolTipsRequest
ToolTipsService
ToolTipsState
TwBin
TwBinHelper
TwClassification
TwClassificationHelper
TwColorRgb
TwColorRgbHelper
TwDistributionSummary
TwDistributionSummaryHelper
ViewsState
WmsBrowserRequest
WmsBrowserState

Class: ToolTipsService

Source Location: /plugins/toolTips/client/ToolTipsService.php

Class Overview




ToolTips AJAX Service














Variables







Methods
























Class Details



[line 33]

ToolTips AJAX Service





[ Top ]







Class Variables



	
	

	
$lastDb = 

	
[line 75]

  Last instancied PEAR::DB object; for reusing DB object





Tags:





  

    var:  array of string
  

  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$layerResults = array()

	
[line 51]

  Results for queried layers





Tags:





  

    var:  array of LayerResult
  

  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$mapScale = 

	
[line 69]

  Current geographic scale (geographic unit per pixel)





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      float
    

      

	



	
[ Top ]


	
	

	
$queryableLayers = array()

	
[line 45]

  Queryable layers and their returned attributes





Tags:





  

    var:  array of QueryableLayer
  

  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$smarty = 

	
[line 39]

  Queryable layers and their returned attributes





Tags:





  

    var:  Smarty_Plugin instance for toolTips
  

  

    access:  protected
  






  

	

  

    

      Type:  
      Smarty_Plugin
    

      

	



	
[ Top ]


	
	

	
$x = 

	
[line 57]

  X coordinate for the query (geographic)





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      float
    

      

	



	
[ Top ]


	
	

	
$y = 

	
[line 63]

  Y coordinate for the query (geographic)





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      float
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 81]

	

    

    

		ToolTipsService __construct(
Cartoclient
$cartoclient)
    

    


	
		Constructor





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        Cartoclient  
        $cartoclient  
        
      

        

    


        
[ Top ]

  

  

	
	
method addByIdQueryableLayers [line 161]

	

    

    

		void addByIdQueryableLayers(
array
$layers)
    

    


	
		Adds queryableLayers with a given list of layers





Tags:





  

    access:  protected
  










        
Parameters:

    

    

          

        array  
        $layers  
        
      

        

    


        
[ Top ]

  

  

	
	
method addByXyQueryableLayers [line 108]

	

    

    

		void addByXyQueryableLayers(
mixed
$layers)
    

    


	
		Adds byXyQueryableLayer with a given list of layers





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method addLayerResult [line 329]

	

    

    

		void addLayerResult(
LayerResult
$layerResult)
    

    


	
		



Tags:





  

    access:  protected
  










        
Parameters:

    

    

          

        LayerResult  
        $layerResult  
        
      

        

    


        
[ Top ]

  

  

	
	
method addLayerResults [line 339]

	

    

    

		void addLayerResults(
array
$layerResults)
    

    


	
		



Tags:





  

    access:  protected
  










        
Parameters:

    

    

          

        array  
        $layerResults  
        array of LayerResult
      

        

    


        
[ Top ]

  

  

	
	
method addQueryableLayer [line 308]

	

    

    

		void addQueryableLayer(
QueryableLayer
$queryableLayer)
    

    


	
		Adds the given QueryableLayer to the toolTipsService queryableLayers array





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        QueryableLayer  
        $queryableLayer  
        
      

        

    


        
[ Top ]

  

  

	
	
method getDb [line 295]

	

    

    

		PEAR::DB getDb(
string
$layerId)
    

    


	
		Returns a PEAR::DB connexion





Tags:





  

    return:  DB connexion for the given layerId
  

  

    access:  protected
  










        
Parameters:

    

    

          

        string  
        $layerId  
        layerId Id of the layer whose DSN is to be returned
      

        

    


        
[ Top ]

  

  

	
	
method getLastMapRequest [line 222]

	

    

    

		MapRequest getLastMapRequest(
)
    

    


	
		Returns session-saved last MapRequest.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getLastMapResult [line 239]

	

    

    

		MapResult getLastMapResult(
)
    

    


	
		Returns session-saved last MapResult.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getLastScale [line 253]

	

    

    

		float getLastScale(
)
    

    


	
		



Tags:





  

    return:  scale from last session-saved MapResult.
  

  

    access:  protected
  










        
[ Top ]

  

  

	
	
method getLayerResult [line 349]

	

    

    

		void getLayerResult(
mixed
$layerId)
    

    


	
		



Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method getQueryableLayer [line 321]

	

    

    

		array getQueryableLayer(
mixed
$layerId)
    

    


	
		Gives the list of queryableLayers





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method getResponse [line 466]

	

    

    

		array getResponse(
)
    

    


	
		



Tags:





  

    return:  array of layersHtmlResult
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getSelectedLayers [line 358]

	

    

    

		array getSelectedLayers(
)
    

    


	
		Retrieve list of selected layers





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method getSmarty [line 271]

	

    

    

		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 queryLayerById [line 432]

	

    

    

		void queryLayerById(
mixed
$layerId, mixed
$id)
    

    


	
		Queries given layer with given id





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method queryLayers [line 370]

	

    

    

		void queryLayers(
)
    

    


	
		Queries all selected layers





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method queryLayersByXy [line 385]

	

    

    

		void queryLayersByXy(
mixed
$geoX, mixed
$geoY)
    

    


	
		Queries all selected layers with given coordinates





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method renderResults [line 456]

	

    

    

		void renderResults(
)
    

    


	
		Sets the Html result for each layer





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method run [line 285]

	

    

    

		void run(
)
    

    


	
		Runs the query method and renders the results





Tags:





  

    access:  public
  










        
[ Top ]

  






        

		    

		    Documentation generated on Wed, 30 Aug 2006 21:58:08 +0200 by phpDocumentor 1.3.0RC3