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

Class: Utils_BookmarkBrowser

Source Location: /modules/Utils/BookmarkBrowser/BookmarkBrowser_0.php

Class Utils_BookmarkBrowser

Class Overview

Utils_BookmarkBrowser.

Module for displaying large amounts of data in one table with navigation between specified data groups.

Located in /modules/Utils/BookmarkBrowser/BookmarkBrowser_0.php [line 14]

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

Properties

Methods

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

Inherited From Module

Module::$children
Module::$display_func
Module::$parent

Inherited From Module

Module::__construct()
Constructor. Should not be called directly using new Module('name').
Module::call_callback_href()
Module::clear_module_variables()
Unset all module variables.
Module::create_back_href()
Creates link that will lead back to previous page content.
Module::create_back_href_js()
Module::create_callback_href()
Creates link similar to link created with create_href.
Module::create_callback_href_js()
Creates link similar to link created with create_href.
Module::create_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_callback_href_with_id_js()
Creates link similar to links created with create_href.
Module::create_confirm_callback_href()
Creates link similar to link created with create_href.
Module::create_confirm_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_confirm_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_confirm_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_href_js()
Create onClick action string destined for js code.
Module::create_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_unique_href_js()
Create onClick action string destined for js code.
Module::create_unique_key()
Returns unique key name, generated from unique name of this module (function get_path) and string parameter.
Module::displayed()
Returns whether this module instance was already displayed.
Module::display_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::freeze_module()
Makes child module to not loose its module variables
Module::get_child()
Gets child module with specified node id.
Module::get_children()
Gets array of children modules.
Module::get_html_of_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::get_instance_id()
Returns id of module instance.
Module::get_jses()
Returns list of jses to evaluate.
Module::get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as second parameter.
Module::get_module_variable_or_unique_href_variable()
Returns href variable.
Module::get_node_id()
Get node identifier.
Module::get_parent_path()
Returns unique path of parent module.
Module::get_parent_type()
Returns name(type) of parent module.
Module::get_path()
Returns unique path of calling module.
Module::get_reload()
Returns current reload settings.
Module::get_unique_href_variable()
Returns variable passed with create_unique_href.
Module::init_module()
Creates module instance which name is given as first parameter.
Module::isset_module_variable()
Checks if variable exists.
Module::isset_unique_href_variable()
Checks if variable given as first parameter was passed with create_unique_href function.
Module::is_back()
Checks if set_back_location was used.
Module::is_fast_process()
Returns whether this module instance has fast processing turned on.
Module::is_inline_display()
Returns whether this module instance is displayed inline.
Module::js()
Appends js code to list of jses to evaluate.
Module::mark_displayed()
Marks this module instance as it was displayed.
Module::pack_module()
Creates instance of module given as first parameter as a child of the module that has called this function.
Module::register_method()
Module::set_back_location()
Sets reload location to previous page display.
Module::set_fast_process()
Enable fast processing for this module instance.
Module::set_inline_display()
Changes display behavior for this module instance to inline.
Module::set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::set_reload()
Mark module to force its reload or prevent being reloaded.
Module::share_module_variable()
Share variable passed as first parameter with module passed as second parameter.
Module::share_unique_href_variable()
Share href variable passed as first parameter with module passed as second parameter.
Module::static_get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as third parameter.
Module::static_isset_module_variable()
Checks if variable exists.
Module::static_set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::static_unset_module_variable()
Module::unset_module_variable()
Unset module variable.
Module::unset_unique_href_variable()
Unsets *unique_href variable.
Module::__call()

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 ]
Property Summary
static mixed   $bmk_counter  

[ Top ]
Method Summary
void   add_item()   Adds an entry to the browser at given section.
void   body()   Displays bookmark browser.
void   construct()  
void   expand()   Expands bookmark browser to the bottom line of the page.
void   sortAll()   Sorts both sections and entries with natural sort.
void   sortSections()   Sorts sections with natural sort.

[ Top ]
Properties
static mixed   $bmk_counter = 0 [line 18]
API Tags:
Access:  public


[ Top ]
Methods
add_item  [line 45]

  void add_item( string $sec, string $cnt, [string $title = null]  )

Adds an entry to the browser at given section.

The key may determine order of elements.

Parameters:
string   $sec:  section id
string   $cnt:  text that will be displayed
string   $title:  bookmark key, number will be assigned by default

API Tags:
Access:  public


[ Top ]
body  [line 87]

  void body( )

Displays bookmark browser.


API Tags:
Access:  public


[ Top ]
construct  [line 20]

  void construct( )


API Tags:
Access:  public


[ Top ]
expand  [line 79]

  void expand( )

Expands bookmark browser to the bottom line of the page.


API Tags:
Access:  public


[ Top ]
sortAll  [line 66]

  void sortAll( [bool $items_by_key = false]  )

Sorts both sections and entries with natural sort.

Parameters:
bool   $items_by_key:  weather to sort by values or keys (default is by value)

API Tags:
Access:  public


[ Top ]
sortSections  [line 57]

  void sortSections( )

Sorts sections with natural sort.


API Tags:
Access:  public


[ Top ]

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