[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: ConsumerInstallHelper

Source Location: /CORE/system/classes/consumer/ConsumerInstallHelper.php

Class ConsumerInstallHelper

Class Overview

The ConsumerInstallHelper defines general methods that can be used for creating Installation mechansim for Consumer.

It is used both, in Administration and Installation console.

Located in /CORE/system/classes/consumer/ConsumerInstallHelper.php [line 69]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: ConsumerInstallHelper.php,v 1.27 2008/12/30 21:29:16 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
ConsumerInstaller	This Class is used to create new Consumers for your CMS.
ConsumerDeinstaller	This Class is used to deinstall a Consumers from your CMS.

[ Top ]

Method Summary

void	cleanError()
void	cleanInfos()
void	executeXmlSchema()
void	getDirectoriesToCreate()
void	getError()
array	getFilesToParse()	Return an array with all (absolute) Filenames, that must be parsed after the Files has copied to its new Consumer Directory.
void	getInfo()
void	getReplacerArray()	Returns the associative Array with all keys (used for formulars) and the Replacer mappings that are used in the installation Files.
void	getReplacerFromConsumerDefinition()	Create an associative Array from an ConsumerDefinition file.
void	parseConsumerString()	Creates the given String and renames it to the needed Consumer declaration
void	parseForReplacer()	Parses the given Content and replaces all XXX in content with values from data array.

[ Top ]

Methods

cleanError [line 163]

void cleanError(
)

[ Top ]

cleanInfos [line 167]

void cleanInfos(
)

[ Top ]

executeXmlSchema [line 208]

void executeXmlSchema(

$filename, 
$consumerDefinition 
)

Parameters:

	$filename:
	$consumerDefinition:

[ Top ]

getDirectoriesToCreate [line 451]

void getDirectoriesToCreate(
)

[ Top ]

getError [line 171]

void getError(
)

[ Top ]

getFilesToParse [line 436]

array getFilesToParse(
)

Return an array with all (absolute) Filenames, that must be parsed after the Files has copied to its new Consumer Directory.

Remember to call

parseConsumerString($filename, $cid)

on each Filename to get the real Path!

API Tags:

Return:

all Files to be parsed

[ Top ]

getInfo [line 175]

void getInfo(
)

[ Top ]

getReplacerArray [line 369]

void getReplacerArray(
)

Returns the associative Array with all keys (used for formulars) and the Replacer mappings that are used in the installation Files.

[ Top ]

getReplacerFromConsumerDefinition [line 403]

void getReplacerFromConsumerDefinition(
ConsumerDefinition
$definition 
)

Create an associative Array from an ConsumerDefinition file.

The keys can be directly mapped to the keys in the Array fetched by

getReplacerArray()

Parameters:

ConsumerDefinition

$definition:

definition the ConsumerDefinitin to fetch values from

[ Top ]

parseConsumerString [line 463]

void parseConsumerString(

$name, 
$cid 
)

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

Parameters:

	$name:
	$cid:

[ Top ]

parseForReplacer [line 348]

void parseForReplacer(

$content, 
$data 
)

Parses the given Content and replaces all XXX in content with values from data array.

Parameters:

	$content:
	$data:

[ Top ]