Class ConsumerInstaller

Description
Description | Methods (details)

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

Call 

  1. createConsumer($consumerDefinition)
    2.
to create a new Consumer.

ConsumerInstallHelper
   |
   --ConsumerInstaller
Method Summary
Description | Methods (details)
mixed createConsumer ( $consumerDefinition)
Methods
Description | Methods (details)
createConsumer (line 86)

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)

  • return: one of the mentioned Constants
mixed createConsumer ( $consumerDefinition)
  • $consumerDefinition

Inherited Methods

Inherited From ConsumerInstallHelper

ConsumerInstallHelper::cleanError()
ConsumerInstallHelper::cleanInfos()
ConsumerInstallHelper::getError()
ConsumerInstallHelper::getFilesToParse()
ConsumerInstallHelper::getInfo()
ConsumerInstallHelper::getReplacerArray()
ConsumerInstallHelper::getReplacerFromConsumerDefinition()
ConsumerInstallHelper::parseConsumerString()

Documentation generated by phpDocumentor 1.3.1