Welcome to the plugin-p01-contact wiki!

Download or clone the repository, then place the p01-contact/ directory and the file p01-contact_gs.php in plugins/.

Just write tags in your pages according to the syntax.

This is a default contact form :
    
(% contact %)
    
Simple.

Reminds you to fill the Meta Description accessible in page options. If you don't, GetSimple will show the tag source in the source code of the output page.

You can use it in components, themes or templates by manipulating the variable $p01contact, already initialized. For example, to add a default contact form in your sidebar :

<?php
get_component('sidebar');
echo $p01contact->parse('(% contact %)');
?>

The plugin settings are accessible in the GetSimple administration.

When Debug is enabled in the plugin settings, a debug report is shown before the pages.

The settings are stored in a config.json file. This file shouldn't be edited manually, as a functional configuration panel can be displayed using :

echo $p01contact->panel();

This panel is accessible in the supported CMS, see GetSimple plugin#configuration or Pico CMS plugin#configuration.

The default global language is English, or may be set trough code.
When used as a CMS plugin, the global default language will match the system one.

Each form can override this setting and be defined to a specific language.

$p01contact = new P01contact();
$p01contact->default_lang = 'ru';

$form = new P01contactForm($p01contact);
$form->lang = 'fr';

In tags syntax :

(% contact fr %)

These options allows to define required or prohibited terms for specific fields types.

The first field indicates the field type, for example email, the second input define the rule type :

• Blacklist : prohibited values that must not be present in the given field.
• Whitelist : possible values required for the given field.

The last field contains the list of terms, separated by commas.

These options allow to configure the security mechanisms included by default or to setup additional measures.

The system will also detect and prevent the user to send again a submitted form (ex. reloading the page).

The native anti-spam and anti-error mechanisms should prevent all undesirable submissions. If you need a higher level of security you can insert a Google reCaptcha by using a captcha field and defining the public and secret keys.

These settings may be useful for debugging.

The debug data can be shown with :

$p01contact->debug();

This page describe the tags syntax that can be parsed from text, for exemple from CMS pages content. Each tag generates a distinct functional form.

This is a default contact form :

(% contact %)

Simple.

Parameters are separated by commas and listed after a semicolon.

(% contact : parameter, parameter, ... %)
(% contact : 
    parameter,
    parameter,
    ...
%)

Parameters can be email addresses or fields.

(% contact : address@domain.ext, another@domain.ext, ... %)
(% contact : field, field, field, ... %)
(% contact : address@domain.ext, field, field, ... %)

If you don't specify addresses, the form will use the default ones defined in settings. If you don't specify fields, the form will use the default ones defined in settings.

The word contact may be followed by a two-letters language code to set the form language. Known fields and messages will be translated (see i18n).

(% contact fr %)

Any standard field type will be displayed accordingly on the form and will report its value in the received email.

Modern browsers will provide suitable fields inputs and validate their content. Some of them are also validated server-side like email, url and tel.

Some fields types will have an additional behavior :

The field options are defined after the field type, to customize it.

Checkbox, radio and select fields default value may have multiple options separated by vertical bars. By using a semicolon next to an option, you can define the selected one(s).

checkbox = a single option
checkbox = an option |: a selected option |: another selected option
radio = an option |: the selected option
select = option one | option two |: selected option three

Multiple options have to be used in the following order :

fieldType! "text" => value | value

Default :

(% contact %)

Default with two custom recipients :

(% contact : recipient@domain.ext, other@domain.ext %)

A custom minimal one :

(% contact : email!, message! %)

A custom big one :

(% contact fr : 
    address@domain.ext, another@domain.ext,
    subject => "About this script",
    email!,
    textarea "How old is born Napoléon?",
    tel,
    radio "Do you like this script?" = Yes | No, 
    url (Website or blog),
    select = One | Two :| Three | Four | Five ,
    message! = Say something,
    password = tomato,
    askcopy
%)