install
[ class tree: install ] [ index: install ] [ all elements ]

Class: BitInstaller

Source Location: /install/BitInstaller.php

Class Overview

BitBase
   |
   --BitSingleton
      |
      --BitSystem
         |
         --BitInstaller



Author(s):

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: BitSystem

BitSystem::__construct()
base constructor, auto assigns member db variable
BitSystem::appendIncludePath()
* Append $pPath to the include path
BitSystem::calculateRequirements()
calculateRequirements will calculate all requirements and return a hash of the results
BitSystem::checkBitVersion()
checkBitVersion Check for new version of bitweaver
BitSystem::checkEnvironment()
BitSystem::confirmDialog()
This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.
BitSystem::diff2()
BitSystem::display()
Display the main page template
BitSystem::drawRequirementsGraph()
drawRequirementsGraph Will draw a requirement graph if PEAR::Image_GraphViz is installed
BitSystem::expungePackageConfig()
Delete all prefences for the given package
BitSystem::fatalError()
If an unrecoverable error has occurred, this method should be invoked. script exist occurs
BitSystem::fatalPermission()
Interupt code execution and show a permission denied message.
BitSystem::genPass()
BitSystem::getBitVersion()
getBitVersion will fetch the version of bitweaver as set in kernel/config_defaults_inc.php
BitSystem::getBrowserTitle()
get the title of the browser
BitSystem::getConfig()
Add getConfig / setConfig for more uniform handling of config variables instead of spreading global vars.
BitSystem::getConfigMatch()
retreive a group of config variables
BitSystem::getDefaultPage()
getDefaultPage
BitSystem::getDefaultTempDir()
BitSystem::getErrorEmail()
Smartly determines where error emails should go
BitSystem::getIncludeFiles()
getIncludeFiles will get a set of available files with a given filename
BitSystem::getIndexPage()
getIndexPage
BitSystem::getLatestUpgradeVersion()
getLatestUpgradeVersion will fetch the greatest upgrade number for a given package
BitSystem::getMimeExtension()
BitSystem::getPackageStatus()
find out a packages installation status
BitSystem::getPermissionDeniedMessage()
BitSystem::getPermissionInfo()
It will get information about a permissions
BitSystem::getRequirements()
getRequirements
BitSystem::getSingleInstance()
BitSystem::getUTCTime()
Retrieve a current UTC timestamp
BitSystem::getUTCTimestamp()
Retrieve a current UTC ISO timestamp
BitSystem::getVersion()
getVersion will fetch the version number of a given package
BitSystem::get_display_offset()
Retrieves the user's preferred offset for displaying dates.
BitSystem::get_long_datetime()
BitSystem::get_long_datetime_format()
Retrieves the user's preferred long date/time format for displaying dates.
BitSystem::get_long_date_format()
Retrieves the user's preferred long date format for displaying dates.
BitSystem::get_long_time_format()
Retrieves the user's preferred long time format for displaying dates.
BitSystem::get_short_datetime_format()
Retrieves the user's preferred short date/time format for displaying dates.
BitSystem::get_short_date_format()
Retrieves the user's preferred short date format for displaying dates.
BitSystem::get_short_time_format()
Retrieves the user's preferred short time format for displaying dates.
BitSystem::hasValidSenderEmail()
Determines if this site has a legitimate sender address set.
BitSystem::isFeatureActive()
check's if the specfied feature is active
BitSystem::isLive()
isLive returns status of the IS_LIVE constant from config/kernel/config_inc.php
BitSystem::isPackageActive()
check's if a package is active.
BitSystem::isPackageActiveEarly()
check if a package is active; but only do this after making sure a package
BitSystem::isPackageInstalled()
check's if a package is Installed
BitSystem::loadConfig()
Load all preferences and store them in $this->mConfig
BitSystem::loadFromCache()
BitSystem::loadMimeTypes()
given an extension, return the mime type
BitSystem::loadPackage()
Loads a package
BitSystem::lookupMimeType()
given an extension, return the mime type
BitSystem::outputHeader()
BitSystem::prependIncludePath()
* Prepend $pPath to the include path
BitSystem::registerAppMenu()
Register global system menu. Due to the startup nature of this method, it need to belong in BitSystem instead of BitThemes, where it would more naturally fit.
BitSystem::registerConfig()
registerConfig
BitSystem::registerContentObjects()
registerContentObjects
BitSystem::registerModules()
registerModules
BitSystem::registerNotifyEvent()
registerNotifyEvent
BitSystem::registerPackage()
Define name, location and url DEFINE's
BitSystem::registerPackageInfo()
registerPackageInfo
BitSystem::registerPackageVersion()
registerPackageVersion Holds the package version
BitSystem::registerPreferences()
registerPreferences
BitSystem::registerRequirements()
registerRequirements
BitSystem::registerSchemaConstraints()
registerSchemaConstraints
BitSystem::registerSchemaDefault()
registerSchemaDefault
BitSystem::registerSchemaIndexes()
registerSchemaIndexes
BitSystem::registerSchemaSequences()
registerSchemaSequences
BitSystem::registerSchemaTable()
registerSchemaTable
BitSystem::registerUserPermissions()
registerUserPermissions
BitSystem::scanPackages()
scan all available packages. This is an *expensive* function. DO NOT call this functionally regularly , or arbitrarily. Failure to comply is punishable by death by jello suffication!
BitSystem::sendEmail()
centralized function for send emails
BitSystem::setBrowserTitle()
set the title of the browser
BitSystem::setCanonicalLink()
set the canonical page title
BitSystem::setConfig()
Set a hash value in the mConfig hash. This does *NOT* store the value in the database. It does no checking for existing or duplicate values. the main point of this function is to limit direct accessing of the mConfig hash. I will probably make mConfig private one day.
BitSystem::setHttpStatus()
Set the http status, most notably for 404 not found for deleted content
BitSystem::setOnloadScript()
add javascript to the <body onload> attribute
BitSystem::setOnunloadScript()
add javascript to the <body onunload> attribute
BitSystem::storeConfig()
bitweaver needs lots of settings just to operate.
BitSystem::storeConfigMatch()
storeConfigMatch set a group of config variables
BitSystem::storeVersion()
storeVersion will store the version number of a given package
BitSystem::validateVersion()
validateVersion
BitSystem::verifyFeature()
It will verify that the given feature is active or it will display the error template and die()
BitSystem::verifyFileExtension()
given a file and optionally desired name, return the correctly extensioned file and mime type
BitSystem::verifyInstalledPackages()
verifyInstalledPackages scan all available packages
BitSystem::verifyMimeType()
given a file, return the mime type
BitSystem::verifyPackage()
It will verify that the given package is active or it will display the error template and die()
BitSystem::verifyPermission()
DEPRECATED - this function has been moved into BitPermUser, use that
BitSystem::verifyRequirements()
verifyRequirements

