Class org_geoprisma_widget_MapFishLayerTreeWidget

Description

Widget de type mapfishlayertree

  • author: Pascal Martin

Located in /org/geoprisma/widget/MapFishLayerTreeWidget.php (line 23)

org_geoprisma_ConfigElement
   |
   --org_geoprisma_widget_Widget
      |
      --org_geoprisma_widget_MapFishLayerTreeWidget
Class Constant Summary
 DOMAIN_KEY_LOOKUP_PATTERN = '#@([^@:]*):([^@:]*)@#'
 MAP_FISH_LAYER_TREE_WIDGET = 'mapfishlayertree'
Method Summary
void addLayerNodeFromPath (string &$pstrPath, org_geoprisma_resource_Resource &$pobjResource, string &$pstrServiceType, array &$pobjOptions)
array addLayerNodeFromPathArray (array &$pobjArrayPaths, array &$pobjArrayNodes, org_geoprisma_resource_Resource &$pobjResource, string &$pstrServiceType, array &$pobjOptions)
ArrayObject getDatastores ()
array &getNodes ()
array getResourceNames (array $pobjArrayNodes)
ArrayObject getResources ()
string getType ()
integer indexOfNodeByTextKey (array &$pobjArrayNodes, string $pstrTextKey)
void insertIntoXML ( &$pobjDomElementWidgets,  &$pobjDomDocument)
void removeLeaf (array &$pobjArrayNodes, string $pstrResourceName, string $pstrServiceType)
Variables
Methods
Constructor __construct (line 43)

Construit un instance de org_geoprisma_widget_MapWidget

  • access: public
org_geoprisma_widget_MapWidget __construct (array &$pobjArray)
  • array &$pobjArray: Config node

Redefinition of:
org_geoprisma_widget_Widget::__construct()
Construit un instance de org_geoprisma_widget_Widget
addLayerNodeFromPath (line 291)

Prepare and call to the 'addLayerNodeFromPathArray' method to set the options 'nodes' property with the new layer node added.

  • access: public
void addLayerNodeFromPath (string &$pstrPath, org_geoprisma_resource_Resource &$pobjResource, string &$pstrServiceType, array &$pobjOptions)
  • string &$pstrPath: The path in which to add the new layer node
  • org_geoprisma_resource_Resource &$pobjResource: Resource object
  • string &$pstrServiceType: Service type
  • array &$pobjOptions: Array of layer node options.
addLayerNodeFromPathArray (line 328)

Add a new layer node to the 'nodes' array OR browse nodes using the 'paths' array in order to add it to the according tree position. If a 'path' node doesn't exists, it creates it at the same time.

  • return: Nodes containing the new ones added.
  • access: public
array addLayerNodeFromPathArray (array &$pobjArrayPaths, array &$pobjArrayNodes, org_geoprisma_resource_Resource &$pobjResource, string &$pstrServiceType, array &$pobjOptions)
  • array &$pobjArrayPaths: Array of nodes in which to add the new layer node
  • array &$pobjArrayNodes: Array of nodes in which to push the a new node (leaf or container).
  • org_geoprisma_resource_Resource &$pobjResource: Resource object
  • string &$pstrServiceType: Service type
  • array &$pobjOptions: Array of layer node options.
getDatastores (line 241)

Retourne une liste d'information sur les datastores utilisé

  • return: of array('resourcename' => ?, 'datastorename' => ?, 'servicename' => ? )
  • access: public
ArrayObject getDatastores ()

Redefinition of:
org_geoprisma_widget_Widget::getDatastores()
Return datastores used by this widget. Needs to be overwritten in order to actually do something.
getNodes (line 471)

Returns a reference to the root nodes of the layertree inside the options.

  • access: public
array &getNodes ()
getResourceNames (line 253)

Return an array of resource name unique values from given "nodes" array.

  • access: public
array getResourceNames (array $pobjArrayNodes)
  • array $pobjArrayNodes: Array of node.
getResources (line 214)

Retourne une liste de nom de ressource utiliser par ce widget

  • return: of string
  • access: public
