Class: Base_BoxCommon

Source Location: /modules/Base/Box/BoxCommon_0.php

Class Base_BoxCommon

Class Overview

Box class.

This class provides basic container for other modules, with smarty as template engine.

Located in /modules/Base/Box/BoxCommon_0.php [line 16]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_BoxCommon

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2008, 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	create_href()
static void	create_href_array()
static void	create_href_js()
static void	get_main_module_name()
static void	location()

[ Top ]

Methods

static method create_href [line 46]

static void create_href(

$parent_module, 
$module, [
$function = null], [
$arguments = null], [
$constructor_args = null], [
$other_href_args = array()] 
)

Parameters:

	$parent_module:
	$module:
	$function:
array	$arguments:
array	$constructor_args:
array	$other_href_args:

API Tags:

Access:

public

[ Top ]

static method create_href_array [line 27]

static void create_href_array(

$parent_module, 
$module, [
$function = null], [
$arguments = null], [
$constructor_args = null] 
)

Parameters:

	$parent_module:
	$module:
	$function:
array	$arguments:
array	$constructor_args:

API Tags:

Access:

public

[ Top ]

static method create_href_js [line 50]

static void create_href_js(

$parent_module, 
$module, [
$function = null], [
$arguments = null], [
$constructor_args = null], [
$other_href_args = array()] 
)

Parameters:

	$parent_module:
	$module:
	$function:
array	$arguments:
array	$constructor_args:
array	$other_href_args:

API Tags:

Access:

public

[ Top ]

static method get_main_module_name [line 17]

static void get_main_module_name(
)

API Tags:

Access:

public

[ Top ]

static method location [line 54]

static void location(

$module, [
$function = null], [
$arguments = null], [
$constructor_args = null], [
$other_href_args = array()] 
)

Parameters:

	$module:
	$function:
array	$arguments:
array	$constructor_args:
array	$other_href_args:

API Tags:

Access:

public

[ Top ]

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

	epesi-base backup

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]