⧼vector-jumptocontent⧽

Counter field: Difference between revisions

From EPrints Documentation
Added counter field page
 
Added standard sections some with content. Unhide ToC
Line 1: Line 1:
{{fieldtypes}}
{{fieldtypes}}
__NOTOC__
 
== Inheritance ==
== Inheritance ==
* [[Metadata]]
* [[Metadata]]
** [[Int field]]
** [[Int field]]
Line 11: Line 10:


== Properties ==
== Properties ==
{| border="1" cellpadding="3" cellspacing="0"
{| border="1" cellpadding="3" cellspacing="0"
| name || default || description  
| name || default || description  
|-
|-
| '''digits''' || n/a || '''This property is taken from the repository configuration.'''
| '''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 ==
== Required Phrases ==
 
No additional phrases required.


== Database ==
== Database ==
Counter fields are stored in the database as
fieldname INT(11)


Counter fields are stored in the database as
== API ==
''To be added''


  fieldname INT(11)
== Examples ==
Most basic example. <tt>sql_counter</tt> is required but typically would be set to the same as <tt>name</tt>.
  {
    name => "mycounter",
    type => "counter",
    sql_counter => "mycounter"
}
Typically, you would noty 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"
},

Revision as of 09:28, 20 March 2023

Inheritance

Description

This field represents an integer whose default value is an incrementing integer (1,2,3 ...).

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 required.

Database

Counter fields are stored in the database as

fieldname INT(11)

API

To be added

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 noty 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" 
},