EXT: dm Address Edit¶

What does it do?¶

This extension is a mix of some FE extensions with some error corrections, particularly nicosdirectory, sp_directory and fileUpload. I nedded a FE extension for fast and user friendly editing of tt_address records (including the fields for the direct mail extension) with an simplecsv export of all records.

With dmAddrEdit it's possible to define for each FE user:

- the tt_address sysfolder(s) that can be edited

- which tt_address fields are visible

- which tt_address fields will be exported in a csv file.

Why did I wrote this extension? Well, imagine there's a large page tree with many independent branches and corresponding domains (= sites). Each site has it's own direct mail module and therefore one ore more relevant sysfolders for the storage of the tt_address records. Every sysfolder should be edited by another FE user. Normally, you must install a separate edit page for every sysfolder/FE user or you have to use extensions like sp_directory , but without the possibility to edit the direct mail related fields.

With dmAddrEdit you get a powerful extension to edit tt_address records in the Frontend (FE) without the need to edit parts in the Backend (BE). If direct mail is installed, the corresponding fields will also be shown and modified. The output of the extension is fully configurable trough TS and tuning the template.

Fields to hide¶

You can set in TS template setup the names of the tt_address fields that will be hidden in the single view:

plugin.tx_dmaddredit_pi1.hideFields = fax,mobile,www

In this case you set this option for the extension independently of the actual FE user. If you want to hide fields depending on the FE user, use the field tx_dmaddredit_hidefields in the fe_user table and enter the names of the fields to hide:

Then, use the folling TS code lines in the template setup ( kb_betterstdwrap (available in TER) needs to be installed for using this feature):

temp.hideFields = TEXT
temp.hideFields.value = {glob:TSFE:fe_user:user:tx_dmaddredit_hidefields}
temp.hideFields.insertData = 1
plugin.tx_dmaddredit_pi1.hideFields.cObject < temp.hideFields

What to export as csv?¶

Normally, when a FE user exports the address list to a csv file, all fields in the tt_address table will be used. Example:

uid,pid,tstamp,hidden,name,title,email,phone,mobile,www,address,company,city,zip,country,image,fax,deleted,description,module_sys_dmail_category,module_sys_dmail_html

51,"51","1115408448","0","Sebastian Heinzelhuber","","seb@grmbl.edu","98643","457634","www.ffdgsdfg.com","Elsterweg 111","","Nembech","99999","","pic_mann.gif","134787","0","Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore.","3","1"

uid,pid,name,email,module_sys_dmail_category,module_sys_dmail_html

51,"51","Sebastian Heinzelhuber","seb@grmbl.edu","3","1"

temp.csvFields = TEXT
temp.csvFields.value = {glob:TSFE:fe_user:user:tx_dmaddredit_csvfields}
temp.csvFields.insertData = 1
plugin.tx_dmaddredit_pi1.csvFields.cObject < temp.csvFields

How to configure the output?¶

You can modify the apperance of the output by setting some TS values (see 'Configuration') and adapting the template. Copy the extension template (...dmaddredit/pi1/directory.tmpl) to a folder of your choice an style the code in the copied template file as you like.

Hint if you plan to overwork the template¶

You may want to present the user a overworked template with a minimal selection of fields in the ENTERVIEW_xx part. For example, the FE user should see only the input fields for 'name' and 'eMail' and nothing else. But it's necessary for the edit form to submit the pid of the sysfolder, where the new or modified record should be stored.

In this case you must provide a hidden input field in the form, ENTERVIEW_xx part, that transmits this value:

<input type="hidden" name="tx_dmaddredit_pi1[sysfoldername]" id="sysfoldername" value="###DEFAULTSYSFOLDER###" />

If there are more than one sysfolders possible (see 'Configuration' -> 'pidList'), the value of DEFAULTSYSFOLDER will be the first pid in the array (e.g. 'pidList = 51,138' will be converted to '51' and 'pidList = 138,51' changes to '138').

Don't use this hidden input in conjunction with SYSFOLDERNAME!

What's the secret behind the 'newsletter category mask'?¶

