phpDocumentor epesi-utils
tooltip
[ class tree: epesi-utils ] [ index: epesi-utils ] [ all elements ]

Class: Utils_TooltipCommon

Source Location: /modules/Utils/Tooltip/TooltipCommon_0.php

Class Utils_TooltipCommon

Class Overview

Located in /modules/Utils/Tooltip/TooltipCommon_0.php [line 12]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Utils_TooltipCommon
Author(s): Information Tags:
Version:  1.0
Copyright:  Copyright © 2006, Telaxus LLC
License:  MIT

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()
Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()
ModulePrimitive::check_access()
Checks access to function which name is passed as first parameter.
ModulePrimitive::create_data_dir()
Creates default data directory for module. Typical usage: in module installation
ModulePrimitive::get_data_dir()
Returns path to the default data directory for module calling this method.
ModulePrimitive::get_module_dir()
Returns path to the module directory.
ModulePrimitive::get_type()
Returns name(type) of module that called this function.
ModulePrimitive::get_type_with_bt()
ModulePrimitive::remove_data_dir()
Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()
ModuleAcl::add_aco()
ModuleAcl::del_aco()
ModuleAcl::get_type()

[ Top ]
Method Summary
static void   format_info_tooltip()   Returns a 2-column formatted table
static string   open_tag_attrs()   Returns string that when placed as tag attribute will enable tooltip when placing mouse over that element.
static void   user_settings()  
string   create()   Returns string that if displayed will create text with tooltip.

[ Top ]
Methods
static method format_info_tooltip  [line 84]

  static void format_info_tooltip( array $arg, [ $group = null]  )

Returns a 2-column formatted table

Parameters:
array   $arg:  keys are captions, values are values
   $group: 

API Tags:
Access:  public


[ Top ]
static method open_tag_attrs  [line 34]

  static string open_tag_attrs( string $tip, [boolean $help = true]  )

Returns string that when placed as tag attribute will enable tooltip when placing mouse over that element.

Parameters:
string   $tip:  tooltip text
boolean   $help:  help tooltip? (you can turn off help tooltips)

API Tags:
Return:  HTML tag attributes
Access:  public


[ Top ]
static method user_settings  [line 13]

  static void user_settings( )


API Tags:
Access:  public


[ Top ]
create  [line 71]

  string create( string $text, string $tip, [boolean $help = true]  )

Returns string that if displayed will create text with tooltip.

Parameters:
string   $text:  text
string   $tip:  tooltip text
boolean   $help:  help tooltip? (you can turn off help tooltips)

API Tags:
Return:  text with tooltip
Access:  public


[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:47:10 -0500 by phpDocumentor 1.4.2