class date_sql_handler in Date 6
Same name and namespace in other branches
- 5.2 date_api_sql.inc \date_sql_handler
- 6.2 date_api_sql.inc \date_sql_handler
- 7.3 date_api/date_api_sql.inc \date_sql_handler
- 7 date_api/date_api_sql.inc \date_sql_handler
- 7.2 date_api/date_api_sql.inc \date_sql_handler
A class to manipulate date SQL.
Hierarchy
- class \date_sql_handler
Expanded class hierarchy of date_sql_handler
File
- ./
date_api_sql.inc, line 41
View source
class date_sql_handler {
var $db_type = 'mysql';
var $date_type = DATE_UNIX;
var $db_timezone = 'UTC';
// A string timezone name.
var $local_timezone = NULL;
// A string timezone name.
var $db_timezone_field = NULL;
// Use if the db timezone is stored in a field.
var $local_timezone_field = NULL;
// Use if the local timezone is stored in a field.
var $offset_field = NULL;
// Use if the offset is stored in a field.
function construct($date_type = DATE_UNIX, $local_timezone = NULL) {
$this->db_type = $GLOBALS['db_type'];
$this->date_type = $date_type;
$this->db_timezone = 'UTC';
$this->local_timezone = isset($local_timezone) ? $local_timezone : date_default_timezone_name();
if (isset($this->definition['content_field'])) {
$this->date_handler->date_type = $this->definition['content_field']['type'];
}
date_api_set_db_timezone();
}
/**
* See if the db has timezone name support.
*/
function db_tz_support($reset = FALSE) {
$has_support = variable_get('date_db_tz_support', -1);
if ($has_support == -1 || $reset) {
date_api_set_db_timezone();
$has_support = FALSE;
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
$test = db_result(db_query("SELECT CONVERT_TZ('2008-02-15 12:00:00', 'UTC', 'US/Central')"));
if ($test == '2008-02-15 06:00:00') {
$has_support = TRUE;
}
break;
case 'pgsql':
$test = "TIMESTAMP WITH TIME ZONE '2008-02-15 12:00:00' AT TIME ZONE 'US/Central'";
if ($test == '2008-02-15 06:00:00') {
$has_support = TRUE;
}
break;
}
variable_set('date_db_tz_support', $has_support);
}
return $has_support;
}
/**
* Set the database timzone offset.
*
* Setting the db timezone to UTC is done to ensure consistency in date
* handling whether or not the database can do proper timezone conversion.
*
* Views filters that not exposed are cached and won't set the timezone
* so views date filters should add 'cacheable' => 'no' to their
* definitions to ensure that the database timezone gets set properly
* when the query is executed.
*
* @param $offset
* An offset value to set the database timezone to. This will only
* set a fixed offset, not a timezone, so any value other than
* '+00:00' should be used with caution.
*/
function set_db_timezone($offset = '+00:00') {
static $already_set = FALSE;
$type = $GLOBALS['db_type'];
if (!$already_set) {
if ($type == 'mysqli' || version_compare(db_version(), '4.1.3', '>=')) {
db_query("SET @@session.time_zone = '{$offset}'");
}
elseif ($type == 'pgsql') {
db_query("SET TIME ZONE '{$offset}'");
}
$already_set = true;
}
}
/**
* Return timezone offset for the date being processed.
*/
function get_offset() {
if (!empty($this->db_timezone) && !empty($this->local_timezone)) {
if ($this->db_timezone != $this->local_timezone) {
$date = date_make_date('now', $this->db_timezone);
date_timezone_set($date, timezone_open($this->local_timezone));
return date_offset_get($date);
}
}
return 0;
}
/**
* Helper function to create cross-database SQL dates.
*
* @param $field
* The real table and field name, like 'tablename.fieldname'.
* @param $offset
* The name of a field that holds the timezone offset or an
* offset value. If NULL, the normal Drupal timezone handling
* will be used, if $offset = 0 no adjustment will be made.
* @return
* An appropriate SQL string for the db type and field type.
*/
function sql_field($field, $offset = NULL) {
if (strtoupper($field) == 'NOW') {
// NOW() will be in UTC since that is what we set the db timezone to.
$this->local_timezone = 'UTC';
return 'NOW()';
}
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
switch ($this->date_type) {
case DATE_UNIX:
$field = "FROM_UNIXTIME({$field})";
break;
case DATE_ISO:
$field = "STR_TO_DATE({$field}, '%Y-%m-%%dT%T')";
break;
case DATE_DATETIME:
break;
}
break;
case 'pgsql':
switch ($date_type) {
case DATE_UNIX:
$field = "{$field}::ABSTIME";
break;
case DATE_ISO:
$field = "TO_DATE({$field}, 'FMYYYY-FMMM-FMDDTFMHH:FMMI:FMSS')";
break;
case DATE_DATETIME:
break;
}
break;
}
// Adjust the resulting value to the right timezone/offset.
return $this
->sql_tz($field, $offset);
}
/**
* Adjust a field value by an offset in seconds.
*/
function sql_offset($field, $offset = NULL) {
if (!empty($offset)) {
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
return "ADDTIME({$field}, SEC_TO_TIME({$offset}))";
case 'pgsql':
return "({$field} + 'INTERVAL {$offset} SECONDS')";
}
}
return $field;
}
/**
* Select a date value from the database, adjusting the value
* for the timezone.
*
* Check whether database timezone conversion is supported in
* this system and use it if possible, otherwise use an
* offset.
*
* @param $offset
* Set a fixed offset or offset field to use for the date.
* If set, no timezone conversion will be done and the
* offset will be used.
*/
function sql_tz($field, $offset = NULL) {
// If the timezones are values they need to be quoted, but
// if they are field names they do not.
$dbzone = $this->db_timezone_field ? $this->db_timezone_field : "'{$this->db_timezone}'";
$localzone = $this->local_timezone_field ? $this->local_timezone_field : "'{$this->local_timezone}'";
// If a fixed offset is required, use it.
if ($offset !== NULL) {
return $this
->sql_offset($field, $offset);
}
elseif ($db_zone == $localzone) {
return $this
->sql_offset($field, 0);
}
elseif (!$this
->db_tz_support()) {
if (!empty($this->offset_field)) {
return $this
->sql_offset($field, $this->offset_field);
}
else {
return $this
->sql_offset($field, $this
->get_offset());
}
}
else {
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
return "CONVERT_TZ({$field}, {$dbzone}, {$localzone})";
case 'pgsql':
// WITH TIME ZONE assumes the date is using the system
// timezone, which should have been set to UTC.
return "TIMESTAMP WITH TIME ZONE {$field} AT TIME ZONE {$localzone}";
}
}
}
/**
* Helper function to create cross-database SQL date formatting.
*
* @param $format
* A format string for the result, like 'Y-m-d H:i:s'.
* @param $field
* The real table and field name, like 'tablename.fieldname'.
* @return
* An appropriate SQL string for the db type and field type.
*/
function sql_format($format, $field) {
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
$replace = array(
'Y' => '%Y',
'y' => '%y',
'm' => '%m',
'n' => '%c',
'd' => '%%d',
'j' => '%e',
'H' => '%H',
'i' => '%i',
's' => '%s',
);
$format = strtr($format, $replace);
return "DATE_FORMAT({$field}, '{$format}')";
case 'pgsql':
$replace = array(
'Y' => 'YY',
'y' => 'Y',
'm' => 'MM',
'n' => 'M',
'd' => 'DD',
'j' => 'D',
'H' => 'HH24',
'i' => 'MI',
's' => 'SS',
);
$format = strtr($format, $replace);
return "TO_CHAR({$field}, '{$format}')";
}
}
/**
* Helper function to create cross-database SQL date extraction.
*
* @param $extract_type
* The type of value to extract from the date, like 'MONTH'.
* @param $field
* The real table and field name, like 'tablename.fieldname'.
* @return
* An appropriate SQL string for the db type and field type.
*/
function sql_extract($extract_type, $field) {
// Note there is no space after FROM to avoid db_rewrite problems
// see http://drupal.org/node/79904.
switch (strtoupper($extract_type)) {
case 'DATE':
return $field;
case 'YEAR':
return "EXTRACT(YEAR FROM({$field}))";
case 'MONTH':
return "EXTRACT(MONTH FROM({$field}))";
case 'DAY':
return "EXTRACT(DAY FROM({$field}))";
case 'HOUR':
return "EXTRACT(HOUR FROM({$field}))";
case 'MINUTE':
return "EXTRACT(MINUTE FROM({$field}))";
case 'SECOND':
return "EXTRACT(SECOND FROM({$field}))";
case 'WEEK':
// ISO week number for date
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
// WEEK using arg 3 in mysql should return the same value as postgres EXTRACT
return "WEEK({$field}, 3)";
case 'pgsql':
return "EXTRACT(WEEK FROM({$field}))";
}
case 'DOW':
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
// mysql returns 1 for Sunday through 7 for Saturday
// php date functions and postgres use 0 for Sunday and 6 for Saturday
return "INTEGER(DAYOFWEEK({$field}) - 1)";
case 'pgsql':
return "EXTRACT(DOW FROM({$field}))";
}
case 'DOY':
switch ($this->db_type) {
case 'mysql':
case 'mysqli':
return "DAYOFYEAR({$field})";
case 'pgsql':
return "EXTRACT(DOY FROM({$field}))";
}
}
}
/**
* Create a where clause to compare a complete date field to a complete date value.
*
* @param string $type
* The type of value we're comparing to, could be another field
* or a date value.
* @param string $field
* The db table and field name, like "$table.$field".
* @param string $operator
* The db comparison operator to use, like '='.
* @param int $value
* The value to compare the extracted date part to, could be a
* field name or a date string or NOW().
* @return
* SQL for the where clause for this operation.
*/
function sql_where_date($type, $field, $operator, $value, $adjustment = 0) {
$type = strtoupper($type);
if (strtoupper($value) == 'NOW') {
$value = $this
->sql_field('NOW', $adjustment);
}
elseif ($type == 'FIELD') {
$value = $this
->sql_field($value, $adjustment);
}
elseif ($type == 'DATE') {
$date = date_make_date($value, date_default_timezone_name(), DATE_DATETIME);
if (!empty($adjustment)) {
date_modify($date, $adjustment . ' seconds');
}
// When comparing a field to a date we can avoid doing timezone
// conversion by altering the comparison date to the db timezone.
// This won't work if the timezone is a field instead of a value.
if (empty($this->db_timezone_field) && empty($this->local_timezone_field) && $this->db_timezone_field != $this->local_timezone_field) {
date_timezone_set($date, timezone_open($this->db_timezone));
$this->local_timezone = $this->db_timezone;
}
$value = "'" . date_format_date($date, 'custom', DATE_FORMAT_DATETIME) . "'";
}
if ($this->local_timezone != $this->db_timezone) {
$field = $this
->sql_field($field);
}
else {
$field = $this
->sql_field($field, 0);
}
return "{$field} {$operator} {$value}";
}
/**
* Create a where clause to compare an extracted part of a field to an integer value.
*
* @param string $part
* The part to extract, YEAR, MONTH, DAY, etc.
* @param string $field
* The db table and field name, like "$table.$field".
* @param string $operator
* The db comparison operator to use, like '='.
* @param int $value
* The integer value to compare the extracted date part to.
* @return
* SQL for the where clause for this operation.
*/
function sql_where_extract($part, $field, $operator, $value) {
if ($this->local_timezone != $this->db_timezone) {
$field = $this
->sql_field($field);
}
else {
$field = $this
->sql_field($field, 0);
}
return $this
->sql_extract($part, $field) . " {$operator} {$value}";
}
/**
* Create a where clause to compare a formated field to a formated value.
*
* @param string $format
* The format to use on the date and the value when comparing them.
* @param string $field
* The db table and field name, like "$table.$field".
* @param string $operator
* The db comparison operator to use, like '='.
* @param string $value
* The value to compare the extracted date part to, could be a
* field name or a date string or NOW().
* @return
* SQL for the where clause for this operation.
*/
function sql_where_format($format, $field, $operator, $value) {
if ($this->local_timezone != $this->db_timezone) {
$field = $this
->sql_field($field);
}
else {
$field = $this
->sql_field($field, 0);
}
return $this
->sql_format($format, $field) . " {$operator} '{$value}'";
}
/**
* An array of all date parts,
* optionally limited to an array of allowed parts.
*/
function date_parts($limit = NULL) {
$parts = array(
'year' => t('Year'),
'month' => t('Month'),
'day' => t('Day'),
'hour' => t('Hour'),
'minute' => t('Minute'),
'second' => t('Second'),
);
if (!empty($limit)) {
$last = FALSE;
foreach ($parts as $key => $part) {
if ($last) {
unset($parts[$key]);
}
if ($key == $limit) {
$last = TRUE;
}
}
}
return $parts;
}
/**
* Part information.
*
* @param $op
* 'min', 'max', 'format', 'sep', 'empty_now', 'empty_min', 'empty_max'.
* Returns all info if empty.
* @param $part
* 'year', 'month', 'day', 'hour', 'minute', or 'second.
* returns info for all parts if empty.
*/
function part_info($op = NULL, $part = NULL) {
$info = array();
$info['min'] = array(
'year' => 100,
'month' => 1,
'day' => 1,
'hour' => 0,
'minute' => 0,
'second' => 0,
);
$info['max'] = array(
'year' => 4000,
'month' => 12,
'day' => 31,
'hour' => 23,
'minute' => 59,
'second' => 59,
);
$info['format'] = array(
'year' => 'Y',
'month' => 'm',
'day' => 'd',
'hour' => 'H',
'minute' => 'i',
'second' => 's',
);
$info['sep'] = array(
'year' => '',
'month' => '-',
'day' => '-',
'hour' => ' ',
'minute' => ':',
'second' => ':',
);
$info['empty_now'] = array(
'year' => date('Y'),
'month' => date('m'),
'day' => min('28', date('d')),
'hour' => date('H'),
'minute' => date('i'),
'second' => date('s'),
);
$info['empty_min'] = array(
'year' => '1000',
'month' => '01',
'day' => '01',
'hour' => '00',
'minute' => '00',
'second' => '00',
);
$info['empty_max'] = array(
'year' => '9999',
'month' => '12',
'day' => '31',
'hour' => '23',
'minute' => '59',
'second' => '59',
);
if (!empty($op)) {
if (!empty($part)) {
return $info[$op][$part];
}
else {
return $info[$op];
}
}
return $info;
}
/**
* Create a complete datetime value out of an
* incomplete array of selected values.
*
* For example, array('year' => 2008, 'month' => 05) will fill
* in the day, hour, minute and second with the earliest possible
* values if type = 'min', the latest possible values if type = 'max',
* and the current values if type = 'now'.
*/
function complete_date($selected, $type = 'now') {
$compare = array_merge($this
->part_info('empty_' . $type), $selected);
// If this is a max date, make sure the last day of
// the month is the right one for this date.
if ($type == 'max') {
$compare['day'] = date('t', mktime(0, 0, 0, $compare['month'], 1, $compare['year']));
}
$value = '';
$separators = $this
->part_info('sep');
foreach ($this
->date_parts() as $key => $name) {
$value .= $separators[$key] . (!empty($selected[$key]) ? $selected[$key] : $compare[$key]);
}
return $value;
}
/**
* Convert a format string into help text,
* i.e. 'Y-m-d' becomes 'YYYY-MM-DD'.
*
* @param unknown_type $format
* @return unknown
*/
function format_help($format) {
$replace = array(
'Y' => 'YYYY',
'm' => 'MM',
'd' => 'DD',
'H' => 'HH',
'i' => 'MM',
's' => 'SS',
'\\T' => 'T',
);
return strtr($format, $replace);
}
/**
* A function to test the validity of various date parts
*/
function part_is_valid($value, $type) {
if (!preg_match('/^[0-9]*$/', $value)) {
return false;
}
$value = intval($value);
if ($value <= 0) {
return false;
}
switch ($type) {
case 'year':
if ($value < DATE_MIN_YEAR) {
return false;
}
break;
case 'month':
if ($value < 0 || $value > 12) {
return false;
}
break;
case 'day':
if ($value < 0 || $value > 31) {
return false;
}
break;
case 'week':
if ($value < 0 || $value > 53) {
return false;
}
}
return true;
}
function views_formats($granularity, $type = 'sql') {
$formats = array(
'display',
'sql',
);
switch ($granularity) {
case 'year':
$formats['display'] = 'Y';
$formats['sql'] = 'Y';
break;
case 'month':
$formats['display'] = 'F Y';
$formats['sql'] = 'Y-m';
break;
case 'day':
$formats['display'] = 'F j Y';
$formats['sql'] = 'Y-m-d';
break;
case 'hour':
$formats['display'] = 'F j Y - H';
$formats['sql'] = 'Y-m-d\\TH';
break;
case 'week':
$formats['display'] = 'F j Y (W)';
$formats['sql'] = 'Y-\\WW';
break;
}
return $formats[$type];
}
/**
* Parse date parts from an ISO date argument.
*
* Based on ISO 8601 date duration and time interval standards.
*
* See http://en.wikipedia.org/wiki/ISO_8601#Week_dates for definitions of ISO weeks.
* See http://en.wikipedia.org/wiki/ISO_8601#Duration for definitions of ISO duration and time interval.
*
* Parses a value like 2006-01-01--2006-01-15, or 2006-W24, or @P1W.
* Separate from and to dates or date and period with a double hyphen (--).
*
* The 'to' portion of the argument can be eliminated if it is the same as the 'from' portion.
* Use @ instead of a date to substitute in the current date and time.
*
* Use periods (P1H, P1D, P1W, P1M, P1Y) to get next hour/day/week/month/year from now.
* Use date before P sign to get next hour/day/week/month/year from that date.
* Use period then date to get a period that ends on the date.
*
*/
function arg_parts($argument) {
$fromto = explode('--', $argument);
$values = array();
foreach ($fromto as $arg) {
$parts = array();
if ($date == '@') {
$parts['date'] = date_array(date_now());
}
elseif (preg_match('/(\\d{4})?-?(W)?(\\d{1,2})?-?(\\d{1,2})?[T\\s]?(\\d{1,2})?:?(\\d{1,2})?:?(\\d{1,2})?/', $arg, $matches)) {
$date = array();
if (!empty($matches[1])) {
$date['year'] = $matches[1];
}
if (!empty($matches[3])) {
if (empty($matches[2])) {
$date['month'] = $matches[3];
}
else {
$date['week'] = $matches[3];
}
}
if (!empty($matches[4])) {
$date['day'] = $matches[4];
}
if (!empty($matches[5])) {
$date['hour'] = $matches[5];
}
if (!empty($matches[6])) {
$date['minute'] = $matches[6];
}
if (!empty($matches[7])) {
$date['second'] = $matches[7];
}
$parts['date'] = $date;
}
if (preg_match('/^P(\\d{1,4}[Y])?(\\d{1,2}[M])?(\\d{1,2}[W])?(\\d{1,2}[D])?([T]{0,1})?(\\d{1,2}[H])?(\\d{1,2}[M])?(\\d{1,2}[S])?/', $arg, $matches)) {
$period = array();
if (!empty($matches[1])) {
$period['year'] = str_replace('Y', '', $matches[1]);
}
if (!empty($matches[2])) {
$period['month'] = str_replace('M', '', $matches[2]);
}
if (!empty($matches[3])) {
$period['week'] = str_replace('W', '', $matches[3]);
}
if (!empty($matches[4])) {
$period['day'] = str_replace('D', '', $matches[4]);
}
if (!empty($matches[6])) {
$period['hour'] = str_replace('H', '', $matches[6]);
}
if (!empty($matches[7])) {
$period['minute'] = str_replace('M', '', $matches[7]);
}
if (!empty($matches[8])) {
$period['second'] = str_replace('S', '', $matches[8]);
}
$parts['period'] = $period;
}
$values[] = $parts;
}
return $values;
}
/**
* Use the parsed values from the ISO argument to determine the
* min and max date for this period.
*/
function arg_range($arg) {
// Parse the argument to get its parts
$parts = $this
->arg_parts($arg);
// Intercept invalid info and fall back to the current date.
if (empty($parts[0]) || empty($parts[0]['date']) && empty($parts[0]['period'])) {
$now = date_now();
return array(
$now,
$now,
);
}
// Build a range from a period-only argument (assumes the min date is now.)
if (empty($parts[0]['date']) && !empty($parts[0]['period']) && (empty($parts[1]) || empty($parts[1]['date']))) {
$min_date = date_now();
$max_date = drupal_clone($min_date);
foreach ($parts[0]['period'] as $part => $value) {
date_modify($max_date, "+{$value} {$part}");
}
date_modify($max_date, '-1 second');
return array(
$min_date,
$max_date,
);
}
if (!empty($parts[0]['date'])) {
$min_date = date_make_date($this
->complete_date($parts[0]['date'], 'min'));
// Build a range from a single date-only argument.
if (empty($parts[1]) || empty($parts[1]['date']) && empty($parts[1]['period'])) {
$max_date = date_make_date($this
->complete_date($parts[0]['date'], 'max'));
return array(
$min_date,
$max_date,
);
}
elseif (!empty($parts[1]['period'])) {
foreach ($parts[1]['period'] as $part => $value) {
$max_date = drupal_clone($min_date);
date_modify($max_date, "+{$value} {$part}");
}
date_modify($max_date, '-1 second');
return array(
$min_date,
$max_date,
);
}
}
// Build a range from start date and end date.
if (!empty($parts[1]['date'])) {
$max_date = $this
->complete_date($parts[1]['date'], 'max');
if (isset($min_date)) {
return array(
$min_date,
$max_date,
);
}
}
// Build a range from period + end date.
if (!empty($parts[0]['period'])) {
foreach ($parts[0]['period'] as $part => $value) {
$min_date = drupal_clone($max_date);
date_modify($min_date, "-{$value} {$part}");
}
return array(
$min_date,
$max_date,
);
}
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
date_sql_handler:: |
property | |||
|
date_sql_handler:: |
property | |||
|
date_sql_handler:: |
property | |||
|
date_sql_handler:: |
property | |||
|
date_sql_handler:: |
property | |||
|
date_sql_handler:: |
property | |||
|
date_sql_handler:: |
property | |||
|
date_sql_handler:: |
function | Parse date parts from an ISO date argument. | ||
|
date_sql_handler:: |
function | Use the parsed values from the ISO argument to determine the min and max date for this period. | ||
|
date_sql_handler:: |
function | Create a complete datetime value out of an incomplete array of selected values. | ||
|
date_sql_handler:: |
function | |||
|
date_sql_handler:: |
function | An array of all date parts, optionally limited to an array of allowed parts. | ||
|
date_sql_handler:: |
function | See if the db has timezone name support. | ||
|
date_sql_handler:: |
function | Convert a format string into help text, i.e. 'Y-m-d' becomes 'YYYY-MM-DD'. | ||
|
date_sql_handler:: |
function | Return timezone offset for the date being processed. | ||
|
date_sql_handler:: |
function | Part information. | ||
|
date_sql_handler:: |
function | A function to test the validity of various date parts | ||
|
date_sql_handler:: |
function | Set the database timzone offset. | ||
|
date_sql_handler:: |
function | Helper function to create cross-database SQL date extraction. | ||
|
date_sql_handler:: |
function | Helper function to create cross-database SQL dates. | ||
|
date_sql_handler:: |
function | Helper function to create cross-database SQL date formatting. | ||
|
date_sql_handler:: |
function | Adjust a field value by an offset in seconds. | ||
|
date_sql_handler:: |
function | Select a date value from the database, adjusting the value for the timezone. | ||
|
date_sql_handler:: |
function | Create a where clause to compare a complete date field to a complete date value. | ||
|
date_sql_handler:: |
function | Create a where clause to compare an extracted part of a field to an integer value. | ||
|
date_sql_handler:: |
function | Create a where clause to compare a formated field to a formated value. | ||
|
date_sql_handler:: |
function |