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

Class: ConsumerInstaller

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

Class ConsumerInstaller

Class Overview

This Class is used to create new Consumers for your CMS.

Call

createConsumer($consumerDefinition)

to create a new Consumer.

Located in /CORE/system/classes/consumer/ConsumerInstaller.php [line 75]

ConsumerInstallHelper
   |
   --ConsumerInstaller

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: ConsumerInstaller.php,v 1.10 2008/07/15 14:27:21 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

createConsumer

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ConsumerInstallHelper

ConsumerInstallHelper::cleanError()

ConsumerInstallHelper::cleanInfos()

ConsumerInstallHelper::executeXmlSchema()

ConsumerInstallHelper::getDirectoriesToCreate()

ConsumerInstallHelper::getError()

ConsumerInstallHelper::getFilesToParse()

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

ConsumerInstallHelper::getInfo()

ConsumerInstallHelper::getReplacerArray()

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

ConsumerInstallHelper::getReplacerFromConsumerDefinition()

Create an associative Array from an ConsumerDefinition file.

ConsumerInstallHelper::parseConsumerString()

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

ConsumerInstallHelper::parseForReplacer()

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

[ Top ]

Method Summary

mixed

createConsumer()

This function creates a new Consumer and returns one of the following keys:

[ Top ]

Methods

createConsumer [line 89]

mixed createConsumer(

$consumerDefinition 
)

This function creates a new Consumer and returns one of the following keys:

CONSUMER_ERROR_WRONG_TYPE (the passed ConsumerDefinition is not of proper type)
CONSUMER_ERROR_UNDEFINED (the ConsumerDefinition is not correct set up - normally values missing)
CONSUMER_ERROR_CONFIG (for example if Config entry could not be created)
CONSUMER_ERROR_DATABASE (problems encountered during database installation)
CONSUMER_CREATED_SUCCESS (everything worked fine, Consumer was created)

Parameters:

$consumerDefinition:

API Tags:

Return:

one of the mentioned Constants

[ Top ]