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: ke_contacts

Created:2006-04-05T09:44:51
Changed by:Martin
Changed:2011-05-12T14:05:10.910000000
Email:info@kennziffer.com
Info 2:
Info 3:
Info 4:

EXT: ke_contacts

Extension Key: ke_contacts

Copyright 2009-2011, www.kennziffer.com GmbH, <info@kennziffer.com>,

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: ke_contacts 1

Introduction 2

What does it do? 2

Screenshots 2

Users manual 5

Requirements 5

Installation 5

Configuration 5

HTML-Templates 8

Reference 12

Extending RealURL-Configuration 13

Known problems 14

To-Do 14

Changelog 14

Introduction

What does it do?

Manage your private or company contacts. Comment contacts, set relations to other www.kennziffer.com extensions. Part of keworks.

Features:

  • create organizations or persons
  • relate persons to an organization
  • filter contacts by person or organization
  • comment your contacts
  • see all comments about members of an organization under the details of the related organization
  • create / edit / delete contacts by using frontend forms
  • premium function (keworks required): relate contacts to other records (troubleticket, ke_yac) by using ke_ukb (“universal keworks browser”)
Compatibility

This version of ke_contacts requires at least TYPO3 4.3.0 to run.

PHP version: ke_contacts should work on all PHP versions that are also supported by TYPO3 (from 5.3.x).

Screenshots

List of contacts:

img-1

  • Create a contact:

  • img-2 Edit a contact:

    img-3

  • Details of a contact / comments:

    img-4

Backend: ke_contacts plugin

img-5

Users manual

Requirements

Please install the following extensions before you install ke_contacts:

tt_address Contains contact data displayed by ke_contacts.

static_info_tables Required for country selection in “new” and “edit” forms.

static_info_tables_de Required for country selection in “new” and “edit” forms.

bg_datepicker_input (optional) Recommended for selection of date based input fields.

Installation

Install requirements, see above.

Download latest version of ke_contacts from online extension repository.

Create a sysfolder as storage for tt_address records.

Insert plugin “Kontaktverwaltung” on desired page.

Edit plugin, set storage page of tt_address records and other configuration options – if needed.

Include static extension template.

Clear frontend cache.

Switch to frontend, go to page where you inserted the plugin and start creation of contacts.

Configuration

Configuration can be done by the flexforms settings of the plugin itself and/or by changing the necessary typoscript settings in your typoscript template.

Notice: Settings directly changed by the flexform configuration of your plugin overwrite typoscript configuration values.

Sheet: General Settings

img-6

Page with address records

Setting

Page with address records

Description

Select one or more pages containing tt_address records to display in frontend.

CSS file

Setting

CSS file

Description

User defined CSS file for frontend layout of plugin.

Sheet: List view

img-7

Contacts per page

Setting

Contacts per page

Description

Number of contacts to display per page in list of contacts.

Color of organizations

Setting

Color of organizations

Description

Define a color organizations are highlighted by in list view.

Alternative template

Setting

Alternative template

Description

Select an alternative html template for frontend layout of contact list.

Sheet: Single view

img-8

Login to comment

Setting

Login to comment

Description

FE-Users have to login before they may give comments to a contact.

Show comments

Setting

Show comments

Description

Show / disable comments for your contacts.

Alternative template

Setting

Alternative template

Description

Select an alternative html template for frontend layout of single view.

Sheet: Edit view

img-9

Alternative template

Setting

Alternative template

Description

Select an alternative html template for frontend layout of single view.

Sheet: Delete

img-10

Alternative template

Setting

Alternative template

Description

Select an alternative html template for frontend layout of single view.

HTML-Templates

In the extension folder of ke_contacts you can find its basic html templates (path: EXT:/res/templates/). There is a template for every single mode (list / single / edit / delete).

The following lines describe the markers and subparts used in those templates.

Hint: If you want to change a template, please ensure to include all subparts and markers mentioned below. Otherwise the extension may not work properly.

Delete

