API:EPrints/MetaField/Date: Difference between revisions

Latest revision as of 14:31, 11 April 2012

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::MetaField::Date - dates

DESCRIPTION

This field is used to store a single date. The notation used is YYYY-MM-DD, where YYYY is the 4-digit year, MM is the 2 digit month (starting at 01) and DD is the 2 digit day of the month (starting at 01).

MM and DD may be omitted, giving the following possible values:

  YYYY-MM-DD
  YYYY-MM
  YYYY

Database

[fieldname]_year SQL_SMALLINT
[fieldname]_month SQL_TINYINT
[fieldname]_day SQL_TINYINT

Searching

Date fields can be searched as either single values or ranges. Searching for "2006" will also match 2006-12-25. You can search for "2000.." to search dates in or after 2000. Or "2000-12..2003-01" for December 2000 through January 2003.

PROPERTIES

In addition to those properties available in EPrints::MetaField:

input_style

"long"

Render labeled text entry boxes for year, month and day.

"short"

Render a single text entry box with a Javascript date picker.

render_res

Reduce the resolution the date is shown as.

"day"
"month"
"year"

render_style

"long"

Render the full month name.

"short"

Render an abbreviated month name.

METHODS

COPYRIGHT

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.

@@ Line 1: / Line 1: @@
+<!-- Pod2Wiki=_preamble_
+This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
+ -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/MetaField/Date.pm|package_name=EPrints::MetaField::Date}}[[Category:API|DATE]][[Category:API:EPrints/MetaField|DATE]][[Category:API:EPrints/MetaField/Date|DATE]]<div><!-- Edit below this comment -->
+<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
+==NAME==
+EPrints::MetaField::Date - dates
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_description -->
+==DESCRIPTION==
+This field is used to store a single date. The notation used is <code>YYYY-MM-DD</code>, where <code>YYYY</code> is the 4-digit year, <code>MM</code> is the 2 digit month (starting at 01) and <code>DD</code> is the 2 digit day of the month (starting at 01).
+<code>MM</code> and <code>DD</code> may be omitted, giving the following possible values:
+<pre>  YYYY-MM-DD
+  YYYY-MM
+  YYYY</pre>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_database -->
+===Database===
+* [fieldname]_year SQL_SMALLINT
+* [fieldname]_month SQL_TINYINT
+* [fieldname]_day SQL_TINYINT
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_searching -->
+===Searching===
+Date fields can be searched as either single values or ranges. Searching for "2006" will also match 2006-12-25. You can search for "2000.." to search dates in or after 2000. Or "2000-12..2003-01" for December 2000 through January 2003.
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_properties -->
+==PROPERTIES==
+In addition to those properties available in [[API:EPrints/MetaField|EPrints::MetaField]]:
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_input_style -->
+===input_style===
+* "long"
+: Render labeled text entry boxes for year, month and day.
+* '''"short"'''
+: Render a single text entry box with a Javascript date picker.
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_render_res -->
+===render_res===
+Reduce the resolution the date is shown as.
+* '''"day"'''
+* "month"
+* "year"
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_render_style -->
+===render_style===
+* '''"long"'''
+: Render the full month name.
+* "short"
+: Render an abbreviated month name.
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_methods -->
+==METHODS==
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=head_copyright -->
+==COPYRIGHT==
+Copyright 2000-2011 University of Southampton.
+This file is part of EPrints http://www.eprints.org/.
+EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+<!-- Pod2Wiki=_postamble_ -->
+<!-- Edit below this comment -->