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

Class: LayerResult

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

Class Overview

ToolTipsLayerBase
   |
   --LayerResult



Variables

Methods


Child classes:

Inherited Variables

Inherited Methods

Class: ToolTipsLayerBase

ToolTipsLayerBase::__construct()
Constructor
ToolTipsLayerBase::getId()
Gets id.
ToolTipsLayerBase::getLabel()
Returns label. If not defined, returns id.
ToolTipsLayerBase::getTemplate()
Returns the filename of the template used for current layer.
ToolTipsLayerBase::setId()
Sets id of the layer.
ToolTipsLayerBase::setLabel()
Sets label of the layer.
ToolTipsLayerBase::setTemplate()
Sets the template file to use for current layer.

Class Details

[line 30]


[ Top ]


Class Variables

$decoderName =  'output'

[line 43]



Tags:

access:  protected

Type:   mixed


[ Top ]

$encoderName =  'data'

[line 42]

Name of the cartoweb encoder to use



Tags:

access:  protected

Type:   string


[ Top ]

$resultHtml =

[line 36]

HTML code rendering the result



Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


constructor __construct [line 48]

LayerResult __construct( [mixed $encoderName = NULL])

Constructor



Tags:

access:  public


Overrides ToolTipsLayerBase::__construct() (Constructor)

[ Top ]

method addAttribute [line 59]

void addAttribute( string $name, string $value)

Adds attribute to the layer result



Tags:

access:  public


Parameters:

string   $name   name of the attribute
string   $value   value of the attribute

[ Top ]

method addAttributes [line 67]

void addAttributes( array $associativeArray)

Adds attributes to the layer result



Tags:

access:  public


Parameters:

array   $associativeArray   associative array (keys => values)

[ Top ]

method decode [line 147]

mixed decode( mixed $content)

Decodes the given content



Tags:

return:  Encoded string or array of string
access:  protected


Parameters:

mixed   $content   String or array of string to encode

[ Top ]

method encode [line 138]

mixed encode( mixed $content)

Encodes the given content



Tags:

return:  Encoded string or array of string
access:  protected


Parameters:

mixed   $content   String or array of string to encode

[ Top ]

method getAttribute [line 77]

void getAttribute( string $name)

Returns attribute value with given name



Tags:

access:  public


Parameters:

string   $name   name of the attribute

[ Top ]

method getAttributes [line 86]

array getAttributes( )

Return a key => value attribute array



Tags:

return:  array of attributes (key => value)
access:  public


[ Top ]

method getEncoderName [line 102]

string getEncoderName( )

Returns the encoder name



Tags:

access:  public


[ Top ]

method getResultHtml [line 117]

void getResultHtml( )

Returns result html code



Tags:

access:  public


[ Top ]

method renderResult [line 126]

string renderResult( LayerResult $smarty)

Renders the attributes list as HTML



Tags:

return:  HTML code
access:  public


Overridden in child classes as:

Radio_ptLayerResult::renderResult()

Parameters:

LayerResult   $smarty  

[ Top ]

method setEncoderName [line 94]

void setEncoderName( string $encoderName)

Sets the encoder name



Tags:

access:  public


Parameters:

string   $encoderName  

[ Top ]

method setResultHtml [line 110]

void setResultHtml( string $htmlCode)

Sets result html code with given html code



Tags:

access:  public


Parameters:

string   $htmlCode   html code

[ Top ]


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