Difference between revisions of "Counter field"
(Spacing after ToC) |
(Moved description to top. Added link to API page.) |
||
| Line 1: | Line 1: | ||
{{fieldtypes}} | {{fieldtypes}} | ||
| + | |||
| + | == Description == | ||
| + | This field represents an integer whose default value is an incrementing integer (1,2,3 ...). | ||
== Inheritance == | == Inheritance == | ||
| Line 6: | Line 9: | ||
** [[Int field]] | ** [[Int field]] | ||
*** [[Counter field]] | *** [[Counter field]] | ||
| − | |||
| − | |||
| − | |||
== Properties == | == Properties == | ||
| Line 20: | Line 20: | ||
== Required Phrases == | == Required Phrases == | ||
| − | No additional phrases | + | No additional phrases. |
== Database == | == Database == | ||
| Line 27: | Line 27: | ||
== API == | == API == | ||
| − | + | See [[API:EPrints/MetaField/Counter|API page]]. | |
== Examples == | == Examples == | ||
Revision as of 08:20, 21 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
Description
This field represents an integer whose default value is an incrementing integer (1,2,3 ...).
Inheritance
Properties
| name | default | description |
| digits | n/a | This property is taken from the repository configuration. |
| sql_counter | n/a | REQUIRED. This property is taken from the repository configuration. |
Required Phrases
No additional phrases.
Database
Counter fields are stored in the database as
fieldname INT(11)
API
See API page.
Examples
Most basic example. sql_counter is required but typically would be set to the same as name.
{
name => "mycounter",
type => "counter",
sql_counter => "mycounter"
}
Typically, you would not want to allow a value for this field to be imported or cloned as it is an auto-incremented field.
{
name => "subjectcounter",
type => "counter",
required => 1,
import => 0,
can_clone => 0,
sql_counter => "subjectcounter"
},