ArrayObject getResources ()

Redefinition of:
org_geoprisma_widget_Widget::getResources()
Return resources used by this widget. Needs to be overwritten in order to actually do something.
getType (line 167)

Retourne le type du widget

  • access: public
string getType ()

Redefinition of:
org_geoprisma_widget_Widget::getType()
Retourne le type du widget
indexOfNodeByTextKey (line 432)

Check if a node exists in an array of nodes using the 'textkey' property.

It may sometimes be defined as a 'domain' & 'key' array, so it takes care of that too.

If it does, returns the key of the node, else returns -1.

  • access: public
integer indexOfNodeByTextKey (array &$pobjArrayNodes, string $pstrTextKey)
  • array &$pobjArrayNodes: Array of nodes
  • string $pstrTextKey: TextKey value. Can also be an array with 'domain' and 'key' keys.
insertIntoXML (line 180)

Ajout le widget courant (this) dans le xml

  • access: public
void insertIntoXML ( &$pobjDomElementWidgets,  &$pobjDomDocument)
  • DOMElement &$pobjDomElementWidgets: Noeud xml ou le widget doit ĂȘtre ajouter
  • DOMDocument &$pobjDomDocument: Document XMl ou le noeud xml datastore est ajouter, utiliser pour construire les noeuds

Redefinition of:
org_geoprisma_widget_Widget::insertIntoXML()
Ajout le widget courant (this) dans le xml
removeLeaf (line 127)

Remove a specific leaf using its resourcename and servicetype values from given nodes. If the parent node becomes empty, it's removed as well.

  • access: public
void removeLeaf (array &$pobjArrayNodes, string $pstrResourceName, string $pstrServiceType)
  • array &$pobjArrayNodes: Array of nodes
  • string $pstrResourceName: The name of the resourcename of the node to remove
  • string $pstrServiceType: The servicetype of the node to remove

Inherited Methods

Inherited From org_geoprisma_widget_Widget

org_geoprisma_widget_Widget::__construct()
org_geoprisma_widget_Widget::addOrReplaceOption()
org_geoprisma_widget_Widget::addResource()
org_geoprisma_widget_Widget::getAction()
org_geoprisma_widget_Widget::getAllResourceOptionList()
org_geoprisma_widget_Widget::getDatastores()
org_geoprisma_widget_Widget::getDatastoresFromResources()
org_geoprisma_widget_Widget::getMandatoryResourceOptionList()
org_geoprisma_widget_Widget::getMandatoryResourceOptionValueList()
org_geoprisma_widget_Widget::getName()
org_geoprisma_widget_Widget::getOption()
org_geoprisma_widget_Widget::getOptionalResourceOptionList()
org_geoprisma_widget_Widget::getOptions()
org_geoprisma_widget_Widget::getOptionsFromResource()
org_geoprisma_widget_Widget::getProcessList()
org_geoprisma_widget_Widget::getResources()
org_geoprisma_widget_Widget::getServiceType()
org_geoprisma_widget_Widget::getType()
org_geoprisma_widget_Widget::getWidgetPath()
org_geoprisma_widget_Widget::insertIntoXML()
org_geoprisma_widget_Widget::linkResource()
org_geoprisma_widget_Widget::mustClone()
org_geoprisma_widget_Widget::needLayer()
org_geoprisma_widget_Widget::resourceHasRequiredWidgetOptions()
org_geoprisma_widget_Widget::setName()
org_geoprisma_widget_Widget::__clone()

Inherited From org_geoprisma_ConfigElement

org_geoprisma_ConfigElement::getConfigElements()
org_geoprisma_ConfigElement::getDomElements()
Class Constants
DOMAIN_KEY_LOOKUP_PATTERN = '#@([^@:]*):([^@:]*)@#' (line 29)
MAP_FISH_LAYER_TREE_WIDGET = 'mapfishlayertree' (line 25)
PATH_DELIMITER = '/' (line 27)

Documentation generated on Mon, 20 Feb 2012 13:46:24 -0500 by phpDocumentor 1.4.1