Class class_installer_base

Description
Description | Descendents | Vars | Methods (details)

Base class for all installers. Provides some needed function to avoid multiple implementations

  • abstract:

Located in /system/class_installer_base.php (line 17) 

class_root
   |
   --class_installer_base
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
class_installer_downloads Installer to install the downloads-module
class_installer_element_basedownloads Installer to install the downloads-module
class_installer_element_baseregistration Installer to install a login-element to use in the portal
class_installer_element_basetophitlist Installer to install a basetophitlist-element to use in the portal
class_installer_element_basetopratelist Installer to install a basetopratelist-element to use in the portal
class_installer_element_baseupload Installer to install a login-element to use in the portal
class_installer_element_downloads_toplist Installer to install a downloads_toplist-element to use in the portal
class_installer_element_formular Installer to install a form-element (provides a basic contact form)
class_installer_element_imagelightbox Installer to install a imagelightbox-element to use in the portal
class_installer_element_lastmodified Installer to install a lastmodified-element to use in the portal
class_installer_element_mediaplayer Installer to install a mediaplayer-element to use in the portal
class_installer_element_mybase Installer to install a login-element to use in the portal
class_installer_element_portallogin Installer to install a login-element to use in the portal
class_installer_element_portalregistration Installer to install a login-element to use in the portal
class_installer_element_portalstats Installer to install a portalstats-element to use in the portal
class_installer_element_portalupload Installer to install a login-element to use in the portal
class_installer_element_rendertext Installer to install a rendertext-element (provides a basic contact form)
class_installer_element_rssfeed Installer to install a rssfeed-element to use in the portal
class_installer_element_tagcloud Installer to install a tagcloud-element to use in the portal
class_installer_element_tagto Installer to install a tagto-element to use in the portal
class_installer_element_tellafriend Installer to install a tellafriend-element to use in the portal
class_installer_element_textticker Installer to install a textticker-element to use in the portal
class_installer_faqs Class providing an installer for the faqs module
class_installer_gallery Installer to install the gallery-module
class_installer_guestbook Installer of the guestbook
class_installer_navigation Installer of the navigation
class_installer_news Class providing an install for the news module
class_installer_pages Installer of the pages-module
class_installer_postacomment Class providing an install for the postacomment module
class_installer_rating Class providing an installer for the rating module
class_installer_samplecontent Class providing an installer for the samplecontent.
class_installer_search Class providing the installer of the search-module
class_installer_stats Installer handling the installation of the stats module
class_installer_system Installer for the system-module
Method Summary
Description | Descendents | Vars | Methods (details)
class_installer_base __construct ( $arrModule)
void doModuleInstall ()
void doModulePostUpdate ()
void doModuleUpdate ()
void doPostInstall ()
string getModuleInstallInfo ()
string getModuleInstallLink ()
string getModuleName ()
string getModuleNameShort ()
string getModulePostInstallInfo ()
array getNeededModules ()
string getVersion ()
void hasPostInstalls ()
bool hasPostUpdates ()
void install ()
boolean isModuleInstallable ()
boolean isModulePostInstallable ()
void postInstall ()
void postUpdate ()
void registerConstant (string $strName, string $strValue, int $intType, int $intModule)
string registerModule (string $strName, int $intModuleNr, string $strFilePortal, string $strFileAdmin, string $strVersion, bool $bitNavi, [string $strXmlPortal = ""], [string $strXmlAdmin = ""])
void update ()
void updateElementVersion (string $strElementName, string $strVersion)
bool updateModuleVersion (string $strModuleName, string $strVersion)
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from class_root

class_root::$arrModule
 class_root::$objConfig
 class_root::$objDB
 class_root::$objRights
 class_root::$objSession
 class_root::$objTemplate
 class_root::$objToolkit
 class_root::$strTemplateArea
Methods
Description | Descendents | Vars Methods (details)
Constructor __construct (line 23)

Contructor

  • access: public
class_installer_base __construct ( $arrModule)
  • $arrModule
Redefinition of:
class_root::__construct()
Constructor
Redefined in descendants as:
doModuleInstall (line 331)

Invokes the installation of the module

  • access: public
void doModuleInstall ()
doModulePostUpdate (line 409)

Invokes the post-updates of the module

  • access: public
void doModulePostUpdate ()
doModuleUpdate (line 390)

Invokes the installation of the module

  • access: public
void doModuleUpdate ()
doPostInstall (line 371)

Invokes the installation of the module

  • access: public
void doPostInstall ()
getModuleInstallInfo (line 62)

Creates a text-based info. Update-Links are placed within those infos.

  • return: info or an empty string in case of now errors
  • since: 3.2
  • access: public
string getModuleInstallInfo ()
getModuleInstallLink (line 151)

Creates the links to install a module or to run updates on a module

  • deprecated: use self::getModulInstallInfo() or self::getModuleInstallCheckbox() instead
  • access: public
