Client
[ class tree: Client ] [ index: Client ] [ all elements ]

Class: ToolProviderHelper

Source Location: /client/ClientPluginHelper.php

Class Overview

ClientPluginHelper
   |
   --ToolProviderHelper

Helper for ToolProvider


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 53]
Helper for ToolProvider



Tags:

author:  Yves Bolognini <yves.bolognini@camptocamp.com>


[ Top ]


Class Methods


method convertName [line 60]

string convertName( string $name)

Converts a name one_toto_two ==> OneTotoTwo



Tags:

return:  converted name
access:  private


Parameters:

string   $name   input name

[ Top ]

method getToolsHelper [line 106]

array getToolsHelper( ClientPlugin $plugin)

Calls plugin's ToolProvider::getTools(), updates tools

and returns them




Tags:

return:  array of ToolDescription
access:  public


Parameters:

ClientPlugin   $plugin   plugin

[ Top ]

method updateTool [line 75]

ToolDescription updateTool( ClientPlugin $plugin, ToolDescription $tool)

Updates tools info plugin name and weight

Weight is read in plugin configuration file. Example: id = my_tool, variable in configuration file = weightMyTool.




Tags:

return:  updated tool
access:  private


Parameters:

ClientPlugin   $plugin   plugin
ToolDescription   $tool   tool to update

[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:21 +0200 by phpDocumentor 1.3.0RC3