Plugins

[ ] [ ] [ ]

Packages:
CartoWeb3
Client
Common
CorePlugins
Htdocs
Plugins
Scripts
Server
Tests

Files:

ClientAuth.php
ClientBboxHistory.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
ClientOgcLayerLoader.php
ClientOutline.php
ClientRouting.php
ClientSearch.php
ClientTestMainTableRules.php
ClientViews.php
ClientWmsBrowserLight.php
CwFpdf.php
Edit.php
ExportPdf.php
ExportPdfObjects.php
Geostat.php
LayerReorder.php
LayerResult.php
MapOverlay.php
OgcLayerLoader.php
Outline.php
OwsInfoHarwester.php
OwsInfoHarwesterOLL.php
PdfLibLite.php
QueryableLayer.php
Routing.php
Search.php
ServerDemoRouting.php
ServerEdit.php
ServerExportPdf.php
ServerGeostat.php
ServerHilight.php
ServerLayerReorder.php
ServerMapOverlay.php
ServerOgcLayerLoader.php
ServerOutline.php
ServerProjectGeotoolsRouting.php
ServerProjectPostgresRouting.php
ServerProjectRouting.php
ServerRouting.php
ServerSearch.php
ServerTestMainGeotoolsRouting.php
ServerTestMainPostgresRouting.php
ServerTestMainRouting.php
ToolTipsLayerBase.php
ToolTipsService.php

Classes:

Attribute
BasicOverlay
ByXyQueryableLayer
cFPDF
ClassOverlay
ClientAuth
ClientBboxHistory
ClientBboxHistoryState
ClientCheckInstall
ClientDemoRouting
ClientEdit
ClientExportCsv
ClientExportDxf
ClientExportHtml
ClientExportPdf
ClientFilterIdrecenter
ClientGeostat
ClientHello
ClientLayerReorder
ClientLocate
ClientMapOverlay
ClientOgcLayerLoader
ClientOutline
ClientProjectToolTips
ClientRouting
ClientSearch
ClientToolTips
ClientViews
ClientWmsBrowserLight
ColorOverlay
CwFpdf
DbResultProvider
DbSecurityContainer
DxfShape
Edge
EditRequest
EditResult
EditState
ExportPdfInit
ExportPdfState
FulltextTableResultProvider
GeostatChoropleth
GeostatClientState
GeostatInit
GeostatLayerParams
GeostatRequest
GeostatResult
IniSecurityContainer
JsonResponseFormatter
LabelOverlay
LayerOverlay
LayerReorderInit
LayerReorderRequest
LayerReorderResult
LayerReorderState
LayerResult
LayerTransparency
LdapSecurityContainer
MapOverlay
MetadataOverlay
Node
OgcLayerLoaderRequest
OgcLayerLoaderState
OutlineDefaultValue
OutlineInit
OutlineRequest
OutlineResult
OutlineState
OutlineV1ToV2
OutlineV2ToV3
OwsInfoHarwester
OwsInfoHarwesterOLL
Parameter
PdfBlock
PdfFormat
PdfGeneral
PdfLibLite
PdfWriter
PositionOverlay
PostgresGraph
PrintTools
ProxyAuthContainer
QueryableLayer
Radio_ptLayerResult
ResponseFormatter
ResultProvider
RoutingRequest
RoutingResult
RoutingState
SearchConfig
SearchParameter
SearchRequest
SearchResult
SearchUtils
ServerDemoRouting
ServerEdit
ServerExportPdf
ServerGeostat
ServerGeotoolsRouting
ServerHilight
ServerLayerReorder
ServerMapOverlay
ServerOgcLayerLoader
ServerOutline
ServerPostgresRouting
ServerProjectGeotoolsRouting
ServerProjectPostgresRouting
ServerProjectRouting
ServerRouting
ServerSearch
ServerTestMainGeotoolsRouting
ServerTestMainPostgresRouting
ServerTestMainRouting
SmartyResponseFormatter
SpaceManager
Step
StyledShape
StyleOverlay
TableElement
TableResultProvider
ToolTipsLayerBase
ToolTipsService
ToolTipsState
TwBin
TwBinHelper
TwClassification
TwClassificationHelper
TwColorRgb
TwColorRgbHelper
TwDistributionSummary
TwDistributionSummaryHelper
ViewsState
WmsBrowserLightState

Class: ResponseFormatter

Source Location: /plugins/search/client/ClientSearch.php

Class Overview

Formats a response in order to send it back to browser.

Author(s):

Variables

$plugin

Methods

Child classes:

SmartyResponseFormatter: Formats a response using a Smarty template

JsonResponseFormatter: Formats a response in JSON

Class Details

[line 29]
Formats a response in order to send it back to browser.

Allows to use several formats (i.e. Smarty, JSON, etc.) for one application.

Tags:

abstract:

[ Top ]

Class Variables

$plugin =

[line 34]

Tags:

var:	plugin
access:	protected

Type:

[ Top ]

Class Methods

constructor __construct [line 39]

ResponseFormatter __construct(
ClientSearch
$plugin)

Tags:

access:

public

Parameters:

$plugin

plugin

[ Top ]

method getFormatterFromConfig [line 55]

ResponseFormatter getFormatterFromConfig(
config
$config, mixed
$defaultValues, ClientSearch
$plugin)

Creates a ResponseFormatter from a config structure

Tags:

access:	public
static:

Parameters:

config

$config

structure

[ Top ]

method getResponse [line 48]

string getResponse(
SearchResult
$result)

Generates Ajax response from a search result

Tags:

access:	public
abstract:

Overridden in child classes as:

SmartyResponseFormatter::getResponse()

JsonResponseFormatter::getResponse(): JSON formatter not yet implemented

Parameters:

$result

[ Top ]

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