Plugins

# Class: ByIdQueryableLayer Source Location: /plugins/toolTips/client/QueryableLayer.php
### Class Overview
    ToolTipsLayerBase
       |
       --QueryableLayer
          |
          --ByIdQueryableLayer
| ### Variables $idAttribute | ### Methods __construct getIdSqlQuery queryLayerById setIdAttribute
### Inherited Variables #### Class: QueryableLayer QueryableLayer::$db QueryableLayer::$dbTableName QueryableLayer::$dsn #### Class: ToolTipsLayerBase ToolTipsLayerBase::$id ToolTipsLayerBase::$label ToolTipsLayerBase::$returnedAttributes ToolTipsLayerBase::$template | ### Inherited Methods #### Class: QueryableLayer QueryableLayer::__construct() Constructor QueryableLayer::filterResults() This is a hook to let child classes modify the LayerResult array before it is added to the layer results to be rendered. QueryableLayer::getDb() QueryableLayer::getDsn() Returns DSN. QueryableLayer::getReturnedAttributes() Gets the list of attributes to be returned for the current layer. QueryableLayer::newLayerResult() This method is to be redefined to use a custom (extended) QueryableLayer::setDb() Sets the PEAR::DB object for queries. QueryableLayer::setDbTableName() Sets DB table name. QueryableLayer::setDsn() Sets DSN. QueryableLayer::setReturnedAttributes() Stores the list of attributes to be returned (DB field names) #### 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 273] [ Top ] ### Class Variables #### $idAttribute = NULL [line 279] Layer id attribute #### Tags:
access: | protected
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 284]
`ByIdQueryableLayer __construct( )`
Constructor #### Tags:
access: | public
Overrides QueryableLayer::__construct() (Constructor) [ Top ] ### method getIdSqlQuery [line 301]
`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 321]
`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 290]
`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 Fri, 25 May 2007 13:31:52 +0200 by phpDocumentor 1.3.0RC3