BraDypUS CMS
BraDyCMS has a built-in (core) plugin to help you deal with web-form and collect data from your users easily. You can create all the web forms you need and embed them in article bodies. You can easily customize all fields and add file uploading buttons, just editing the main configuration file.
The plugin is located in:
Main menu > Plugins > User forms Or use [direct link](#userform/view).
To create a new custom form click the Add new user form button and enter a form id.
Please remember, form ids must be unique. No spaces, dashes, hyphens or
other special characters are allowed in the form id. Once the new form has been
created you can customize it to meet your needs. See the Custom form syntax for
details.
Embedding a form in an article’s body is very simple. Just use the custom tag
[[userform]] with the name/id of your form.
For example, to embed the form named contactus in an article’s body just
add this simple tag:
[[userform]]contactus[[/userform]] You can aso provide a subject directly in the form definition, overwriting the custom one defined in the configuration file, e.g:
[[userform subject="Contact us"]]contactus[[/userform]]
BraDyCMS will do the rest for you: form formatting, validation and text and attachments delivery.
The configuration of a user form must follow a simple but rigid syntax. The configuration file must be a valid json file. BraDyCMS integrates a real-time validator to help finding any syntax error.
to, string, required. A valid email address to use to send the form data to.from_email, string, required. A valid email address. This address will be
shown in the email header as the sender of the automatic emailfrom_name, string, optional, default none. A person name or other. This name
will be shown in the email header as the sender of the automatic email, together
with the from_email addresssubject, string, required. Email message subject. This setting can be
overwritten in the article content of template file where the form is rendered.success_text, string, required. Message to display to users filling the
form when the email message is successfully senterror_text, string, required. Message to display when email to users filling
the form when the email message is NOT successfully sentto_user, string, optional, default: false. Enter here the required name
of an email input, specified below. A copy of the email send to the admins will
be sent to this email address too.confirm_text, string, optional, default: false. This option will be used id the
to_user option is set. This will be the custom text message sent in reply t the user.
Variables with fields name can be used in the text. These will be replaced on runtime
with user entered values.inline, boolean, optional, default: false. If this value is present and is true input
labels will be displayed inline, on the right of the text inputs, otherwise
(default value) the label will be displayed above the field.smtp_host, string, optional, default: false. The SMTP server (or servers separated by semicolon), eg.: ‘smtp1.example.com;smtp2.example.com’smtp_auth, boolean, optional, default false. If true SMTP authentication is enabledsmtp_username, string, optional, default false. SMTP usernamesmtp_password, string, optional, default false. SMTP passwordsmtp_secure, string, optional, default false. SMTP encryption, can be ‘tls’ or ‘ssl’smtp_port, string, optional, default false. TCP port to connect toPartial example
{
"to": "info@bradypus.com",
"from_email": "info@bradypus.com",
"from_name": "BraDypUS communicating cultural heritage",
"subject": "Contact form",
"success_text": "Your message was successfully sent",
"error_text": "Sorry, something went wrong and it was not possible to send your message"
"inline": true,
"to_user": "email",
"confirm_text": "Dear %name%\nThank you for your message.\n\nYou are receiving this message because you filled a form on our site. If you did not, please report this abuse at info@bradypus.net.\n\nRegards\nBraDypUS team",
...
}
If
smtp_host,smtp_username,smtp_password,smtp_portare defined the SMTP protocol will be used, otherwise the PHP’s
Form elements should be defined as an array. There is not a limit to the number of form elements that can be added to a form.
Each element should have a unique name and one of the predefined types.
name, string, required. Unique name. No whitespaces or special characters
should be used. This value will be not visible to end users and will be used
only for internal referencelabel, string, optional. This value will be used as label for inputs and will
be visible to end users.placeholder, string. optional. Placehoder text to use for inputs, visible to users.type, string, optional, default value: text. Type of input field to display to end users. One of the following can be used:
text: a simple, one line, input field will be shown. This is the default valuedate: a simple, one line, input field will be shown with the date widget (bootstrap-datepicker will be used)longtext: a simple multi-line input field will be shown
select: a drop down list will be shown. For select to work properly
the options parameter must be provided.upload: this will show a button that can be used to upload files.
For upload to work properly the sizeLimit and allowedExtensions can be providedoptions, array, required if type is select. Array of values to use as
predefined options for drop down listis_required, boolean, default: false. If true or if defined the field
value can not be empty, users can not submit the form and warning message will be shown.is_email, boolean, optional, default: false. If true or if defined the field
value will be checked to match a valid email pattern. In case of errors
users can not submit the form and warning message will be shown.sizeLimit, integer, optional. The size limit for files to upload expressed in in bytes.
This option is available only if field type is upload. If user tries to upload a
bigger file a warning message is shown and the file is not uploadedallowedExtensions, array, optional. Array with allowed file extensions.
This option is available only if field type is upload. If user tries to upload
a file with a different extension a warning message is shown and the file is not uploaded.If a field named subject is available and it is not empty, this value will overwrite default subject
{
"to": "info@bradypus.com",
"from_email": "info@bradypus.com",
"smtp_host": "smtp1.example.com;smtp2.example.com",
"smtp_auth": true,
"smtp_username": "info@bradypus.com",
"smtp_password": "secret",
"smtp_secure": "tls",
"smtp_port": 587,
"from_name": "BraDypUS communicating cultural heritage",
"subject":"Contact form",
"success_text":"Your message was successfully sent",
"error_text": "Sorry, something went wrong and it was not possible to send your message"
"inline": true,
"to_user": "email",
"confirm_text": "Dear %name%\nThank you for your message.\n\nYou are receiving this message because you filled a form on our site. If you did not, please report this abuse at info@bradypus.net.\n\nRegards\nBraDypUS team",
"elements": [
{
"name": "name",
"label": "Name",
"placehoder": "Name",
"type": "text",
"is_required": "true"
},
{
"name": "email",
"label": "Email address",
"placeholder": "Email address",
"type": "text",
"is_required": "true",
"is_email": "true"
},
{
"name": "phone_no",
"label": "Phone number",
"placeholder": "Phone number",
"type": "text"
},
{
"name": "location",
"label": "Location",
"type": "text"
},
{
"name": "how_did_you_hear_about_us",
"label": "How did you hear about us?",
"placehoder": "How did you hear about us?",
"type": "select",
"options": [
"google",
"email message",
"friends"
]
},
{
"name": "comments",
"label": "Comments",
"placeholder": "Comments",
"type": "longtext"
},
{
"name": "uploadcv",
"label": "Upload your CV",
"type": "upload",
"sizeLimit": "2097152",
"allowedExtensions": [
"pdf",
"doc",
"docx",
"odt"
]
}
]
}