Club Drupal

Date Module 8.x

=================

                    GNU GENERAL PUBLIC LICENSE

                       Version 2, June 1991

 Copyright (C) 1989, 1991 Free Software Foundation, Inc.,

 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

 Everyone is permitted to copy and distribute verbatim copies

 of this license document, but changing it is not allowed.

                            Preamble

  The licenses for most software are designed to take away your

freedom to share and change it.  By contrast, the GNU General Public

License is intended to guarantee your freedom to share and change free

software--to make sure the software is free for all its users.  This

General Public License applies to most of the Free Software

Foundation's software and to any other program whose authors commit to

using it.  (Some other Free Software Foundation software is covered by

the GNU Lesser General Public License instead.)  You can apply it to

your programs, too.

  When we speak of free software, we are referring to freedom, not

price.  Our General Public Licenses are designed to make sure that you

have the freedom to distribute copies of free software (and charge for

this service if you wish), that you receive source code or can get it

if you want it, that you can change the software or use pieces of it

in new free programs; and that you know you can do these things.

  To protect your rights, we need to make restrictions that forbid

anyone to deny you these rights or to ask you to surrender the rights.

These restrictions translate to certain responsibilities for you if you

distribute copies of the software, or if you modify it.

  For example, if you distribute copies of such a program, whether

gratis or for a fee, you must give the recipients all the rights that

you have.  You must make sure that they, too, receive or can get the

source code.  And you must show them these terms so they know their

rights.

  We protect your rights with two steps: (1) copyright the software, and

(2) offer you this license which gives you legal permission to copy,

distribute and/or modify the software.

  Also, for each author's protection and ours, we want to make certain

that everyone understands that there is no warranty for this free

software.  If the software is modified by someone else and passed on, we

want its recipients to know that what they have is not the original, so

that any problems introduced by others will not reflect on the original

authors' reputations.

  Finally, any free program is threatened constantly by software

patents.  We wish to avoid the danger that redistributors of a free

program will individually obtain patent licenses, in effect making the

program proprietary.  To prevent this, we have made it clear that any

patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and

modification follow.

                    GNU GENERAL PUBLIC LICENSE

   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. This License applies to any program or other work which contains

a notice placed by the copyright holder saying it may be distributed

under the terms of this General Public License.  The "Program", below,

refers to any such program or work, and a "work based on the Program"

means either the Program or any derivative work under copyright law:

that is to say, a work containing the Program or a portion of it,

either verbatim or with modifications and/or translated into another

language.  (Hereinafter, translation is included without limitation in

the term "modification".)  Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not

covered by this License; they are outside its scope.  The act of

running the Program is not restricted, and the output from the Program

is covered only if its contents constitute a work based on the

Program (independent of having been made by running the Program).

Whether that is true depends on what the Program does.

  1. You may copy and distribute verbatim copies of the Program's

source code as you receive it, in any medium, provided that you

conspicuously and appropriately publish on each copy an appropriate

copyright notice and disclaimer of warranty; keep intact all the

notices that refer to this License and to the absence of any warranty;

and give any other recipients of the Program a copy of this License

along with the Program.

You may charge a fee for the physical act of transferring a copy, and

you may at your option offer warranty protection in exchange for a fee.

  2. You may modify your copy or copies of the Program or any portion

of it, thus forming a work based on the Program, and copy and

distribute such modifications or work under the terms of Section 1

