DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: kool_base¶

Author:	idefix
Created:	2007-02-27T15:00:08
Changed:	2009-04-28T15:40:35
Classification:	kool_base
Author:	Renzo Lauper
Email:	renzo.lauper@kircheonline.ch
Info 3:
Info 4:

EXT: kool_base¶

Extension Key: kool_base

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents¶

EXT: kool_base 1

Introduction 1

What does it do? 1

Users manual 1

Usage 1

Introduction¶

What does it do?¶

This extension provides some commonly used functionality for Typo3 extensions used in connection with kOOL - the church tool (http://www.churchtool.org). It is mainly targeted at developers who plan to write their own Typo3 extension.

Prerequisites¶

The most important prerequisite to use this extension is an installation of kOOL - the church tool. Without it, you won't need this extension.

Ideally the databases for kOOL and TYPO3 are on the same physical server so the MySQL user for TYPO3 can access the kOOL's database directly. But it is also possible to set another server for the kOOL database. In this case you have to create the same user as used for TYPO3 on the database server for the kOOL database, as the same username and password will be used.If it is not possible to create a database connection between the web and the database server, kOOL also offers an XML API to access certain data from the kOOL database. Read more about this below.

Users manual¶

This extension is not supposed to be used by users directly, but only serves as a provider of some functionalities useful for developers.

Usage¶

Class tx_koolbase_data¶

When creating a flexform for your extension it is often desirable to fill a select field with data from the kOOL database, e.g. a list of event groups. In such a case you will want to create your own data class which extends tx_koolbase_data. This way you can access the handy functions:

getDBColumns($config, $extkey, $plugin)¶

This method returns a config array which can be used in a flexform select containing all db columns from the given kOOL database table. You can use the following XML tags:

user_kOOLTable: The name of the kOOL database table to access
user_ignoreFields: A comma separated list of columns that should not show up in the flexform input
user_addFields: A comma separated list of columns that should be added in addition to the db columns

getPageTSConfig($plugin)¶

If you need to access values set in you extensions TS setup before filling the flexform fields you'll need this method. It returns a confi-array as you would get in your plugin class of your extension which extends tslib_pibase.

Class tx_koolbase¶

If your kOOL extension offers a new content element you will want to extend this class instead of tslib_pibase. It offers some commonly used functionality which make it easier for you to write your extension and also adds some common features and GUI elements to alle kOOL extensions.

Class tx_koolbase_connect¶

EXT: kool_base - 2