IdentifyPlugin Class Reference

Inheritance diagram for IdentifyPlugin:

[legend]List of all members.

Public Member Functions
	IdentifyPlugin ($arrConfiguration, $objLayer)
&	factory ($strClass, $arrConfiguration, $objLayer=NULL)
	toHtml ()
	getAbout ()
Public Attributes
	$arrConfiguration = NULL
	$objLayer = NULL

---

Detailed Description

Base class for plug-ins to the map identify tool.

---

Constructor & Destructor Documentation

IdentifyPlugin::IdentifyPlugin (  $  arrConfiguration, $  objLayer )

Construct a new IdentifyPlugin object. Parameters: $arrConfiguration  Array containing the options from the parsed configuration file. $objLayer  is the PHP/Mapscript layer that the plug-in is working on. Returns: A new IdentifyPlugin object.

---

Member Function Documentation

& IdentifyPlugin::factory (  $  strClass, $  arrConfiguration, $  objLayer = NULL )

Parameters: $strClass  A string containing the class name of which an object should be instantiated. $arrConfiguration  Array containing the options from the parsed configuration file. $objLayer  is the PHP/Mapscript layer that the plug-in is working on. Returns: A reference to the instanciated object. Check whether the class/file should be included or not, since it appears as if include_once is pretty time consuming.

IdentifyPlugin::getAbout (   )

Return information about the plug-in. Returns: A localized string containing information about the plug-in. Reimplemented in ImageIdentifyPlugin.

IdentifyPlugin::toHtml (   )

Render the plug-in output as HTML. Returns: A string containing the HTML code to be included in the page. An empty string is returned in case there are problems. Reimplemented in ImageIdentifyPlugin.

---

Member Data Documentation

IdentifyPlugin::$arrConfiguration = NULL

An array containing the options from the parsed configuration file.

IdentifyPlugin::$objLayer = NULL

The PHP/Mapscript layer that the plug-in is working on.

---

The documentation for this class was generated from the following file:

• identifyplugin.php

---