Class: ModulePrimitive

Source Location: /include/module_primitive.php

Class ModulePrimitive

Class Overview

Located in /include/module_primitive.php [line 11]

ModuleAcl
   |
   --ModulePrimitive

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

API Tags:

Abstract:

Information Tags:

Version:	1.0
Copyright:	Copyright © 2006, Telaxus LLC
License:	SPL

Methods

[ Top ]

Descendants

Child Class	Description
Module	This class provides some basic functionality for every epesi module.
ModuleCommon	This class provides interface for module common.
ModuleInstall	This class provides interface for module install.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

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

[ Top ]

Methods

static method get_type_with_bt [line 81]

static void get_type_with_bt(
[
$i = 0] 
)

Parameters:

$i:

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 14]

ModulePrimitive __construct(

$type 
)

Parameters:

$type:

API Tags:

Access:

public

Redefined in descendants as:

Module::__construct() : Constructor. Should not be called directly using new Module('name').

[ Top ]

check_access [line 77]

bool check_access(
string
$m 
)

Checks access to function which name is passed as first parameter.

If you want to restric access to a function just make function named 'functionname_access' returning false if user should not access this function.

This function is called automatically with each pack_module call.

Parameters:

string

$m:

function name

API Tags:

Return:	true if access is granted, false otherwise
Access:	public

[ Top ]

create_data_dir [line 52]

bool create_data_dir(
string
0 
)

Creates default data directory for module. Typical usage: in module installation

Parameters:

string

module name

API Tags:

Return:	true if directory was created or already exists, false otherwise
Access:	public

[ Top ]

get_data_dir [line 33]

string get_data_dir(
)

Returns path to the default data directory for module calling this method.

Use this directory if your module requires to create or operate on a file.

API Tags:

Return:	path to the data directory
Access:	public

[ Top ]

get_module_dir [line 42]

string get_module_dir(
)

Returns path to the module directory.

API Tags:

Return:	path to the module directory
Access:	public

[ Top ]

get_type [line 23]

string get_type(
)

Returns name(type) of module that called this function.

API Tags:

Access:

public

Redefinition of:

ModuleAcl::get_type()

[ Top ]

remove_data_dir [line 62]

bool remove_data_dir(
string
0 
)

Removes default data directory of a module. Typical usage: in module uninstallation

Parameters:

string

module name

API Tags:

Return:	true if directory was created or already exists, false otherwise
Access:	public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:44:27 -0500 by phpDocumentor 1.4.2

	epesi-base

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