oik-dates.php

Lines:

<?php

/**
Plugin Name: oik-dates
Depends: oik base plugin, oik fields
Plugin URI: http://www.oik-plugins.com/oik-plugins/oik-dates
Description: Implements date based field types for oik-fields 
Version: 0.1
Author: bobbingwide
Author URI: http://www.bobbingwide.com
License: GPL2

    Copyright 2014 Bobbing Wide (email : herb@bobbingwide.com )

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2,
    as published by the Free Software Foundation.

    You may NOT assume that you can use any other version of the GPL.

    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.

    The license for this software can likely be found here:
    http://www.gnu.org/licenses/gpl-2.0.html

*/


/**
 * Implements action "oik_pre_theme_field"
 *
 * The dates field is only required when we intend to actually display the field
 *
 */
/*  function oikd8_pre_theme_field() – Implements action "oik_pre_theme_field" */


/**
 * Implements action "oik_pre_form_field"
 *
 * The dates field is only required when we intend to actually to set a new value for the field
 *
 */
/*  function oikd8_pre_form_field() – Implements action "oik_pre_form_field" */


/**
 * Validate a dates field
 *
 * We only check for is_numeric() so that we can support half dates **?** 2013/07/23
 * 
 * @param string $value - the field value
 * @param string $field - the field name
 * @param array $data - array of data about the field   
 */
/*  function oikd8_field_validation_date() – Validate a dates field */


/**
 * Implement "oik_query_field_types" for oik-dates
 * 
 */
/*  function oikd8_query_field_types() – Implement "oik_query_field_types" for oik-dates */


/**
 * Adjust a date using PHP's date_add() function 
 *
 * This function can be used to apply date adjustments such as
 *
 * <pre>
 * +1 year
 * +1 year 6 months
 * +2 years
 * </pre>
 *
 * @use date_interval_create_from_date_string() (PHP 5.3 and above)
 * 
 * @link http://uk3.php.net/manual/en/datetime.formats.relative.php 
 *
 * @param string $adjustment - the date adjustment to apply
 * @param string $date - date to adjust
 * @param string $format - the required format for the new date
 * @return string the new date
 */
if( !function_exists( "bw_date_adjust" ) ) {
/*  function bw_date_adjust() – Adjust a date using PHP’s date_add() function */
}


/**
 * Determine a default value given the supplied meta_value and any other fields in $atts
 * 
 * For field type "date" we may want to look at the meta_compare parameter to see if that helps us decide what value to use.
 * 
 * @TODO - complete table
 *
 * Field type  meta_value   return meta_value