CorePlugins

# Class: LayerResult Source Location: /plugins/toolTips/client/LayerResult.php
### Class Overview
Layer Result builder for ToolTips plugin Extensible class to build a layer result for one feature #### Author(s): #### Version: $Id: LayerResult.php,v 1.1 2006/08/25 15:49:43 pgiraud Exp $ #### Copyright: 2005 Camptocamp SA | ### Variables $id $label $resultHtml $returnedAttributes $template | ### Methods __construct addAttribute addAttributes getAttribute getAttributes getCustomTemplate getId getLabel getResultHtml renderResult setCustomTemplate setId setLabel setResultHtml
### Class Details [line 25] Layer Result builder for ToolTips plugin Extensible class to build a layer result for one feature 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:
version: | $Id: LayerResult.php,v 1.1 2006/08/25 15:49:43 pgiraud Exp $
copyright: | 2005 Camptocamp SA
[ Top ] ### Class Variables #### $id = [line 31] Layer Id #### Tags:
access: | protected
Type: | string
[ Top ] #### $label = [line 37] Layer label #### Tags:
access: | protected
Type: | string
[ Top ] #### $resultHtml = [line 55] Html code representing the result #### Tags:
access: | protected
Type: | string
[ Top ] #### $returnedAttributes = array() [line 49] Returned attributes and their value #### Tags:
var: | of key => value array representing attributes values
access: | protected
Type: | array
[ Top ] #### $template = [line 43] Layer custom template #### Tags:
access: | protected
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 60]
`LayerResult __construct( )`
Constructor #### Tags:
access: | public
[ Top ] ### method addAttribute [line 110]
`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 118]
`void addAttributes( array $associativeArray)`
Adds attributes to the layer result #### Tags:
access: | public
#### Parameters:
array | $associativeArray | associative array (keys => values)
[ Top ] ### method getAttribute [line 128]
`void getAttribute( string $name)`
Returns attribute value with given name #### Tags:
access: | public
#### Parameters:
string | $name | name of the attribute
[ Top ] ### method getAttributes [line 137]
`array getAttributes( )`
Return a key => value attribute array #### Tags:
return: | array of attributes (key => value)
access: | public
[ Top ] ### method getCustomTemplate [line 101]
`void getCustomTemplate( )`
Returns custom template name #### Tags:
access: | public
[ Top ] ### method getId [line 72]
`void getId( )`
Gets id #### Tags:
access: | public
[ Top ] ### method getLabel [line 87]
`void getLabel( )`
Returns label If not defined returns id #### Tags:
access: | public
[ Top ] ### method getResultHtml [line 152]
`void getResultHtml( )`
Returns result html code #### Tags:
access: | public
[ Top ] ### method renderResult [line 161]
`string renderResult( LayerResult $smarty)`
Renders the attributes list as HTML #### Tags:
return: | HTML code
access: | public
#### Parameters:
LayerResult | $smarty |
[ Top ] ### method setCustomTemplate [line 94]
`void setCustomTemplate( mixed $template)`
Set layer custom template #### Tags:
access: | public
[ Top ] ### method setId [line 65]
`void setId( mixed $id)`
Sets id #### Tags:
access: | public
[ Top ] ### method setLabel [line 79]
`void setLabel( mixed $label)`
Sets label #### Tags:
access: | public
[ Top ] ### method setResultHtml [line 145]
`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, 28 Sep 2006 13:32:19 +0200 by phpDocumentor 1.3.0RC3