File: EXT:/res/templates/delete.html

<!--###DELETEVIEW### -->

Subpart

<!--###DELETEVIEW### -->

Description

Default subpart. Wraps HTML of delete view.

<!-- ###SUB_CHECKBOX_ROW### -->

Subpart

<!-- ###SUB_CHECKBOX_ROW### -->

Description

Wraps HTML of checkboxes rendered in delete view.

<!-- ###GENERAL_ERROR### -->

Subpart

<!-- ###GENERAL_ERROR### -->

Description

Wraps header, description and backlink of output in case of an error.

###FORMURL###

Marker

###FORMURL###

Subpart

<--###DELETEVIEW### -->

Description

Contains URL of form to jump to when submitting POST data.

###LABEL_DELETE###

Marker

###LABEL_DELETE###

Subpart

<--###DELETEVIEW### -->

Description

Label text taken from locallang.xml.

###FIRST_NAME###

Marker

###FIRST_NAME###

Subpart

<--###DELETEVIEW### -->

Description

First name of contact / organization to delete.

###LAST_NAME###

Marker

###LAST_NAME###

Subpart

<--###DELETEVIEW### -->

Description

Last name of contact / organization to delete.

###HINT###

Marker

###HINT###

Subpart

<--###DELETEVIEW### -->

Description

Hint displayed when deleting an organization with members, taken from locallang.xml

###DELETE_BUTTON_SUBMITVALUE###

Marker

###DELETE_BUTTON_SUBMITVALUE###

Subpart

<--###DELETEVIEW### -->

Description

Value of submit button, taken from locallang.xml.

###NAME###

Marker

###NAME###

Subpart

<-- ###SUB_CHECKBOX_ROW### -->

Description

Internal name of checkbox item.

###VALUE###

Marker

###VALUE###

Subpart

<-- ###SUB_CHECKBOX_ROW### -->

Description

Internal value of checkbox item.

###CHECKED###

Marker

###CHECKED###

Subpart

<-- ###SUB_CHECKBOX_ROW### -->

Description

Contains checked=”checked” for activated items, empty for non-checked checkboxes.

###LABEL###

Marker

###LABEL###

Subpart

<-- ###SUB_CHECKBOX_ROW### -->

Description

Label of checkbox, partially taken from locallang.xml.

###STATUS###

Marker

###STATUS###

Subpart

<-- ###GENERAL_ERROR### -->

Description

CSS-Class to highlight error in a specific color.

###ERRORTEXT###

Marker

###ERRORTEXT###

Subpart

<-- ###GENERAL_ERROR### -->

Description

Error message, taken from locallang.xml

Edit

File: EXT:/res/templates/edit.html

<!-- ###MAIN_CREATE### -->

Subpart

<!-- ###MAIN_CREATE### -->

Description

Default subpart. Wraps HTML of edit view.

<!-- ###SUB_FIELDNAME### -->

Subpart

<!-- ###SUB_FIELDNAME### -->

Description

Default input field items of edit form.

<!-- ###GENERAL_ERROR### -->

Subpart

<!-- ###GENERAL_ERROR### -->

Description

Wraps header, description and backlink of output in case of an error.

###ACTION_URL###

Marker

###ACTION_URL###

Subpart

<!-- ###MAIN_CREATE### -->

Description

Contains URL of form to jump to when submitting POST data.

-

Marker

-

Subpart

<!--###SUB_FIELD_FIELDNAME### -->

Description

Subpart of a single input form item part. Does not only render the specific input field, but also contains label- and error-text.

###LABEL_FIELDNAME###

Marker

###LABEL_FIELDNAME###

Subpart

<!--###SUB_FIELD_FIELDNAME### -->

Description

Label of input field, taken from locallang.xml-file.

###FORMFIELD_FIELDNAME###

Marker

###FORMFIELD_FIELDNAME###

Subpart

<!--###SUB_FIELD_FIELDNAME### -->

Description

Renders input field item by considering the global html input item subpart.

