Class: Base_UserInstall

Source Location: /modules/Base/User/UserInstall.php

Class Base_UserInstall

Class Overview

UserInstall class.

This class provides initialization data for User module.

Located in /modules/Base/User/UserInstall.php [line 16]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleInstall
         |
         --Base_UserInstall

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 ModuleInstall

ModuleInstall::install()

Module installation function.

ModuleInstall::requires()

Returns array that contains information about modules required by this module.

ModuleInstall::uninstall()

Module uninstallation function.

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

void	backup()
void	install()
void	requires()
void	uninstall()
void	version()

[ Top ]

Methods

backup [line 39]

void backup(

$v 
)

Parameters:

$v:

API Tags:

Access:

public

[ Top ]

install [line 17]

void install(
)

API Tags:

Access:

public

Redefinition of:

ModuleInstall::install(): Module installation function.

[ Top ]

requires [line 34]

void requires(

$v 
)

Parameters:

$v:

API Tags:

Access:

public

Redefinition of:

ModuleInstall::requires(): Returns array that contains information about modules required by this module.

[ Top ]

uninstall [line 26]

void uninstall(
)

API Tags:

Access:

public

Redefinition of:

ModuleInstall::uninstall(): Module uninstallation function.

[ Top ]

version [line 30]

void version(
)

API Tags:

Access:

public

[ Top ]

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

	epesi-base user

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