Class: ByIdQueryableLayer

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

Class Overview

QueryableLayer
   |
   --ByIdQueryableLayer

QueryableLayer classes for toolTips plugin Extensible classes to build a tooltip layer definition

Author(s):

Version:

$Id: QueryableLayer.php,v 1.1 2006/08/25 15:49:43 pgiraud Exp $

Copyright:

2005 Camptocamp SA

Inherited Variables

Class: QueryableLayer

QueryableLayer::$db
QueryableLayer::$dbTableName
QueryableLayer::$dsn
QueryableLayer::$id
QueryableLayer::$label
QueryableLayer::$returnedAttributes
QueryableLayer::$template

Inherited Methods

Class: QueryableLayer

QueryableLayer::__construct(): Constructor
QueryableLayer::addReturnedAttribute()
QueryableLayer::checkDbTableName(): Checks if db table name is set
QueryableLayer::checkDsn(): Checks if a dsn is set
QueryableLayer::checkId(): Checks if id is set
QueryableLayer::checkReturnedAttributes()
QueryableLayer::filterResults(): This is a hook to let child classes modify the LayerResult array
QueryableLayer::getAttributesList(): Returns a coma separated list of attributes
QueryableLayer::getCustomTemplate()
QueryableLayer::getDb()
QueryableLayer::getDsn(): Returns dsn
QueryableLayer::getId(): Gets id
QueryableLayer::getLabel(): Gets label
QueryableLayer::newLayerResult(): This method is to be redefined to use a custom (extended)
QueryableLayer::setCustomTemplate(): Sets the PEAR::DB object for queries
QueryableLayer::setDb(): Sets the PEAR::DB object for queries
QueryableLayer::setDbTableName(): Sets db table name
QueryableLayer::setDsn(): Sets dsn
QueryableLayer::setId(): Sets the id of the layer
QueryableLayer::setLabel(): Sets the label of the layer

Class Details

[line 388]
QueryableLayer classes for toolTips plugin Extensible classes to build a tooltip layer definition

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Tags:

copyright:	2005 Camptocamp SA
version:	$Id: QueryableLayer.php,v 1.1 2006/08/25 15:49:43 pgiraud Exp $

[ Top ]

Class Variables

$idAttribute = NULL

[line 394]

Layer id attribute

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

constructor __construct [line 396]

ByIdQueryableLayer __construct(
)

Tags:

access:

public

Overrides QueryableLayer::__construct() (Constructor)

[ Top ]

method getIdSqlQuery [line 413]

string getIdSqlQuery(
string
$id)

This method is able to query attributes on a single table only; if you want to perform a more complex query, this method is to be redefined in a child class.

Tags:

return:	an SQL query
access:	protected

Parameters:

string

$id

id of the feature

[ Top ]

method queryLayerById [line 445]

array queryLayerById(
QueryableLayer
$id, float
1, float
2, Dimension
3, Bbox
4)

Returns the attributes to be returned specified in the given

QueryableLayer

Tags:

return:	array of LayerResult
access:	public

Parameters:

float	1	geographic x coordinate for spatial condition
float	2	geographic y coordinate for spatial condition
Dimension	3	mainmap dimensions (width, height)
Bbox	4	current mainmap extent
QueryableLayer	$id	layer to query

[ Top ]

method setIdAttribute [line 402]

void setIdAttribute(
string
$idAttribute)

Sets the id attribute of the layer

Tags:

access:

public

Parameters:

string

$idAttribute

id attribute of the layer

[ Top ]

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