###ERROR_FIELDNAME###

Marker

###ERROR_FIELDNAME###

Subpart

<!--###SUB_FIELD_FIELDNAME### -->

Description

Contains error message in case of failed validation, missing or incorrect data concerning the current form field.

###SUBMITACTION###

Marker

###SUBMITACTION###

Subpart

<!-- ###MAIN_CREATE### -->

Description

Value of submit button, taken from locallang.xml.

###JS###

Marker

###JS###

Subpart

<!-- ###MAIN_CREATE### -->

Description

Javascript code used to hide form fields by switching between “contact” and “organization” mode.

###NAME###

Marker

###NAME###

Subpart

<!-- ###SUB_FIELDNAME### -->

Description

Internal name attribute of form field.

###VALUE###

Marker

###VALUE###

Subpart

<!-- ###SUB_FIELDNAME### -->

Description

Value attribute of form field.

###LABEL###

Marker

###LABEL###

Subpart

<!-- ###SUB_FIELDNAME### -->

Description

Label of form field in edit mode.

###CHECKED###

Marker

###CHECKED###

Subpart

<!-- ###SUB_FIELDNAME### -->

Description

State indicator of a checkbox: Checked / unchecked.

###SELECTED###

Marker

###SELECTED###

Subpart

<!-- ###SUB_FIELDNAME### -->

Description

State indicator of a selectbox: Item selected / not selected.

###DISABLED###

Marker

###DISABLED###

Subpart

<!-- ###SUB_FIELDNAME### -->

Description

Form field cannot be accessed – “readonly”.

###STATUS###

Marker

###STATUS###

Subpart

<-- ###GENERAL_ERROR### -->

Description

CSS-Class to highlight error in a specific color.

###ERRORTEXT###

Marker

###ERRORTEXT###

Subpart

<-- ###GENERAL_ERROR### -->

Description

Error message, taken from locallang.xml

###BACKLINK###

Marker

###BACKLINK###

Subpart

<-- ###GENERAL_ERROR### -->

Description

Page-URL to link back at on error.

Listview

File: EXT:/res/templates/listview.html

<!--###LISTVIEW### -->

Subpart

<!--###LISTVIEW### -->

Description

Default subpart. Wraps HTML of list view.

<!--###ITEM### -->

Subpart

<!--###ITEM### -->

Description

Wraps HTML of a single list item.

<!--###ITEM_COMPANY### -->

Subpart

<!--###ITEM_COMPANY### -->

Description

Wraps HTML of a single list item, type “company”.

<!--###NO_RESULTS### -->

Subpart

<!--###NO_RESULTS### -->

Description

If search is used and no result is returned, the content of this subpart will be displayed.

###FORMURL###

Marker

###FORMURL###

Subpart

<!--###LISTVIEW### -->

Description

Contains URL of form to jump to when submitting POST data.

###CREATENEWCONTACT###

Marker

###CREATENEWCONTACT###

Subpart

<!--###LISTVIEW### -->

Description

Renders link to create a new contact.

###FILTER1_OPTIONS###

Marker

###FILTER1_OPTIONS###

Subpart

<!--###LISTVIEW### -->

Description

Renders selectbox filter “all contacts / persons only / organizations only”.

###SEARCHPHRASE###

Marker

###SEARCHPHRASE###

Subpart

<!--###LISTVIEW### -->

Description

Default value of “search for” input field element.

###LIST_HEADER1###

Marker

###LIST_HEADER1###

Subpart

<!--###LISTVIEW### -->

Description

Headline of column “name” in listview, taken from locallang.xml.

###LIST_HEADER2###

Marker

###LIST_HEADER2###

Subpart

<!--###LISTVIEW### -->

Description

Headline of column “address” in listview, taken from locallang.xml.

###LIST_HEADER3###

Marker

###LIST_HEADER3###

Subpart

<!--###LISTVIEW### -->

Description

Headline of column “contact information” in listview, taken from locallang.xml.

