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

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

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:   ClientSearch


[ Top ]



Class Methods


constructor __construct [line 39]

ResponseFormatter __construct( ClientSearch $plugin)



Tags:

access:  public


Parameters:

ClientSearch   $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:

SearchResult   $result  

[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:23 +0200 by phpDocumentor 1.3.0RC3