Email field: Difference between revisions
mNo edit summary |
Added examples. Improved other sections unhide ToC. |
||
| Line 1: | Line 1: | ||
{{fieldtypes}} | {{fieldtypes}} | ||
== Inheritance == | == Inheritance == | ||
| Line 9: | Line 10: | ||
== Description == | == Description == | ||
This field works just like a text field except that | This field works just like a text field except that | ||
* it gives a validation error if it does not appear to be a valid email address | * it gives a validation error if it does not appear to be a valid email address | ||
* when rendered it is rendered as a mailto: link to the email (unless the render_dont_link property is set). | * when rendered it is rendered as a <tt>mailto:</tt> link to the email (unless the <tt>render_dont_link</tt> property is set). | ||
== Properties == | == Properties == | ||
Same as [[Id field]], except | |||
{| border="1" cellpadding="3" cellspacing="0" | |||
| name || default || description | |||
|- | |||
| '''render_dont_link''' || 0 || ''as for [[Metadata]] but actually applicable.'' | |||
|- | |||
|} | |||
== Required Phrases == | |||
No additional phrases. | |||
== | == Database == | ||
Email fields are stored in the database as | |||
fieldname VARCHAR(255) | |||
== API == | |||
See [[API:EPrints/MetaField/Email|API page]]. | |||
== Examples == | |||
Most basic example. | |||
{ | |||
name => "contact_email", | |||
type => "email", | |||
} | |||
Do not render the email address as a <tt>mailto:</tt> link. | |||
{ | |||
name => "user_email", | |||
type => "email", | |||
render_dont_link => 1, | |||
} | |||
Revision as of 16:21, 20 March 2023
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid
Inheritance
Description
This field works just like a text field except that
- it gives a validation error if it does not appear to be a valid email address
- when rendered it is rendered as a mailto: link to the email (unless the render_dont_link property is set).
Properties
Same as Id field, except
| name | default | description |
| render_dont_link | 0 | as for Metadata but actually applicable. |
Required Phrases
No additional phrases.
Database
Email fields are stored in the database as
fieldname VARCHAR(255)
API
See API page.
Examples
Most basic example.
{
name => "contact_email",
type => "email",
}
Do not render the email address as a mailto: link.
{
name => "user_email",
type => "email",
render_dont_link => 1,
}