###STATUS###

Marker

###STATUS###

Subpart

<!--###LISTVIEW### -->

Description

Used to display status messages (e.g. creating of contact successful, deleting failed etc.)

###ITEMS###

Marker

###ITEMS###

Subpart

<!--###LISTVIEW### -->

Description

Contains data of all visible contacts in list view.

###PAGECOUNT###

Marker

###PAGECOUNT###

Subpart

<!--###LISTVIEW### -->

Description

Renders current page number and total count of pages in format “Page X of Y”.

###GOTOPAGE###

Marker

###GOTOPAGE###

Subpart

<!--###LISTVIEW### -->

Description

Label of pagebrowser select box.

###PAGES_OPTIONS###

Marker

###PAGES_OPTIONS###

Subpart

<!--###LISTVIEW### -->

Description

Contains pagebrowser as dropdown form field with javascript functionality.

###HIGHLIGHTROW###

Marker

###HIGHLIGHTROW###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

CSS class depending on type of contact, using colors defined by flexforms configuration.

###LAST_NAME###

Marker

###LAST_NAME###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Contains last name of a contact.

###FIRST_NAME###

Marker

###FIRST_NAME###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Contains first name of a contact.

###TITLE###

Marker

###TITLE###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Contains title of person.

###ORGANISATION###

Marker

###ORGANISATION###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

If person belongs to an organization, it is displayed by this marker.

###ADDRESS###

Marker

###ADDRESS###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Street

###ZIP###

Marker

###ZIP###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Postal code

###CITY###

Marker

###CITY###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

City

###TELEPHONE###

Marker

###TELEPHONE###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Telephone

###EMAIL###

Marker

###EMAIL###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

E-mail address

###WWW###

Marker

###WWW###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Website

###EDIT_ICON###

Marker

###EDIT_ICON###

Subpart

<!-- ###ITEM### --><!-- ###ITEM_COMPANY### -->

Description

Renders icon linked to “edit contact” mode.

###HIGHLIGHTROW###

Marker

###HIGHLIGHTROW###

Subpart

<!-- ###NO_RESULTS### -->

Description

CSS class depending on type of error.

###NORESULTS###

Marker

###NORESULTS###

Subpart

<!-- ###NO_RESULTS### -->

Description

Outputs “no results” text from locallang.xml. Used if there are no tt _address-records to display or if a search result does not return any records.

Singleview

File: EXT:/res/templates/singleview.html

<!-- ###MAIN_PERSON### -->

Subpart

<!-- ###MAIN_PERSON### -->

Description

Contains single view data for contact type “person”.

<!-- ###MAIN_ORG### -->

Subpart

<!-- ###MAIN_ORG### -->

Description

Contains single view data for contact type “organization”.

<!-- ###ERROR### -->

Subpart

<!-- ###ERROR### -->

Description

Error output.

<!-- ###COMMENT### -->

Subpart

<!-- ###COMMENT### -->

Description

Displays comments belonging to a person or a company.

###GENDER###

Marker

###GENDER###

Subpart

<!-- ###MAIN_PERSON### -->

Description

CSS class depending on type of error.

###TITLE###

Marker

###TITLE###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Title of a person

###FIRST_NAME###

Marker

###FIRST_NAME###

Subpart

<!-- ###MAIN_PERSON### -->

Description

First name

###LAST_NAME###

Marker

###LAST_NAME###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Last name

###FUNCTION###

Marker

###FUNCTION###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Position of a person inside a company.

###LABEL_BELONGSTO###

Marker

###LABEL_BELONGSTO###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Renders label “belongs to COMPANY_NAME”.

###ORGANIZATION###

Marker

###ORGANIZATION###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Organization a person belongs to.

###ADDRESS###

Marker

###ADDRESS###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Address data of a person

###ZIP###

Marker

###ZIP###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Postal code

###CITY###

Marker

###CITY###

Subpart

<!-- ###MAIN_PERSON### -->

Description

City

###COUNTRY###