For the use with the direct mail module, the newsletter format (HTML or plain) is easy to understand (field module_sys_dmail_html in table tt_address ). But what does the number in the 'newsletter category mask' mean (field module_sys_dmail_category in table tt_address )? (By the way: it's a good tip to read the direct mail tutorial from Marlies Cohen first (available in TER). You get a better understanding of the following part.)

Well, if there is only one newsletter that can be subscribed in the direct mail subscription module then the corresponding value for the newsletter categorie mask is '1' for a subscription or '0' for no newsletter subscription.

But what if there are two or more newsletter categories (NL) a user can subscribe to? How is this coded?

Well, simple: the first category has the value '1', the second category is '2' and so on... If a user subscribes to NL1 you need the value '1', for NL2 it's '2' and for the combination NL1+NL2 the value is '3'.

Check this out if you have a corresponding setup with two or more direct mail categories. What values do you see in the field module_sys_dmail_category for all the possible combinations? Then you know what values to write in the newsletter categorie mask part of the edit dialog.

How to adapt the language related output?¶

You can change words and sentences as you like to without modifying the language file '...dmaddredit/pi1/locallang.php' to be update safe. Simply use the syntax of the following line in the template setup:

plugin.tx_dmaddredit_pi1._LOCAL_LANG.LANGUAGE_KEY.IDENTIFIER = value

Example:

plugin.tx_dmaddredit_pi1._LOCAL_LANG.de.description = Anmerkung

If you send me the translated locallang.php part of your language, I'll include it and upload the new file to TER.

Spamprotect for tt_address¶

Under some circumstances the global spam protection

config {
  spamProtectEmailAddresses = 2
  spamProtectEmailAddresses_atSubst = (at)
}

has no effect. Then this code snippet may be helpful (thanks to Peter Bachmann):

###############################
# Spam Protect für tt_Address #
###############################
tt_address {
  20 {
    25 >
    25 = TEXT
    25.if.isTrue.field = email
    25.typolink.parameter.field = email
    25.dataWrap = <br /><a href={field:email}></a>
  }
}

(see this german posting: http://www.typo3.net/forum/list/list_post/ /11007/?sword_list%5B%5D=spamprotect )

Reference¶

plugin.tx_dmaddredit_pi1.templateFile = fileadmin/addrtemplate.tmpl

EXT:dmaddredit/pi1/directory.tmpl

title,phone,mobile,www,address,company,city,zip,country,image,fax,description,module_sys_dmail_category,module_sys_dmail_html

*

*

*

1

10

210000

<table border=0><tr><td><img src=/t3lib/gfx/i/folder.gif><strong> | </strong></td></tr></table>

EXT:dmaddredit/pi1/check_on2.gif

EXT:dmaddredit/pi1/check_off2.gif

EXT:dmaddredit/pi1/check_on2.gif

EXT:dmaddredit/pi1/check_off2.gif

plugin.tx_dmaddredit_pi1.image {
    params = border=0 style="float:left;margin-left:10px;margin-bottom:10px";
    file.maxH = 120
    file.maxW = 120
    imageLinkWrap = 1
    imageLinkWrap {
      enable = 1
      bodyTag (
        <body bgcolor="#FFFFFF" leftmargin="2" topmargin="2" marginwidth="2" marginheight="2">
      )
      wrap = <a href="javascript:close();"> | </a>
      width = 800m
      height = 600m
      JSwindow = 1
      JSwindow.newWindow = 1
      JSwindow.expand = 4,4
      title = Big view
    }
  }

.tx_dmaddredit-pi1-myform { font-family: Verdana, Arial, Helvetica, sans-serif;font-size: 10px; }
.tx_dmaddredit-pi1-myformactive { font-family: Verdana, Arial, Helvetica, sans-serif;font-size: 10px; color: #CC0000; }
.tx_dmaddredit-pi1-dotted { border: 1px solid #DADADA; }
.tx_dmaddredit-pi1-small { font-size: 10px; }
.tx_dmaddredit-pi1-mini { align: right; font-size: 8px; }
.tx_dmaddredit-pi1-dottedcorner { border-top: 0px none; border-right: 0px none; border-bottom: 2px dotted #DADADA; border-left: 2px dotted #DADADA; }
.tx_dmaddredit-pi1-dottedcolor { border: 2px dashed #EEEEFD; }
.tx_dmaddredit-pi1-active { color: #CC0000; }
.tx_dmaddredit-pi1-inactive { color: #999999; }
.tx_dmaddredit-pi1-mini-light { font-size: 9px; color: gray; }