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

Class: ModuleInstall

Source Location: /include/module_install.php

Class ModuleInstall

Class Overview

This class provides interface for module install.

Located in /include/module_install.php [line 19]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleInstall
Author(s): API Tags:
Abstract:  

Information Tags:
Version:  1.0
Copyright:  Copyright © 2006, Telaxus LLC

Methods

[ Top ]
Descendants
Child Class Description
Applets_BirthdaysInstall
Applets_CalcInstall
Applets_ClockInstall Flash clock (clock taken from http://www.kirupa.com/developer/actionscript/clock.htm)
Applets_GoogleInstall
Applets_GTalkInstall
Applets_HostInstall Gets host ip or domain
Applets_MonthViewInstall
Applets_NoteInstall
Applets_RssFeedInstall Simple RSS Feed applet
Apps_ForumInstall
Apps_GalleryInstall
Apps_MailClientInstall Simple mail client
Apps_ShoutboxInstall
Apps_StaticPageInstall
Apps_TimetrackInstall
Apps_TwisterGameInstall
Base_AboutInstall About Epesi
Base_AclInstall AclInit class.
Base_ActionBarInstall ActionBar
Base_AdminInstall Admin class.
Base_BackupInstall This class provides initialization data for Backup module.
BaseInstall BaseInstall class.
Base_BoxInstall BoxInit class.
Base_DashboardInstall Something like igoogle
Base_ErrorInstall Provides error to mail handling.
Base_HomePageInstall HomePageInit class.
Base_Lang_AdministratorInstall Lang_AdministratorInstall class.
Base_LangInstall LangInstall class.
Base_Mail_ContactUsInstall Mail_ContactUsInstall class.
Base_MailInstall MailInstall class.
Base_MainModuleIndicatorInstall MainModuleIndicatorInstall class.
Base_MaintenanceMode_AdministratorInstall MaintenanceMode_AdministratorInstall class.
Base_MaintenanceModeInstall MaintenanceModeInstall class.
Base_MenuInstall MenuInstall class.
Base_Menu_QuickAccessInstall QuickAccessInstall class.
Base_ModuleManagerInstall
Base_NavigationInstall Navigation component: back, refresh, forward.
Base_RegionalSettingsInstall Regional settings like currency, time...
Base_SearchInstall SearchInstall class.
Base_SetupInstall Setup initial class
Base_StatusBarInstall Fancy statusbar.
Base_Theme_AdministratorInstall Theme_AdministratorInstall class.
Base_ThemeInstall TestInstall class.
Base_User_AdministratorInstall User_AdministratorInstall class.
Base_User_LoginInstall LoginInstall class.
Base_User_SettingsInstall User_Settings class.
Base_UserInstall UserInstall class.
CRM_AclInstall
CRM_CalendarInstall
CRM_Calendar_EventInstall Example event module
CRM_Calendar_ReportsInstall Simple reports for CRM Calendar
CRM_CommonInstall common data used by CRM modules
CRM_Contacts_ActivitiesInstall Activities history for Company and Contacts
CRM_ContactsInstall CRM Contacts class.
CRM_FiltersInstall
CRM_FollowupInstall
CRM_ImportInstall Import data from csv file
CRM_LoginAuditInstall Provides login audit log
CRM_MailClientInstall Apps/MailClient and other CRM functions connector
CRM_PhoneCallInstall CRM Phone Call Class
CRM_TasksInstall
CRM_WhoIsOnlineInstall Shows who is logged to epesi.
Custom_TasksModifiedInstall Example Tasks modifications
Data_CountriesInstall
Develop_ModuleCreatorInstall
Develop_ModuleEditorInstall Epesi developer editor
Develop_TableBrowserCreatorInstall
FirstRunInstall
Tests_AttachmentInstall
Tests_BookmarkBrowserInstall
Tests_BugtrackInstall Software Development - Bug Tracking
Tests_CalendarInstall
Tests_Calendar_EventInstall Example event module
Tests_Callbacks_aInstall
Tests_CallbacksInstall Example event module
Tests_CodepressInstall Example event module
Tests_ColorpickerInstall
Tests_CommentInstall
Tests_FPDFInstall
Tests_GenericBrowserInstall
Tests_ImageInstall
Tests_LangInstall
Tests_LeightboxInstall
Tests_LyteboxInstall
Tests_MenuInstall
Tests_OpenFlashChartInstall Testing flash charts
Tests_QuickFormInstall
Tests_ReportInstall
Tests_SearchInstall
Tests_SharedUniqueHref_aInstall
Tests_SharedUniqueHrefInstall
Tests_TabbedBrowserInstall
TestsInstall TestsInstall class.
Tests_TooltipInstall
Tests_WizardInstall
Tools_FontSizeInstall Tools_FontSize class.
Tools_SessionKeeperInstall Keeps epesi user logged in.
Tools_SetDefaultsInstall
Tools_WhoIsOnlineInstall Shows who is logged to epesi.
Utils_Attachment_AdministratorInstall
Utils_AttachmentInstall Use this module if you want to add attachments to some page.
Utils_BBCodeInstall
Utils_BookmarkBrowserInstall
Utils_CalendarInstall
Utils_Calendar_EventInstall This class provides interface for module install.
Utils_CatFileInstall CatFileInstall class.
Utils_ChainedSelectInstall
Utils_CommentInstall
Utils_CommonDataInstall
Utils_CurrencyFieldInstall
Utils_CustomMenuInstall
Utils_DirtyReadInstall DirtyReadInstall class.
Utils_ExportXLSInstall
Utils_FileDownloadInstall
Utils_FileUploadInstall Uploads file
Utils_GalleryInstall
Utils_GenericBrowserInstall
Utils_ImageInstall Utils_ImageInstall class.
Utils_LeightboxPromptInstall
Utils_MenuInstall
Utils_MessengerInstall Popup message to the user
Utils_PathInstall
Utils_PopupCalendarInstall
Utils_RecordBrowserInstall RecordBrowser install class.
Utils_RecordBrowser_RecordPickerInstall
Utils_RecordBrowser_ReportsInstall
Utils_ShortcutInstall
Utils_TabbedBrowserInstall TabbedBrowserInstall class.
Utils_TooltipInstall
Utils_TreeInstall
Utils_WatchdogInstall
Utils_WizardInstall WizardInstall class.

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

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
true   install()   Module installation function.
array   requires()   Returns array that contains information about modules required by this module.
true   uninstall()   Module uninstallation function.

[ Top ]
Methods
install  [line 25]

  true install( )

Module installation function.


API Tags:
Return:  if installation success, false otherwise
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]
requires  [line 39]

  array requires( $v  )

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

The array should be determined by the version number that is given as parameter.

Parameters:
   $v: 

API Tags:
Return:  Array constructed as following: array(array('name'=>$ModuleName,'version'=>$ModuleVersion),...)
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]
uninstall  [line 31]

  true uninstall( )

Module uninstallation function.


API Tags:
Return:  if installation success, false otherwise
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]

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