Marker

###COUNTRY###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Country

###LABEL_FIELDNAME###

Marker

###LABEL_FIELDNAME###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Label for a specific form field element identified by “FIELDNAME”. Value is taken from locallang.xml.

###FAX###

Marker

###FAX###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Fax

###MOBILE###

Marker

###MOBILE###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Mobile number

###E-MAIL###

Marker

###E-MAIL###

Subpart

<!-- ###MAIN_PERSON### -->

Description

E-mail address

###BIRTHDAY###

Marker

###BIRTHDAY###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Birthday

###BACKLINK###

Marker

###BACKLINK###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Contains link back to list view.

###UKB_CONTENT###

Marker

###UKB_CONTENT###

###UKB_FORM###

Subpart

<!-- ###MAIN_PERSON### -->

Description

Fields used by the “universal keworks browser” (UKB), connects different kinds of database records. For more information see http://www.keworks.de Please keep in mind: If extension “ke_ukb” is not installed or not loaded , the output of these markers will be left blank.

Subpart “##MAIN_ORG###” mainly consists of the same markers as “###MAIN_PERSON”. Because of that the following table only consists of markers, which are special to subpart “###MAIN_ORG”:

###LABEL_PERSONS###

Marker

###LABEL_PERSONS###

Subpart

<!-- ###MAIN_ORG### -->

Description

Label “persons belonging to this organization”, taken from locallang.xml.

###PERSONS###

Marker

###PERSONS###

Subpart

<!-- ###MAIN_ORG### -->

Description

Link list of persons belonging to the currently displayed organization.

The following subparts reside inside the subparts “###MAIN_PERSON###” and “###MAIN_ORG###”. They are used to display comments on persons or organizations.

<!-- ###SUB_COMMENTS_INPUT### -->

Subpart

<!-- ###SUB_COMMENTS_INPUT### -->

Description

Contains form elements to comment give comments.

<!-- ###SUB_COMMENTS### -->

Subpart

<!-- ###SUB_COMMENTS### -->

Description

List of comments to person or organization.

###FORMURL###

Marker

###FORMURL###

Subpart

<!-- ###SUB_COMMENTS_INPUT### -->

Description

Contains URL of form to jump to when submitting POST data.

###COMMENTS###

Marker

###COMMENTS###

Subpart

<!-- ###SUB_COMMENTS### -->

Description

Contains all available comments.

###DATE###

Marker

###DATE###

Subpart

<!-- ###COMMENT### -->

Description

Date comment was created.

###COMMENTEDBY###

Marker

###COMMENTEDBY###

Subpart

<!-- ###COMMENT### -->

Description

User who gave the comment, only if flexform setting “user must login to comment” is activated.

###BELONGSTO###

Marker

###BELONGSTO###

Subpart

<!-- ###COMMENT### -->

Description

If contact type is “company”, this marker is filled with the name of the person the comment belongs to.

###STATUS###

Marker

###STATUS###

Subpart

<-- ###GENERAL_ERROR### -->

Description

CSS-Class to highlight error in a specific color.

###ERRORTEXT###

Marker

###ERRORTEXT###

Subpart

<-- ###GENERAL_ERROR### -->

Description

Error message, taken from locallang.xml

###BACKLINK###

Marker

###BACKLINK###

Subpart

<-- ###GENERAL_ERROR### -->

Description

Page-URL to link back at on error.

Reference

plugin.ke_contacts properties: TS configuration.

Template settings:
templates.delete

Property

templates.delete

Data type

resource

Description

HTML-template for mode “delete”.

Example:

plugin.ke_contacts {
  templates.delete = fileadmin/templates/con_delete.html
}

Default

templates.editcreate

Property

templates.editcreate

Data type

resource

Description

HTML-template for modes “edit” and “create”.

Example:

plugin. ke_contacts {
  templates.editcreate = fileadmin/templates/con_edcr.html
}

Default

templates.list

Property

templates.list

Data type

resource

Description