Class: BitSingleton

BitSingleton::__construct()
BitSingleton::loadSingleton()

Class: BitBase

BitBase::BitBase()
During initialisation, we assign a name which is used by the class.
BitBase::__construct()
BitBase::clearFromCache()
BitBase::expunge()
Delete content object and all related records
BitBase::load()
BitBase::__destruct()

Class Details

[line 10]


Tags:

author:  spider <spider@steelsun.com>


[ Top ]


Class Variables

$mPackageUpgrades = array()

[line 18]

mPackageUpgrades



Tags:

access:  public

Type:   array


[ Top ]

$mRequirements = array()

[line 26]

mRequirements



Tags:

access:  public

Type:   array


[ Top ]



Class Methods


constructor BitInstaller [line 32]

BitInstaller BitInstaller( )

Initiolize BitInstaller



Tags:

access:  public


[ Top ]

method applyUpgrade [line 334]

empty applyUpgrade( array $pPackage, array $pUpgradeHash)

applyUpgrade



Tags:

return:  array on success, array with errors on failure
access:  public


Parameters:

array   $pPackage  
array   $pUpgradeHash  

[ Top ]

method convertBlobs [line 594]

TRUE convertBlobs( string $gDb, &$res, array $blobs, array $res)

convertBlobs enumerate blob fields and encoded



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

