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

Class: QueryableLayer

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

Class Overview

ToolTipsLayerBase
   |
   --QueryableLayer



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

$db =  NULL

[line 48]

PEAR::DB connection object for queries



Tags:

access:  protected

Type:   PEAR::DB


[ Top ]

$dbTableName =

[line 42]

DB table name to query



Tags:

access:  protected

Type:   string


[ Top ]

$dsn =  NULL

[line 36]

DSN for DB connection; if null, connection will not be established



Tags:

access:  protected

Type:   string


[ Top ]

$encoderName =  'data'

[line 54]

Name of the cartoweb encoder to use



Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


constructor __construct [line 59]

QueryableLayer __construct( )

Constructor



Tags:

access:  public


Overridden in child classes as:

ByXyQueryableLayer::__construct()
Constructor

Overrides ToolTipsLayerBase::__construct() (Constructor)

[ Top ]

method filterResults [line 153]

array filterResults( array $layerResults)

This is a hook to let child classes modify the LayerResult array before it is added to the layer results to be rendered.



Tags:

return:  array of LayerResult
access:  public


Parameters:

array   $layerResults   array of LayerResult

[ Top ]

method getDb [line 87]

PEAR::DB getDb( )



Tags:

access:  public


[ Top ]

method getDsn [line 72]

string getDsn( )

Returns DSN.



Tags:

access:  public


[ Top ]

method getEncoderName [line 134]

string getEncoderName( )

Returns the encoder name



Tags:

access:  public


[ Top ]

method getReturnedAttributes [line 118]

string getReturnedAttributes( )

Gets the list of attributes to be returned for the current layer.



Tags:

access:  protected


[ Top ]

method newLayerResult [line 143]

LayerResult newLayerResult( )

This method is to be redefined to use a custom (extended)

ResultLayer object




Tags:

access:  protected


[ Top ]

method setDb [line 80]

void setDb( PEAR::DB $db)

Sets the PEAR::DB object for queries.



Tags:

access:  public


Parameters:

PEAR::DB   $db   PEAR::DB connection

[ Top ]

method setDbTableName [line 102]

void setDbTableName( string $dbTableName)

Sets DB table name.



Tags:

access:  public


Parameters:

string   $dbTableName  

[ Top ]

method setDsn [line 64]

void setDsn( mixed $dsn)

Sets DSN.



Tags:

access:  public


[ Top ]

method setEncoderName [line 126]

void setEncoderName( string $encoderName)

Sets the encoder name



Tags:

access:  public


Parameters:

string   $encoderName  

[ Top ]

method setReturnedAttributes [line 110]

void setReturnedAttributes( string $attributes)

Stores the list of attributes to be returned (DB field names)



Tags:

access:  public


Parameters:

string   $attributes  

[ Top ]


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