HTML-template for mode “list”.

Example:

plugin. ke_contacts {
  templates.list = fileadmin/templates/con_list.html
}

Default

templates.single

Property

templates.single

Data type

resource

Description

HTML-template for single view.

Example:

plugin. ke_contacts {
  templates.single = fileadmin/templates/con_single.html
}

Default

CSS settings:
styles.file

Property

styles.file

Data type

resource

Description

Defines alternative CSS file to use. Styles for all modes must be merged in one single file.

Example:

plugin. ke_contacts {
  styles.file = fileadmin/css/contacts.css
}

Default

Form element settings:
formFields.FIELDNAME

Property

formFields.FIELDNAME

Data type

string

Description

Name of form field, also used as “name” attribute in HTML source.

Default

formFields.FIELDNAME.type

Property

formFields.FIELDNAME.type

Data type

string

Description

Possible values:

  • contacttype (dropdown element to specify type of contact)
  • organization (organization a person belongs to)
  • gender (selectbox male / female)
  • input (html input field)
  • country (country selection by selectbox with values related to static_info_table)
  • birthday (input field with datepicker)

Default

formFields.FIELDNAME.required

Property

formFields.FIELDNAME.required

Data type

boolean

Description

Form field is mandatory (=1) or optional (=0).

Default

0

formFields.FIELDNAME.validate

Property

formFields.FIELDNAME.validate

Data type

string

Description

Various validation methods:

  • Int (valid integer value)
  • gender (valid gender)
  • nocountry (no country was selected from country select box)
  • birthday (valid date required)
  • email (valid e-mail address required)

Default

formFields.FIELDNAME.dbFieldName

Property

formFields.FIELDNAME.dbFieldName

Data type

string

Description

Set this property if you added a new field to database table “tt_address”. Specify the fieldname of your new field exactly as defined in database.

Default

Compare “EXT:/pi1/static/setup.txt” as example.

Settings for creation of a contact:
createview.defaultcountry

Property

createview.defaultcountry

Data type

string

Description

Defines a default country for selection of country in creation view.

Value refers to field “cn_short_de” of database table “static_countries”

Example:

plugin. ke_contacts {
  createview.defaultcountry = Deutschland
}

Default

Deutschland

Sorting the contact list:
listview.sort.dbfield

Property

listview.sort.dbfield

Data type

string

Description

Database field of table “tt_address” to sort list of contacts by.

Example:

plugin. ke_contacts {
  listview.sort.dbfield = tt_address.first_name
}

Default

tt_address.last_name

listview.sort.sort

Property

listview.sort.sort

Data type

string

Description

Sort items of contact list ascending (= ASC) or descending (= DESC) by database field specified by property “dbfield” above.

Example:

plugin. ke_contacts {
  listview.sort.sort = DESC
}

Default

ASC

Defining labels and error values for own database fields in table “tt_address”:
_LOCAL_LANG.LANGUAGEKEY.edit_label_FIELDNAME

Property

_LOCAL_LANG.LANGUAGEKEY.edit_label_FIELDNAME

Data type

string

Description

Value of a label for database field “FIELDNAME” used in “edit view”.

Example:

plugin. ke_contacts {
  _LOCAL_LANG.de {
    edit_label_testfeld = TEST LABEL VALUE IN FE
  }
}

Default

_LOCAL_LANG.LANGUAGEKEY.single_label_FIELDNAME

Property

_LOCAL_LANG.LANGUAGEKEY.single_label_FIELDNAME

Data type

string

Description

Value of a label for database field “FIELDNAME” used in “single view”.

Example:

plugin. ke_contacts {
  _LOCAL_LANG.de {
    single_label_testfeld = TEST LABEL VALUE IN FE
  }
}

Default

_LOCAL_LANG.LANGUAGEKEY.list_label_FIELDNAME

Property

_LOCAL_LANG.LANGUAGEKEY.list_label_FIELDNAME

Data type

string

Description