above, provided that you also meet all of these conditions:

    a) You must cause the modified files to carry prominent notices

    stating that you changed the files and the date of any change.

    b) You must cause any work that you distribute or publish, that in

    whole or in part contains or is derived from the Program or any

    part thereof, to be licensed as a whole at no charge to all third

    parties under the terms of this License.

    c) If the modified program normally reads commands interactively

    when run, you must cause it, when started running for such

    interactive use in the most ordinary way, to print or display an

    announcement including an appropriate copyright notice and a

    notice that there is no warranty (or else, saying that you provide

    a warranty) and that users may redistribute the program under

    these conditions, and telling the user how to view a copy of this

    License.  (Exception: if the Program itself is interactive but

    does not normally print such an announcement, your work based on

    the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole.  If

identifiable sections of that work are not derived from the Program,

and can be reasonably considered independent and separate works in

themselves, then this License, and its terms, do not apply to those

sections when you distribute them as separate works.  But when you

distribute the same sections as part of a whole which is a work based

on the Program, the distribution of the whole must be on the terms of

this License, whose permissions for other licensees extend to the

entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest

your rights to work written entirely by you; rather, the intent is to

exercise the right to control the distribution of derivative or

collective works based on the Program.

In addition, mere aggregation of another work not based on the Program

with the Program (or with a work based on the Program) on a volume of

a storage or distribution medium does not bring the other work under

the scope of this License.

  3. You may copy and distribute the Program (or a work based on it,

under Section 2) in object code or executable form under the terms of

Sections 1 and 2 above provided that you also do one of the following:

    a) Accompany it with the complete corresponding machine-readable

    source code, which must be distributed under the terms of Sections

    1 and 2 above on a medium customarily used for software interchange; or,

    b) Accompany it with a written offer, valid for at least three

    years, to give any third party, for a charge no more than your

    cost of physically performing source distribution, a complete

    machine-readable copy of the corresponding source code, to be

    distributed under the terms of Sections 1 and 2 above on a medium

    customarily used for software interchange; or,

    c) Accompany it with the information you received as to the offer

    to distribute corresponding source code.  (This alternative is

    allowed only for noncommercial distribution and only if you

    received the program in object code or executable form with such

    an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for

making modifications to it.  For an executable work, complete source

code means all the source code for all modules it contains, plus any

associated interface definition files, plus the scripts used to

control compilation and installation of the executable.  However, as a

special exception, the source code distributed need not include

anything that is normally distributed (in either source or binary

form) with the major components (compiler, kernel, and so on) of the

operating system on which the executable runs, unless that component

itself accompanies the executable.

If distribution of executable or object code is made by offering

access to copy from a designated place, then offering equivalent

access to copy the source code from the same place counts as

distribution of the source code, even though third parties are not

compelled to copy the source along with the object code.

  4. You may not copy, modify, sublicense, or distribute the Program

except as expressly provided under this License.  Any attempt

otherwise to copy, modify, sublicense or distribute the Program is

void, and will automatically terminate your rights under this License.

However, parties who have received copies, or rights, from you under

this License will not have their licenses terminated so long as such

parties remain in full compliance.

  5. You are not required to accept this License, since you have not

signed it.  However, nothing else grants you permission to modify or

distribute the Program or its derivative works.  These actions are

prohibited by law if you do not accept this License.  Therefore, by

modifying or distributing the Program (or any work based on the

Program), you indicate your acceptance of this License to do so, and

all its terms and conditions for copying, distributing or modifying

the Program or works based on it.

  6. Each time you redistribute the Program (or any work based on the

Program), the recipient automatically receives a license from the

original licensor to copy, distribute or modify the Program subject to

these terms and conditions.  You may not impose any further

restrictions on the recipients' exercise of the rights granted herein.

You are not responsible for enforcing compliance by third parties to

this License.

  7. If, as a consequence of a court judgment or allegation of patent

infringement or for any other reason (not limited to patent issues),

conditions are imposed on you (whether by court order, agreement or

otherwise) that contradict the conditions of this License, they do not

excuse you from the conditions of this License.  If you cannot

distribute so as to satisfy simultaneously your obligations under this

License and any other pertinent obligations, then as a consequence you

may not distribute the Program at all.  For example, if a patent

license would not permit royalty-free redistribution of the Program by

all those who receive copies directly or indirectly through you, then

the only way you could satisfy both it and this License would be to

refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under

any particular circumstance, the balance of the section is intended to

apply and the section as a whole is intended to apply in other

circumstances.

It is not the purpose of this section to induce you to infringe any

patents or other property right claims or to contest validity of any

such claims; this section has the sole purpose of protecting the

integrity of the free software distribution system, which is

implemented by public license practices.  Many people have made

generous contributions to the wide range of software distributed

through that system in reliance on consistent application of that

system; it is up to the author/donor to decide if he or she is willing

to distribute software through any other system and a licensee cannot

impose that choice.

This section is intended to make thoroughly clear what is believed to

be a consequence of the rest of this License.

  8. If the distribution and/or use of the Program is restricted in

certain countries either by patents or by copyrighted interfaces, the

original copyright holder who places the Program under this License

may add an explicit geographical distribution limitation excluding

those countries, so that distribution is permitted only in or among

countries not thus excluded.  In such case, this License incorporates

the limitation as if written in the body of this License.

  9. The Free Software Foundation may publish revised and/or new versions

of the General Public License from time to time.  Such new versions will

be similar in spirit to the present version, but may differ in detail to

address new problems or concerns.

Each version is given a distinguishing version number.  If the Program

specifies a version number of this License which applies to it and "any

later version", you have the option of following the terms and conditions

either of that version or of any later version published by the Free

Software Foundation.  If the Program does not specify a version number of

this License, you may choose any version ever published by the Free Software

Foundation.

  10. If you wish to incorporate parts of the Program into other free

programs whose distribution conditions are different, write to the author

to ask for permission.  For software which is copyrighted by the Free

Software Foundation, write to the Free Software Foundation; we sometimes

make exceptions for this.  Our decision will be guided by the two goals

of preserving the free status of all derivatives of our free software and

of promoting the sharing and reuse of software generally.

                            NO WARRANTY

  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY

FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN

OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES

PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED

OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS

TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE

PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,

REPAIR OR CORRECTION.

  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING

WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR

REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,

INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING

OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED

TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY

YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER

PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE

POSSIBILITY OF SUCH DAMAGES.

                     END OF TERMS AND CONDITIONS

            How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest

possible use to the public, the best way to achieve this is to make it

free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest

to attach them to the start of each source file to most effectively

convey the exclusion of warranty; and each file should have at least

the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>

    Copyright (C) <year>  <name of author>

    This program is free software; you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation; either version 2 of the License, or

    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License along

    with this program; if not, write to the Free Software Foundation, Inc.,

    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this

when it starts in an interactive mode:

    Gnomovision version 69, Copyright (C) year name of author

    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.

    This is free software, and you are welcome to redistribute it

    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate

parts of the General Public License.  Of course, the commands you use may

be called something other than `show w' and `show c'; they could even be

mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your

school, if any, to sign a "copyright disclaimer" for the program, if

necessary.  Here is a sample; alter the names:

  Yoyodyne, Inc., hereby disclaims all copyright interest in the program

  `Gnomovision' (which makes passes at compilers) written by James Hacker.

  <signature of Ty Coon>, 1 April 1989

  Ty Coon, President of Vice

This General Public License does not permit incorporating your program into

proprietary programs.  If your program is a subroutine library, you may

consider it more useful to permit linking proprietary applications with the

library.  If this is what you want to do, use the GNU Lesser General

Public License instead of this License.

INFORMATION FOR DEVELOPERS

Once the Date API is installed, all functions in the API are available to be

used anywhere by any module.

The API uses the PHP 5.3 date functions to create and manipulate dates.

A component class is available, new DrupalDateTime($string, $timezone, $format), where

$string is a unixtimestamp, an ISO date, a string like YYYY-MM-DD HH:MM:SS,

or an array of date parts like 'year', 'month', 'day', 'hour', 'minute',

$timezone is the name of the timezone this date is in, and $format is the format

of date it is (DATE_FORMAT_UNIX, DATE_FORMAT_ISO, or DATE_FORMAT_DATETIME). It

creates and return a date object set to the right date and timezone.

Simpletest tests for these functions are included in the package.

Available functions include the following (more documentation is provided in

the files):

============================================================================

Preconfigured arrays

============================================================================

Both translated and untranslated values are available. The

$calendar->week_days_ordered() function will shift an array of week day names so it

starts with the site's first day of the week, otherwise the weekday names start

with Sunday as the first value, which is the expected order for many php and sql

functions.

$calendar = system_calendar();

$calendar->month_names();

$calendar->month_names_abbr();

$calendar->month_names();

$calendar->week_days();

$calendar->week_days_abbr();

$calendar->week_days();

$calendar->week_days_ordered();

$calendar->years();

$calendar->hours();

$calendar->minutes();

$calendar->seconds();

$calendar->ampm();

============================================================================

Date calculation and navigation

============================================================================

date_difference() will find the time difference between any two days, measured

in seconds, minutes, hours, days, months, weeks, or years.

$calendar->days_in_month();

$calendar->days_in_year();

date_calendar_weeks_in_year();

$calendar->day_of_week();

$calendar->day_of_week_name();

============================================================================

Date regex and format helpers

============================================================================

Pre-defined constants, an array of date format strings and their

equivalent regex strings.

DATE_REGEX_LOOSE is a very loose regex that will pull date parts out

of an ISO date with or without separators, using either 'T' or a space

to separate date and time, and with or without time.

DATE_FORMAT_ISO

DATE_FORMAT_DATETIME

DATE_FORMAT_UNIX

DATE_FORMAT_ICAL

DATE_REGEX_ISO

DATE_REGEX_DATETIME

DATE_REGEX_LOOSE

date_short_formats();

date_medium_formats();

date_long_formats();

date_format_patterns();

============================================================================

Standardized ical parser and creator

============================================================================

The iCal parser is Drupal/date_api/DateiCalParse. Use that class to

manipulate iCal strings.

The class parses the ical into an array that can be used

in various ways. It no longer trys to convert timezones while parsing,

instead a date_ical_date_format() function is provided that can be used to

convert from the ical timezone to whatever timezone is desired in the

results. Repeat rules are parsed into an array which other modules can

manipulate however they like to create additional events from the results.

date_ical_export();

date_ical_import();

date_ical_date_format();

============================================================================

Helpers for portable date SQL

============================================================================

The SQL functions are found in date_api_sql.inc, which is not included by

default. Include that file if you want to use these functions:

date_sql();

date_server_zone_adj();

date_sql_concat();

date_sql_pad();

============================================================================

Date forms and validators

============================================================================

Reusable, configurable, self-validating FAPI date elements are found in

date_api_elements.inc, which is not included by default. Include it

if you want to use these elements. To use them, create a form element

and set the '#type' to one of the following:

date_select

 The date_select element will create a collection of form elements, with a

 separate select or textfield for each date part. The whole collection will

 get reformatted back into a date value of the requested type during validation.

date_text

 The date_text element will create a textfield that can contain a whole

 date or any part of a date as text. The user input value will be re-formatted

 back into a date value of the requested type during validation.

date_timezone

 The date_timezone element will create a drop-down selector to pick a

 timezone name.

The custom date elements require a few other pieces of information to work

correctly, like #date_format and #date_type. See the internal documentation

for more information.

============================================================================

Date Popup Module

============================================================================

A new module is included in the package that will enable a popup jQuery

calendar date picker and timepicker in date and time fields.

It is implemented as a custom form element, so set '#type' to 'date_popup'

to use this element. See the internal documentation for more information.

============================================================================

Date Repeat API

============================================================================

An API for repeating dates is available if installed. It can be used by

other modules to create a form element that will allow users to select

repeat rules and store those selections in an iCal RRULE string, and a

calculation function that will parse the RRULE and return an array of dates

that match those rules. The API is implemented in the Date module as a

new date widget if the Date Repeat API is installed.

============================================================================

RDF Integration

============================================================================

To make RDF easier to use, the base date themes (date_display_single and

date_display_range) have been expanded so they pass attributes and

RDF mappings for the field, if any, to the theme. If RDF is installed

and no other mappings are provided, the theme adds RDF information

to mark both the Start and End dates as 'xsd:dateTime' datatypes with the

property of 'dc:date'. This occurs in the theme preprocess layer, in

particular via the functions template_preprocess_date_display_single() and

template_preprocess_date_display_range().

To mark these as events instead, you could install the schemaorg

module, which will load the schema.org vocabulary. The mark the content type

that contains events as an 'Event', using the UI exposed by that

module and set the event start date field with the 'dateStart'

property and tag other fields in the content type with the appropriate

property types. The Date module theme will wrap the start and end

date output with appropriate markup.

If the result is not quite what you need, you should be able to implement your

own theme preprocess functions, e.g. MYTHEME_preprocess_date_display_single()

or MYTHEME_preprocess_date_display_range() and alter the attributes to use the

values you want.

<?php

/**

 * @file

 * Hooks provided by the Date module.

 */

use Drupal\date_api\DateGranularity;

use Drupal\Core\Datetime\DrupalDateTime;

/**

 * Alter the default value for a date argument.

 *

 * @param object $argument

 *   The argument object.

 * @param string $value

 *   The default value created by the argument handler.

 */

function hook_date_default_argument_alter(&$argument, &$value) {

  $style_options = $style_options = $argument->view->display_handler->get_option('style_options');

  if (!empty($style_options['track_date'])) {

    $default_date = new DrupalDateTime();

    $value = $default_date->format($argument->arg_format);

  }

}

/**

 * Alter the entity before formatting it.

 *

 * @param object $entity

 *   The entity object being viewed.

 * @param array $variables

 *   The variables passed to the formatter.

 *   - entity: The $entity object.

 *   - entity_type: The $entity_type.

 *   - field: The $field array.

 *   - instance: The $instance array.

 *   - langcode: The $langcode.

 *   - items: The $items array.

 *   - display: The $display array.

 *   - dates: The processed dates array, empty at this point.

 *   - attributes: The attributes array, empty at this point.

 *   - rdf_mapping: The RDF mapping array.

 *   - add_rdf: If module_exists('rdf').

 */

function hook_date_formatter_pre_view_alter(&$entity, &$variables) {

  if (!empty($entity->view)) {

    $field = $variables['field'];

    $date_id = 'date_id_' . $field['field_name'];

    $date_delta = 'date_delta_' . $field['field_name'];

    $date_item = $entity->view->result[$entity->view->row_index];

    if (!empty($date_item->$date_id)) {

      $entity->date_id = 'date.' . $date_item->$date_id . '.' . $field['field_name'] . '.' . $date_item->$date_delta . '.0';

    }

  }

}

/**

 * Alter the dates array created by date_formatter_process().

 *

 * @param array $dates

 *   The $dates array created by the Date module.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *   - format: The string $format.

 *   - entity_type: The $entity_type.

 *   - entity: The $entity object.

 *   - langcode: The string $langcode.

 *   - item: The $item array.

 *   - display: The $display array.

 */

function hook_date_formatter_dates_alter(&$dates, $context) {

  $field = $context['field'];

  $instance = $context['instance'];

  $format = $context['format'];

  $entity_type = $context['entity_type'];

  $entity = $context['entity'];

  $date1 = $dates['value']['local']['object'];

  $date2 = $dates['value2']['local']['object'];

  $is_all_day = date_all_day_field($field, $instance, $date1, $date2);

  $all_day1 = '';

  $all_day2 = '';

  if ($format != 'format_interval' && $is_all_day) {

    $all_day1 = theme('date_all_day', array(

      'field' => $field,

      'instance' => $instance,

      'which' => 'date1',

      'date1' => $date1,

      'date2' => $date2,

      'format' => $format,

      'entity_type' => $entity_type,

      'entity' => $entity));

    $all_day2 = theme('date_all_day', array(

      'field' => $field,

      'instance' => $instance,

      'which' => 'date2',

      'date1' => $date1,

      'date2' => $date2,

      'format' => $format,

      'entity_type' => $entity_type,

      'entity' => $entity));

    $dates['value']['formatted_time'] = theme('date_all_day_label');

    $dates['value2']['formatted_time'] = theme('date_all_day_label');

    $dates['value']['formatted'] = $all_day1;

    $dates['value2']['formatted'] = $all_day2;

  }

}

/**

 * Alter the date_select element before the rest of the validation is run.

 *

 * @param array $element

 *   The $element array.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $input

 *   The array of input values to be validated.

 */

function hook_date_select_pre_validate_alter(&$element, &$form_state, &$input) {

  // Let Date module massage the format for all day values so they will pass

  // validation. The All day flag, if used, actually exists on the parent

  // element.

  date_all_day_value($element, $form_state);

}

/**

 * Alter the date_popup element before the rest of the validation is run.

 *

 * @param array $element

 *   The $element array.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $input

 *   The array of input values to be validated.

 */

function hook_date_popup_pre_validate_alter(&$element, &$form_state, &$input) {

  // Let Date module massage the format for all day values so they will pass

  // validation. The All day flag, if used, actually exists on the parent

  // element.

  date_all_day_value($element, $form_state);

}

/**

 * Alter the date_combo element before the rest of the validation is run.

 *

 * @param array $element

 *   The $element array.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *   - item: The $item array.

 *

 * @see date_combo_element_process()

 */

function hook_date_combo_pre_validate_alter(&$element, &$form_state, $context) {

  if (!empty($context['item']['all_day'])) {

    $field = $context['field'];

    // If we have an all day flag on this date and the time is empty, change the

    // format to match the input value so we don't get validation errors.

    $element['#date_is_all_day'] = TRUE;

    $element['value']['#date_date_format'] = date_part_format('date', $element['value']['#date_date_format']);

    if (!empty($field['settings']['todate'])) {

      $element['value2']['#date_date_format'] = date_part_format('date', $element['value2']['#date_date_format']);

    }

  }

}

/**

 * Alter the local start date objects created by the date_combo validation.

 *

 * This is called before the objects are converted back to the database timezone

 * and stored.

 *

 * @param object $date

 *   The $date object.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *  - field: The $field array.

 *  - instance: The $instance array.

 *  - item: The $item array.

 *  - element: The $element array.

 */

function hook_date_combo_validate_date_start_alter(&$date, &$form_state, $context) {

  // If this is an 'All day' value, set the time to midnight.

  if (!empty($context['element']['#date_is_all_day'])) {

    $date->setTime(0, 0, 0);

  }

}

/**

 * Alter the local end date objects created by the date_combo validation.

 *

 * This is called before the objects are converted back to the database timezone

 * and stored.

 *

 * @param object $date

 *   The $date object.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *  - field: The $field array.

 *  - instance: The $instance array.

 *  - item: The $item array.

 *  - element: The $element array.

 */

function hook_date_combo_validate_date_end_alter(&$date, &$form_state, $context) {

  // If this is an 'All day' value, set the time to midnight.

  if (!empty($context['element']['#date_is_all_day'])) {

    $date->setTime(0, 0, 0);

  }

}

/**

 * Alter the date_select widget element.

 *

 * @param array $element

 *   An associative array containing the properties of the date_select element.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - form: Nested array of form elements that comprise the form.

 *

 * @see date_select_element_process()

 */

function hook_date_select_process_alter(&$element, &$form_state, $context) {

  // Hide or show the element in reaction to the all_day status for the element.

  $all_day_id = !empty($element['#date_all_day_id']) ? $element['#date_all_day_id'] : '';

  if ($all_day_id != '') {

    foreach (array('hour', 'minute', 'second', 'ampm') as $field) {

      if (array_key_exists($field, $element)) {

        $element[$field]['#states'] = array(

          'visible' => array(

            'input[name="' . $all_day_id . '"]' => array('checked' => FALSE),

          ),

        );

      }

    }

  }

}

/**

 * Alter the date_popup widget element.

 *

 * @param array $element

 *   An associative array containing the properties of the date_popup element.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - form: Nested array of form elements that comprise the form.

 *

 * @see date_popup_element_process()

 */

function hook_date_popup_process_alter(&$element, &$form_state, $context) {

  // Hide or show the element in reaction to the all_day status for the element.

  $all_day_id = !empty($element['#date_all_day_id']) ? $element['#date_all_day_id'] : '';

  if ($all_day_id != '' && array_key_exists('time', $element)) {

    $element['time']['#states'] = array(

      'visible' => array(

        'input[name="' . $all_day_id . '"]' => array('checked' => FALSE),

      ),

    );

  }

}

/**

 * Alter the date_combo element after the Date module is finished with it.

 *

 * @param array $element

 *   The $element array.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *   - form: Nested array of form elements that comprise the form.

 */

function hook_date_combo_process_alter(&$element, &$form_state, $context) {

  $field = $context['field'];

  $instance = $context['instance'];

  $field_name = $element['#field_name'];

  $delta = $element['#delta'];

  // Add a date repeat form element, if needed.

  // We delayed until this point so we don't bother adding it to hidden fields.

  if (date_is_repeat_field($field, $instance)) {

    $item = $element['#value'];

    $element['rrule'] = array(

      '#type' => 'date_repeat_rrule',

      '#theme_wrappers' => array('date_repeat_rrule'),

      '#default_value' => isset($item['rrule']) ? $item['rrule'] : '',

      '#date_timezone' => $element['#date_timezone'],

      '#date_format'      => DateGranularity::limitFormat(date_input_format($element, $field, $instance), $field['settings']['granularity']),

      '#date_text_parts'  => (array) $instance['widget']['settings']['text_parts'],

      '#date_increment'   => $instance['widget']['settings']['increment'],

      '#date_year_range'  => $instance['widget']['settings']['year_range'],

      '#date_label_position' => $instance['widget']['settings']['label_position'],

      '#date_repeat_widget' => str_replace('_repeat', '', $instance['widget']['type']),

      '#date_flexible' => 0,

      '#weight' => $instance['widget']['weight'] + .4,

    );

  }

}

/**

 * Alter the date_timezone widget element.

 *

 * @param array $element

 *   An associative array containing the properties of the date_select element.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - form: Nested array of form elements that comprise the form.

 *

 * @see date_timezone_element_process()

 */

function hook_date_timezone_process_alter(&$element, &$form_state, $context) {

  // @todo.

}

/**

 * Alter the date_year_range widget element.

 *

 * @param array $element

 *   An associative array containing the properties of the date_select element.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - form: Nested array of form elements that comprise the form.

 *

 * @see date_year_range_element_process()

 */

function hook_date_year_range_process_alter(&$element, &$form_state, $context) {

  // @todo.

}

/**

 * Alter a date field settings form.

 *

 * @param array $form

 *   Nested array of form elements that comprise the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *   - has_data: The value of $has_data.

 *

 * @see hook_field_settings_form()

 */

function hook_date_field_settings_form_alter(&$form, $context) {

  $field = $context['field'];

  $instance = $context['instance'];

  $has_data = $context['has_data'];

  $form['repeat'] = array(

    '#type' => 'select',

    '#title' => t('Repeating date'),

    '#default_value' => $field['settings']['repeat'],

    '#options' => array(0 => t('No'), 1 => t('Yes')),

    '#attributes' => array('class' => array('container-inline')),

    '#description' => t("Repeating dates use an 'Unlimited' number of values. Instead of the 'Add more' button, they include a form to select when and how often the date should repeat."),

    '#disabled' => $has_data,

  );

}

/**

 * Alter a date field instance settings form.

 *

 * @param array $form

 *   Nested array of form elements that comprise the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *

 * @see hook_field_instance_settings_form()

 */

function hook_date_field_instance_settings_form_alter(&$form, $context) {

  $field = $context['field'];

  $instance = $context['instance'];

  $form['new_setting'] = array(

    '#type' => 'textfield',

    '#default_value' => '',

    '#title' => t('My new setting'),

  );

}

/**

 * Alter a date field widget settings form.

 *

 * @param array $form

 *   Nested array of form elements that comprise the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *

 * @see hook_field_widget_settings_form()

 */

function hook_date_field_widget_settings_form_alter(&$form, $context) {

  $field = $context['field'];

  $instance = $context['instance'];

  $form['new_setting'] = array(

    '#type' => 'textfield',

    '#default_value' => '',

    '#title' => t('My new setting'),

  );

}

/**

 * Alter a date field formatter settings form.

 *

 * @param array $form

 *   Nested array of form elements that comprise the form.

 * @param array $form_state

 *   A keyed array containing the current state of the form.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *   - view_mode: The formatter view mode.

 *

 * @see hook_field_formatter_settings_form()

 */

function hook_date_field_formatter_settings_form_alter(&$form, &$form_state, $context) {

  $field = $context['field'];

  $instance = $context['instance'];

  $view_mode = $context['view_mode'];

  $settings = $context['settings'];

  $formatter = $context['formatter'];

  if ($formatter == 'date_default') {

    $form['show_repeat_rule'] = array(

      '#title' => t('Repeat rule:'),

      '#type' => 'select',

      '#options' => array(

        'show' => t('Show repeat rule'),

        'hide' => t('Hide repeat rule')),

      '#default_value' => $settings['show_repeat_rule'],

      '#access' => $field['settings']['repeat'],

      '#weight' => 5,

    );

  }

}

/**

 * Alter a date field formatter settings summary.

 *

 * @param array $summary

 *   An array of strings to be concatenated into a short summary of the

 *   formatter settings.

 * @param array $context

 *   An associative array containing the following keys:

 *   - field: The $field array.

 *   - instance: The $instance array.

 *   - view_mode: The formatter view mode.

 *

 * @see hook_field_formatter_settings_summary()

 */

function hook_date_field_formatter_settings_summary_alter(&$summary, $context) {

  $field = $context['field'];

  $instance = $context['instance'];

  $view_mode = $context['view_mode'];

  $formatter = $context['formatter'];

  $settings = $context['settings'];

  if (isset($settings['show_repeat_rule']) && !empty($field['settings']['repeat'])) {

    if ($settings['show_repeat_rule'] == 'show') {

      $summary[] = t('Show repeat rule');

    }

    else {

      $summary[] = t('Hide repeat rule');

    }

  }

}

<?php

/**

 * @file

 * Date Devel Generate code.

 */

use Drupal\Core\Datetime\DrupalDateTime;

/**

 * Implements hook_devel_generate().

 *

 * Included only when needed.

 */

function date_devel_generate($entity, $field, $instance, $bundle) {

  $entity_field = array();

  if (isset($instance['widget']['settings']['year_range'])) {

    $split = explode(':', $instance['widget']['settings']['year_range']);

    $back = str_replace('-', '', $split[0]);

    $forward = str_replace('+', '', $split[1]);

  }

  else {

    $back = 2;

    $forward = 2;

  }

  // Pick a random year within the time range,

  // and a random second within that year.

  $year = date_format(new DrupalDateTime(), 'Y') - $back + mt_rand(0, ($forward + $back));

  $start = new DrupalDateTime($year . '-01-01 00:00:00', date_get_timezone_db($field['settings']['tz_handling']));

  $leap = date_format($start, 'L');

  $max_days = $leap ? 366 : 365;

  $seconds = mt_rand(0, ($max_days * 86400));

  date_modify($start, "+$seconds seconds");

  $increment = $instance['widget']['settings']['increment'];

  date_increment_round($start, $increment);

  // Modify End date by 1 hour to 3 days, shorter for repeating dates

  // longer for others.

  $start2 = clone($start);

  $max = !empty($field['settings']['repeat']) ? 720 : 4320;

  $max = 240;

  date_modify($start2, '+' . mt_rand(60, $max) . ' minutes');

  date_increment_round($start2, $increment);

  if ($field['settings']['tz_handling'] == 'date') {

    // Choose a random timezone.

    // Not all keys exist, so we have to check.

    $timezones = array_keys(system_time_zones(TRUE));

    $key = mt_rand(0, count($timezones) - 1);

    if (!array_key_exists($key, $timezones)) {

      $timezone = drupal_get_user_timezone();

    }

    else {

      $timezone = $timezones[$key];

    }

  }

  else {

    $timezone = date_get_timezone($field['settings']['tz_handling']);

  }

  $format = DATE_FORMAT_ISO;

  $entity_field['value'] = date_format($start, $format);

  if ($field['settings']['todate']) {

    $entity_field['value2'] = date_format($start2, $format);

  }

  date_timezone_set($start, timezone_open($timezone));

  $entity_field['timezone'] = $timezone;

  $entity_field['offset'] = date_offset_get($start);

  date_timezone_set($start2, timezone_open($timezone));

  $entity_field['offset2'] = date_offset_get($start2);

  return $entity_field;

}

<?php

/**

 * @file

 * Field hooks to implement a date field.

 */

use Drupal\Core\Datetime\DrupalDateTime;

/**

 * Implements hook_field_is_empty().

 */

function date_field_is_empty($item, $field) {

  // Sometimes a $item is a date object.

  // Coming from repeating dates. Why??

  if (!is_array($item)) {

    return FALSE;

  }

  if (empty($item['value'])) {

    return TRUE;

  }

  elseif ($field['settings']['todate'] == 'required' && empty($item['value2'])) {

    return TRUE;

  }

  return FALSE;

}

/**

 * Implements hook_field_info().

 */

function date_field_info() {

  return array(

    'date' => array(

      'label' => 'Date Range',

      'description' => t('Store a start and optional end date in the database as ISO dates.'),

      'settings' => array(

        'todate' => '',

        'granularity' => drupal_map_assoc(array('year', 'month', 'day', 'hour', 'minute')),

        'tz_handling' => 'site',

        'timezone_db' => 'UTC',

      ),

      'instance_settings' => array(

        'default_value' => 'now',

        'default_value_code' => '',

        'default_value2' => 'same',

        'default_value_code2' => '',

      ),

      'default_widget' => 'date_select',

      'default_formatter' => 'date_default',

      'default_token_formatter' => 'date_plain',

      'field item class' => '\Drupal\date\Type\DateItem',

    ),

  );

}

/**

 * Implements hook_field_load().

 */

function date_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {

  $timezone_db = date_get_timezone_db($field['settings']['tz_handling']);

  $db_format = date_type_format($field['type']);

  $keys = date_available_values($field);

  foreach ($entities as $id => $entity) {

    foreach ($items[$id] as $delta => &$item) {

      // If the file does not exist, mark the entire item as empty.

      if (is_array($item)) {

        $item['data'] = isset($item['data']) ? unserialize($item['data']) : array();

        $item['timezone_db'] = $timezone_db;

        $item['date_type'] = $field['type'];

        if (!empty($field['settings']['cache_enabled']) && ($delta < $field['settings']['cache_count'] || $field['settings']['cache_count'] == 0)) {

          foreach ($keys as $key) {

            if (!empty($item[$key])) {

              $item['db'][$key] = $date;

            }

          }

        }

      }

    }

  }

}

/**

 * Implements hook_field_validate().

 */

function date_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {

  $field_name = $field['field_name'];

  $flexible = 0;

  // @TODO Figure out what we need here now.

  return;

  // Don't try to validate if there were any errors before this point

  // since the element won't have been munged back into a date.

  if (!form_get_errors()) {

    foreach ($items as $delta => $item) {

      if (is_array($item) && isset($item['value'])) {

        $keys = date_available_values($field, $instance);

        $date1 = new DrupalDateTime($item['value'], $item['timezone'], date_type_format($field['type']));

        if (count($keys) == 1 || (empty($item['value2']) && $item['value2'] !== 0)) {

          $date2 = clone($date1);

        }

        else {

          $date2 = new DrupalDateTime($item['value2'], $item['timezone'], date_type_format($field['type']));

        }

/*

        $valid1 = $date1->validGranularity($field['settings']['granularity'], $flexible);

        $valid2 = $date2->validGranularity($field['settings']['granularity'], $flexible);

        foreach ($keys as $key) {

          if ($ == 'value' && $field['settings']['todate'] && !$valid1 && $valid2) {

            $errors[$field['field_name']][$langcode][$delta][] = array(

              'error' => 'value',

              'message' => t("A 'Start date' date is required for field %field #%delta.", array('%delta' => $field['cardinality'] ? intval($delta + 1) : '', '%field' => $instance['label'])),

            );

          }

          if ($key == 'value2' && $field['settings']['todate'] == 'required' && ($instance['required'] && $valid1 && !$valid2)) {

            $errors[$field['field_name']][$langcode][$delta][] = array(

              'error' => 'value2',

              'message' => t("An 'End date' is required for field %field #%delta.", array('%delta' => $field['cardinality'] ? intval($delta + 1) : '', '%field' => $instance['label'])),

            );

          }

        }

*/

      }

    }

  }

}

/**

 * Implements hook_field_insert().

 */

function date_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {

  $field_name = $field['field_name'];

  if (empty($items)) {

    return;

  }

  // Add some information needed to interpret token values.

  $values = $items;

  foreach ($values as $delta => $item) {

    $timezone = isset($item['timezone']) ? $item['timezone'] : '';

    if (is_array($item)) {

      $items[$delta]['timezone'] = date_get_timezone($field['settings']['tz_handling'], $timezone);

      $items[$delta]['timezone_db'] = date_get_timezone_db($field['settings']['tz_handling']);

      $items[$delta]['date_type'] = $field['type'];

      $data = array();

      foreach (date_data_keys() as $key) {

        if (isset($item[$key])) {

          $data[$delta][$key] = $item[$key];

          unset($items[$delta][$key]);

        }

      }

      $items[$delta]['data'] = serialize($data);

    }

  }

  $entity->{$field['field_name']}[$langcode] = $items;

}

/**

 * Implements hook_field_insert().

 */

function date_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {

  $context = array(

    'entity_type' => $entity_type,

    'entity' => $entity,

    'field' => $field,

    'instance' => $instance,

    'langcode' => $langcode,

  );

  drupal_alter('date_field_insert', $items, $context);

}

/**

 * Implements hook_field_update().

 */

function date_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {

  $context = array(

    'entity_type' => $entity_type,

    'entity' => $entity,

    'field' => $field,

    'instance' => $instance,

    'langcode' => $langcode,

  );

  drupal_alter('date_field_update', $items, $context);

}

/**

 * Implements hook_field_instance_settings_form().

 *

 * Wrapper functions for date administration, included only when processing

 * field settings.

 */

function date_field_instance_settings_form($field, $instance) {

  module_load_include('inc', 'date', 'date_admin');

  return _date_field_instance_settings_form($field, $instance);

}

/**

 * Implements hook_field_settings_form().

 */

function date_field_settings_form($field, $instance, $has_data) {

  module_load_include('inc', 'date', 'date_admin');

  return _date_field_settings_form($field, $instance, $has_data);

}

name = Date

description = Makes date/time fields available.

dependencies[] = date_api

package = Date/Time

core = 8.x

; Information added by drupal.org packaging script on 2013-09-30

version = "8.x-1.x-dev"

core = "8.x"

project = "date"

datestamp = "1380568702"

<?php

/**

 * @file

 * Install, update and uninstall functions for the Date module.

 */

/**

 * Implements hook_field_schema().

 */

function date_field_schema($field) {

  switch ($field['settings']['todate']) {

    case '':

      $db_columns = array(

        'value' => array(

          'description' => 'The date value',

          'type' => 'varchar',

          'length' => 20,

          'not null' => FALSE,

        ),

        'data' => array(

          'description' => 'A serialized array with more date info.',

          'type' => 'text',

          'not null' => FALSE,

        ),

      );

      $indexes = array(

        'value' => 'value',

      );

      break;

    default:

      $db_columns = array(

        'value' => array(

          'description' => 'The start date value',

          'type' => 'varchar',

          'length' => 20,

          'not null' => FALSE,

        ),

        'value2' => array(

          'description' => 'The end date value',

          'type' => 'varchar',

          'length' => 20,

          'not null' => FALSE,

        ),

        'data' => array(

          'description' => 'A serialized array with more date info.',

          'type' => 'text',

          'not null' => FALSE,

        ),

      );

      $indexes = array(

        'value' => 'value',

        'value2' => 'value2',

      );

      break;

  }

  // If a second date is needed for 'End date', make a copy of the first one.

  // Timezone and offset columns are used only if date-specific dates are used.

  if (isset($field['settings']['tz_handling']) && $field['settings']['tz_handling'] == 'date') {

    $db_columns['offset'] = array(

      'type' => 'int',

      'not null' => FALSE,

    );

    if (!empty($field['settings']['todate'])) {

      $db_columns['offset2'] = array('type' => 'int', 'not null' => FALSE);

    }

  }

  return array('columns' => $db_columns, 'indexes' => $indexes);

}

/**

 * Implements hook_update_last_removed().

 */

function date_update_last_removed() {

  return 7004;

}

// @TODO Write upgrade path for text widgets to combine them with Popup widgets as new 'Datetime' widgets.

// @TOTO Write upgrade path for select widgets convert them to new 'Datelist' widgets.

// @TODO Write upgrade path for 'input_format' widget settings to create 'date_date_format' and 'date_time_format', date_date_element, date_time_element.

// @TODO Write upgrade path to remove 'input_format_custom'.

// @TODO Write upgrade path to remove datetime and datestamp storage methods and make all into iso.

// @TODO Removing custom formats that won't work in datepicker for consistency.

// @TODO Write upgrade path adding indexes, if not already set.

// @TODO Write upgrade path to add timezone, rrule, and all_day into new data column and delete rrule and timezone columns.

(function ($) {

Drupal.behaviors.dateSelect = {};

Drupal.behaviors.dateSelect.attach = function (context, settings) {

  var $widget = $('.form-type-date-select').parents('fieldset').once('date');

  var i;

  for (i = 0; i < $widget.length; i++) {

    new Drupal.date.EndDateHandler($widget[i]);

  }

};

Drupal.date = Drupal.date || {};

/**

 * Constructor for the EndDateHandler object.

 *

 * The EndDateHandler is responsible for synchronizing a date select widget's

 * end date with its start date. This behavior lasts until the user

 * interacts with the end date widget.

 *

 * @param widget

 *   The fieldset DOM element containing the from and to dates.

 */

Drupal.date.EndDateHandler = function (widget) {

  this.$widget = $(widget);

  this.$start = this.$widget.find('.form-type-date-select[class$=value]');

  this.$end = this.$widget.find('.form-type-date-select[class$=value2]');

  if (this.$end.length == 0) {

    return;

  }

  this.initializeSelects();

  // Only act on date fields where the end date is completely blank or already

  // the same as the start date. Otherwise, we do not want to override whatever

  // the default value was.

  if (this.endDateIsBlank() || this.endDateIsSame()) {

    this.bindClickHandlers();

    // Start out with identical start and end dates.

    this.syncEndDate();

  }

};

/**

 * Store all the select dropdowns in an array on the object, for later use.

 */

Drupal.date.EndDateHandler.prototype.initializeSelects = function () {

  var $starts = this.$start.find('select');

  var $end, $start, endId, i, id;

  this.selects = {};

  for (i = 0; i < $starts.length; i++) {

    $start = $($starts[i]);

    id = $start.attr('id');

    endId = id.replace('-value-', '-value2-');

    $end = $('#' + endId);