Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitModuleFaqDefintion

Faq::arbitModuleFaqDefintion

Class arbitModuleFaqDefintion

Arbit FAQ module definition

Arbit FAQ module definition

arbitBaseStruct
   |
   --arbitModuleDefintion
      |
      --arbitModuleFaqDefintion
Author(s):
Version:   $Revision: 1236 $
License:   GPL

Member Variables

protected array $caches = array(
)

Array with caches registered on initialization Each cache must have a unique name, normally prefixed with the module identifier. time to live for the cache.

Array with caches registered on initialization Each cache must have a unique name, normally prefixed with the module identifier. The definition array should at least contain a path and a time to live for the cache.

  1.   'name' => array(
  2.       'path' => 'dir/',
  3.       'ttl'  => arbitCache::INFINITE,
  4.   ),
  5.   ...

protected array $couchDbDocuments = array(
'faq_categories' => 'arbitBackendCouchDbFaqCategoriesDocument',
'faq_question' => 'arbitBackendCouchDbFaqQuestionDocument',
)

CouchDB documents to be registered at the document manager.

CouchDB documents to be registered at the document manager.

protected array $couchDbViews = array(
'faq_questions' => 'arbitBackendCouchDbFaqQuestionView',
)

CouchDB documents to be registered at the document manager.

CouchDB documents to be registered at the document manager.

protected array $facades = array(
'couchdb' => array(
'faq_categories' => 'arbitCouchDbFaqCategoriesFacade',
'faq_question' => 'arbitCouchDbFaqQuestionFacade',
),)

Array with facades registered on initialization Array with facedes for all known database backends linked with their respective implementation.

Array with facades registered on initialization Array with facedes for all known database backends linked with their respective implementation.

  1.   'couchdb' => array(
  2.       'name' => 'class',
  3.   ),

protected array $properties = array(
'autoload' => null,
'permissions' => array(
'faq_ask_question' => 'User is allowed to ask new questions.',
'faq_edit_answer' => 'User is allowed to answer new questions and edit existing answers.',
'faq_edit_categories' => 'User is allowed to edit the categories available for FAQ questions.',
),'slots'=>array(),'signals'=>array('faqNewQuestion'=>'A new question has been asked by a user.','faqQuestionRemoved'=>'A question has been removed.','faqAnswerEdit'=>'A answer has been given or edited.',),'templateDirectory'=>'templates/','controller'=>'arbitModuleFaqController','path'=>__DIR__,)

Array containing the module structures properties.

Array containing the module structures properties. Take a look at the property descriptions in the class level documentation for a more detailed description for each of the properties. Do not add any properties to this array, which are not defined in this base class, because those might be used later on by the core.

protected array $viewModels = array(
'arbitViewXHtmlHandler' => array(
'arbitFaqOverviewViewModel' => 'arbitModuleFaqXHtmlHandler::showOverviewModel',
'arbitFaqQuestionViewModel' => 'arbitModuleFaqXHtmlHandler::showQuestionModel',
'arbitFaqQuestionEditModel' => 'arbitModuleFaqXHtmlHandler::showEditModel',
'arbitFaqAskViewModel' => 'arbitModuleFaqXHtmlHandler::showAskModel',
'arbitFaqAnswerViewModel' => 'arbitModuleFaqXHtmlHandler::showAnswerModel',
'arbitFaqCategoriesViewModel' => 'arbitModuleFaqXHtmlHandler::showCategoriesModel',
),'arbitViewEmailHandler'=>array('arbitFaqAnswerEditStruct'=>'arbitModuleFaqEmailHandler::showAnswerEdit','arbitFaqQuestionRemovedStruct'=>'arbitModuleFaqEmailHandler::showQuestionRemoved','arbitFaqNewQuestionStruct'=>'arbitModuleFaqEmailHandler::showNewQuestion',),)

List of view models used by the module List of used view handlers associated with a list of view models used by the module, each associated with a callback to the concrete handler implementation to visit the view model.

List of view models used by the module List of used view handlers associated with a list of view models used by the module, each associated with a callback to the concrete handler implementation to visit the view model.

  1.   'arbitViewXHtmlHandler' => array(
  2.       'myViewModel' => 'myXHtmlHandler::showMyModel',
  3.       ...
  4.   ),
  5.   ...

Inherited Member Variables

From arbitModuleDefintion
protected arbitModuleDefintion::$commands

Inherited Methods

From arbitModuleDefintion
protected void arbitModuleDefintion::initializeCaches()
Initialize module caches
protected void arbitModuleDefintion::initializeCommands()
Initialize commands
protected void arbitModuleDefintion::initializeCouchDbDocuments()
Initialize CouchDB document classes
protected void arbitModuleDefintion::initializeCouchDbViews()
Initialize CouchDB view classes
protected void arbitModuleDefintion::initializeFacades()
Initialize facades
public void arbitModuleDefintion::initializeModule()
Initialize module Initialize the module using the values defined in the module definition class properties.
protected void arbitModuleDefintion::initializeViews()
Initialize views
public mixed arbitModuleDefintion::__get()
Get property value Get property values. properties on the first request to this property. sued to load the autoload array only when it is requested.
From arbitBaseStruct
protected void arbitBaseStruct::deepClone()
Deep clone array structures
public array arbitBaseStruct::getProperties()
Get property names Returns an arary with all properties defined in this struct.
public void arbitBaseStruct::__clone()
Method called, when struct ist cloned
Documentation generated on Mon, 05 Apr 2010 14:01:47 +0200 by phpDocumentor 1.4.3