Value of a label for database field “FIELDNAME” used in “list view”.

Example:

plugin. ke_contacts {
  _LOCAL_LANG.de {
    list_label_testfeld = TEST LABEL VALUE IN FE
  }
}

Default

_LOCAL_LANG.LANGUAGEKEY.error_FIELDNAME

Property

_LOCAL_LANG.LANGUAGEKEY.error_FIELDNAME

Data type

string

Description

Value of a label for database field “FIELDNAME” used in “edit view”.

Example:

plugin. ke_contacts {
  _LOCAL_LANG.de {
    error_testfeld = REQUIRED FIELD
  }
}

Default

Add your own database fields to ke_contacts

Introduction

Please follow the steps below to

  • add a field called “testfield” to every view and display its data
  • save data to this field

Extend typoscript configuration

Add information about your database field to your typoscript configuration.

plugin.tx_kecontacts_pi1 {
        _LOCAL_LANG.default {
                #Label displayed in edit view
                edit_label_testfield = Label Testfeld EDIT
                #Label displayed in single view
                single_label_testfield = Label Testfeld SINGLEVIEW
                #Label displayed in list view
                list_label_testfield = Label Testfeld LISTVIEW
                #Error message if field validation fails
                error_testfield = Fehlermeldung Testfeld
        }

        formFields {
                #internal name of your field, no need to name it like database field if you use                      #"dbFieldName"-setting (see below)
                testfield {
                        #type of field to render in frontend
                        type=input
                        #field is required and must contain any value
                        required=1
                        #validation method
                        validate=
                        #if you added a new field to table "tt_address", please specify database fieldname                                 #here
                        dbFieldName = testfield_db
                }
        }
}

Add markers to your html templates

You can add the following markers to list, view or edit template of “ke_contacts”, they will be filled automatically as long as you specified your new field as shown in typoscript above:

  • ###LABEL_TESTFIELD### , contains the label value for our new field (specified in typoscript above)
  • ###TESTFIELD##, contains form field or value (depends on used template)
  • ###ERROR_TESTFIELD### , contains error message in case field is required and not filled or validation failed (specified in typoscript above)

Clear cache

Clear cache, switch to frontend and see the result Your new field should appear now.

Extending RealURL-Configuration

Map extension piVars in your RealURL correctly by adding the following code to your RealURL-configuration file:

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['realurl']['_DEFAULT'] = array(
     'postVarSets' => array(
        '_DEFAULT' => array (
                      'kontakte' => array(
                             array(
                                      'GETvar' => 'tx_kecontacts_pi1[headerDropDown]',
                                 'noMatch' => 'bypass',
                           ),
                          array(
                                      'GETvar' => 'tx_kecontacts_pi1[sword]',
                                  'noMatch' => 'bypass',
                           ),
                          array(
                                      'GETvar' => 'tx_kecontacts_pi1[pointer]',
                                        'noMatch' => 'bypass',
                           ),
                          array(
                                      'GETvar' => 'tx_kecontacts_pi1[mode]',
                                   'valueMap' => array(
                                             'bearbeiten' => 'edit',
                                          'erstellen' => 'create',
                                         'einzelansicht' => 'single',
                                             'loeschen' => 'delete',
                                  ),
                                  'noMatch' => 'bypass',
                           ),
                          array(
                                      'GETvar' => 'tx_kecontacts_pi1[id]',
                                     'lookUpTable'       => array(
                                            'table'                 => 'tt_address' ,
                                                'id_field'              => 'uid',
                                                'alias_field'           => 'uid',
                                                'addWhereClause'        => ' AND NOT deleted',
                                           'useUniqueCache'        => 1,
                                            'useUniqueCache_conf'   => array(
                                                        'strtolower'            => 1,
                                                    'spaceCharacter'        => '_',
                                          ),
                                  ),
                          ),
                  ),
          ),
  ),
);

Known problems

None so far.

To-Do

Complete manual.

Changelog

See external file.

img-11 EXT: ke_contacts - 16