Docs For Class UpdateManager - BIGACE Web CMS

Class UpdateManager

Method Summary

UpdateManager	UpdateManager()
void	addErrorMessage()
void	addInfoMessage()
void	addResults()	Adds a bunch of UpdateResult messages to the internal logger.
void	addSeparator()
void	buildIgnoreList()
array	checkFileRights()	Checks the File rights for the
void	countErrors()	Returns the number of occured errors.
void	deleteFiles()
void	getAllFilesFromUpdate()	Returns a list of all files that will be written when performing the update.
void	getDefaultIgnoreList()
void	getResults()
void	getUpdateModul()
void	parseConsumerString()	Creates the given String and renames it to the needed Consumer declaration
void	parseDirectory()	Call this method instead of calling
void	performDBUpdate()	Updates Database, uses DB Connection fetched with Configuration of the current BIGACE Installation.
void	performFileUpdate()	Performs an File Update.
void	performUpdate()
void	performUpdateForConsumer()
void	performXMLUpdate()
void	stripRootDir()

[ Top ]

Methods

Constructor UpdateManager [line 67]

UpdateManager UpdateManager(

$cid 
)

Parameters:

$cid:

[ Top ]

addErrorMessage [line 83]

void addErrorMessage(

$message 
)

Parameters:

$message:

[ Top ]

addInfoMessage [line 89]

void addInfoMessage(

$message 
)

Parameters:

$message:

[ Top ]

addResults [line 107]

void addResults(

$msgResults 
)

Adds a bunch of

UpdateResult

messages to the internal logger.

Parameters:

$msgResults:

[ Top ]

addSeparator [line 94]

void addSeparator(

$message 
)

Parameters:

$message:

[ Top ]

buildIgnoreList [line 198]

void buildIgnoreList(

$modul, [
$ignoreList = array()] 
)

Parameters:

	$modul:
	$ignoreList:

[ Top ]

checkFileRights [line 129]

array checkFileRights(

$modul, 
$ignoreList 
)

Checks the File rights for the

Parameters:

	$modul:
	$ignoreList:

API Tags:

Return:

an array with filenames that are not writable

[ Top ]

countErrors [line 115]

void countErrors(
)

Returns the number of occured errors.

[ Top ]

deleteFiles [line 616]

void deleteFiles(
array
$files, [int
$consumerID = null] 
)

Parameters:

array	$files:	an array with all filenames to be deleted
int	$consumerID:	the Consumer ID to execute on

[ Top ]

getAllFilesFromUpdate [line 453]

void getAllFilesFromUpdate(

$modul, [
$ignoreList = array()] 
)

Returns a list of all files that will be written when performing the update.

Parameters:

	$modul:
	$ignoreList:

[ Top ]

getDefaultIgnoreList [line 120]

void getDefaultIgnoreList(
)

[ Top ]

getResults [line 99]

void getResults(
)

[ Top ]

getUpdateModul [line 72]

void getUpdateModul(
)

[ Top ]

parseConsumerString [line 814]

void parseConsumerString(

$name, 
$cid 
)

Creates the given String and renames it to the needed Consumer declaration

Parameters:

	$name:
	$cid:

[ Top ]

parseDirectory [line 477]

void parseDirectory(

$startDir, 
$ignoreList, 
$consumerID, [
$fromUpdateDirectory = true] 
)

Call this method instead of calling

Parameters:

	$startDir:
	$ignoreList:
	$consumerID:
	$fromUpdateDirectory:

[ Top ]

performDBUpdate [line 704]

void performDBUpdate(
splitter
$splitter, file
$file, [int
$consumerID = ''] 
)

Updates Database, uses DB Connection fetched with Configuration of the current BIGACE Installation.

ATTENTION: If you leave the third parameter empty, no parsing of the SQL Command for Consumer specific data will be performed!

Parameters:

splitter	$splitter:	the String that is used to split Database Statements
file	$file:	the File that holds the SQL Statements
int	$consumerID:	the Consumer ID or an empty String

[ Top ]

performFileUpdate [line 466]

void performFileUpdate(
String
$startDir, int
$consumerID, [array
$ignoreList = array()] 
)

Performs an File Update.

Parameters:

String	$startDir:	the Directory to start from
int	$consumerID:	the Consumer ID
array	$ignoreList:	the List of Files that should be ignored

[ Top ]

performUpdate [line 77]

void performUpdate(

$modul, [
$ignoreList = array()] 
)

Parameters:

	$modul:
	$ignoreList:

[ Top ]

performUpdateForConsumer [line 252]

void performUpdateForConsumer(
int
$consumerID, String
$UPDATE_DIR, array
$ignoreList 
)

Parameters:

int	$consumerID:	the Consumer ID to perform the Update for
String	$UPDATE_DIR:	the Update to perform, MUST end with a trainling slash!
array	$ignoreList:	the List of Files to ignore when performing the Update

[ Top ]

performXMLUpdate [line 656]

void performXMLUpdate(

$filename, 
$cid 
)

Parameters:

	$filename:
	$cid:

[ Top ]

stripRootDir [line 806]

void stripRootDir(

$filename 
)

Parameters:

$filename:

[ Top ]

bigace-classes

Class: UpdateManager

Class UpdateManager