string getModuleInstallLink ()
getModuleName (line 43)

Returns the value of $arrModule["name_lang"], the long name of the module

  • access: public
string getModuleName ()
getModuleNameShort (line 52)

Returns the value of $arrModule["name"], the name of the module

  • access: public
string getModuleNameShort ()
getModulePostInstallInfo (line 268)

Creates text-based infos regarding the current installation.

If a post-install is possible, an empty string is returned.

  • return: or ""
  • access: public
string getModulePostInstallInfo ()
getNeededModules (line 432)

Overwrite this method. it should return an array of module-names needed as dependencies for the current module

  • access: protected
array getNeededModules ()
Redefined in descendants as:
getVersion (line 34)

Returns the version of the current module.

$arrModule["version"]

  • access: public
string getVersion ()
Redefined in descendants as:
hasPostInstalls (line 422)

Overwrite this function

  • access: protected
void hasPostInstalls ()
Redefined in descendants as:
hasPostUpdates (line 461)

Used to update the elements installed by the postInstall method, e.g. page-elements Overwrite if needed

  • access: public
bool hasPostUpdates ()
Redefined in descendants as:
install (line 439)

Overwrite this function!!!

  • access: protected
void install ()
Redefined in descendants as:
isModuleInstallable (line 124)

checks if the module can be installed

  • since: 3.2
  • access: public
boolean isModuleInstallable ()
isModulePostInstallable (line 217)

checks if module post-installs are available and can be installed

  • since: 3.2
  • access: public
boolean isModulePostInstallable ()
postInstall (line 451)

Overwrite this function!!!

  • access: protected
void postInstall ()
Redefined in descendants as:
postUpdate (line 469)

Does all the updating of the installations done after the module-install

Overwrite if needed

  • access: public
void postUpdate ()
Redefined in descendants as:
registerConstant (line 568)

Registers a constant to load at system-startup

  • access: public
void registerConstant (string $strName, string $strValue, int $intType, int $intModule)
  • string $strName
  • string $strValue
  • int $intType: class_modul_system::int_TYPE_XX
  • int $intModule
registerModule (line 487)

Writes the data of a module to the database

  • return: the new SystemID of the record
  • access: protected
string registerModule (string $strName, int $intModuleNr, string $strFilePortal, string $strFileAdmin, string $strVersion, bool $bitNavi, [string $strXmlPortal = ""], [string $strXmlAdmin = ""])
  • string $strName
  • int $intModuleNr
  • string $strFilePortal
  • string $strFileAdmin
  • string $strVersion
  • bool $bitNavi
  • string $strXmlPortal
  • string $strXmlAdmin
update (line 445)

Overwrite this function!!!

  • access: protected
void update ()
Redefined in descendants as:
updateElementVersion (line 549)

Updates an element to the given version

  • access: protected
void updateElementVersion (string $strElementName, string $strVersion)
  • string $strElementName
  • string $strVersion
updateModuleVersion (line 530)

Updates the version of the given module to the given version

  • access: protected
bool updateModuleVersion (string $strModuleName, string $strVersion)
  • string $strModuleName
  • string $strVersion
Redefined in descendants as:

Inherited Methods

Inherited From class_root

class_root::__construct()
class_root::additionalCallsOnDeletion()
class_root::createDateRecord()
class_root::createSystemRecord()
class_root::deleteRight()
class_root::deleteSystemRecord()
class_root::flushCompletePagesCache()
class_root::flushPageFromPagesCache()
class_root::generateSystemid()
class_root::getAction()
class_root::getAllParams()
class_root::getArrModule()
class_root::getChildNodesAsIdArray()
class_root::getEditDate()
class_root::getLastEditUser()
class_root::getLastEditUserId()
class_root::getLockManager()
class_root::getModuleData()
class_root::getModuleSystemid()
class_root::getNumberOfSiblings()
class_root::getObjRights()
class_root::getObjText()
class_root::getOwnerId()
class_root::getParam()
class_root::getPathArray()
class_root::getPrevId()
class_root::getRecordComment()
class_root::getRecordModuleNr()
class_root::getStatus()
class_root::getStrAdminLanguageToWorkOn()
class_root::getStrPortalLanguage()
class_root::getSystemid()
class_root::getSystemRecord()
class_root::getText()
class_root::setAbsolutePosition()
class_root::setEditDate()
class_root::setLastEditUser()
class_root::setOwnerId()
class_root::setParam()
class_root::setPosition()
class_root::setPrevId()
class_root::setRecordComment()
class_root::setStatus()
class_root::setSystemid()
class_root::setTemplateArea()
class_root::unsetSystemid()
class_root::updateDateRecord()
class_root::validateSystemid()

Documentation generated on Mon, 12 Apr 2010 21:20:38 +0200 by phpDocumentor 1.4.3