string   $gDb  
array   $res  
array   $blobs  
   &$res  

[ Top ]

method getTablePrefix [line 251]

database getTablePrefix( )

getTablePrefix



Tags:

return:  adjusted table prefix
access:  public


[ Top ]

method getWebServerUid [line 220]

void getWebServerUid( )

getWebServerUid set global wwwuser and wwwgroup



Tags:

access:  public


[ Top ]

method hasAdminBlock [line 607]

TRUE hasAdminBlock( )

hasAdminBlock



Tags:

return:  on success, FALSE on failure
deprecated:  i think this isn't used any more
access:  public


[ Top ]

method identifyBlobs [line 572]

TRUE identifyBlobs( array $result)

identifyBlobs



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $result  

[ Top ]

method in_display [line 188]

void in_display( $pPackage, string $pTemplate, string $pBrowserTitle)

display



Tags:

access:  public


Parameters:

string   $pTemplate  
string   $pBrowserTitle  
   $pPackage  

[ Top ]

method isInstalled [line 210]

TRUE isInstalled( [ $pPackage = 'kernel'])

isInstalled



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

   $pPackage  

[ Top ]

method loadAllUpgradeFiles [line 43]

void loadAllUpgradeFiles( )

loadAllUpgradeFiles load upgrade files from all packages that are installed



Tags:

access:  public


[ Top ]

method loadUpgradeFiles [line 87]

void loadUpgradeFiles( array $pPackage)

loadUpgradeFiles This will load all files in the dir <pckage>/admin/upgrades/<version>.php with a version greater than the one installed



Tags:

access:  public


Parameters:

array   $pPackage  

[ Top ]

method login [line 55]

void login( $pLogin, $pPassword, [ $pChallenge = NULL], [ $pResponse = NULL])

Minimal login just for install in case users tables have been modified



Tags:

access:  public


Parameters:

   $pLogin  
   $pPassword  
   $pChallenge  
   $pResponse  

[ Top ]

method registerPackageUpgrade [line 116]

void registerPackageUpgrade( array $pParams, [array $pUpgradeHash = array()], string $pParams[package], string $pParams[version], string $pParams[description], string $pParams[post_upgrade])

registerPackageUpgrade



Tags:

access:  public


Parameters:

array   $pParams   Hash of information about upgrade
string   $pParams[package]   Name of package that is upgrading
string   $pParams[version]   Version of this upgrade
string   $pParams[description]   Description of what the upgrade does
string   $pParams[post_upgrade]   Textual note of stuff that needs to be observed after the upgrade
array   $pUpgradeHash   Hash of update rules. See existing upgrades on how this works.

[ Top ]

method registerUpgrade [line 173]

TRUE registerUpgrade( array $pPackage, array $pUpgradeHash)

registerUpgrade



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackage  
array   $pUpgradeHash  

[ Top ]

method upgradePackage [line 288]

TRUE upgradePackage( array $pPackage)

upgradePackage



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackage  

[ Top ]

method upgradePackageVersions [line 302]

TRUE upgradePackageVersions( array $pPackage, array $pVersion)

upgradePackageVersion



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackage  
array   $pVersion  

[ Top ]

method verifyPackageUpgrade [line 139]

TRUE verifyPackageUpgrade( &$pParams, array $pParams, string $pParams[package], string $pParams[version], string $pParams[description], string $pParams[post_upgrade])

verifyPackageUpgrade



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pParams   Hash of information about upgrade
string   $pParams[package]   Name of package that is upgrading
string   $pParams[version]   Version of this upgrade
string   $pParams[description]   Description of what the upgrade does
string   $pParams[post_upgrade]   Textual note of stuff that needs to be observed after the upgrade
   &$pParams  

[ Top ]


Documentation generated on Wed, 29 Jul 2015 13:55:52 +0000 by phpDocumentor 1.5.0-lsces