aboutsummaryrefslogtreecommitdiffstats
path: root/BSF/include/calendar_base.class.php
diff options
context:
space:
mode:
authorvdigital <vdigital@piwigo.org>2008-05-23 21:05:41 +0000
committervdigital <vdigital@piwigo.org>2008-05-23 21:05:41 +0000
commit77fd1f51a3c5f5a52f72ef8a299fe368228e2285 (patch)
treea67ede42904657ccf3349ecdaef1cec8b8e36ff8 /BSF/include/calendar_base.class.php
parent553727dffacc48e8337c1d141f2a25af359e74b1 (diff)
git-svn-id: http://piwigo.org/svn/trunk@2357 68402e56-0260-453c-a942-63ccdbb3a9ee
Diffstat (limited to 'BSF/include/calendar_base.class.php')
-rw-r--r--BSF/include/calendar_base.class.php351
1 files changed, 351 insertions, 0 deletions
diff --git a/BSF/include/calendar_base.class.php b/BSF/include/calendar_base.class.php
new file mode 100644
index 000000000..bd3d2b180
--- /dev/null
+++ b/BSF/include/calendar_base.class.php
@@ -0,0 +1,351 @@
+<?php
+// +-----------------------------------------------------------------------+
+// | Piwigo - a PHP based picture gallery |
+// +-----------------------------------------------------------------------+
+// | Copyright(C) 2008 Piwigo Team http://piwigo.org |
+// | Copyright(C) 2003-2008 PhpWebGallery Team http://phpwebgallery.net |
+// | Copyright(C) 2002-2003 Pierrick LE GALL http://le-gall.net/pierrick |
+// +-----------------------------------------------------------------------+
+// | 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 |
+// | |
+// | 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
+// | USA. |
+// +-----------------------------------------------------------------------+
+
+/**
+ * Base class for monthly and weekly calendar styles
+ */
+class CalendarBase
+{
+ // db column on which this calendar works
+ var $date_field;
+ // used for queries (INNER JOIN or normal)
+ var $inner_sql;
+ //
+ var $calendar_levels;
+
+ /**
+ * Initialize the calendar
+ * @param string inner_sql used for queries (INNER JOIN or normal)
+ */
+ function initialize($inner_sql)
+ {
+ global $page;
+ if ($page['chronology_field']=='posted')
+ {
+ $this->date_field = 'date_available';
+ }
+ else
+ {
+ $this->date_field = 'date_creation';
+ }
+ $this->inner_sql = $inner_sql;
+ }
+
+ function get_display_name()
+ {
+ global $conf, $page;
+ $res = '';
+
+ for ($i=0; $i<count($page['chronology_date']); $i++)
+ {
+ $res .= $conf['level_separator'];
+ if ( isset($page['chronology_date'][$i+1]) )
+ {
+ $chronology_date = array_slice($page['chronology_date'],0, $i+1);
+ $url = duplicate_index_url(
+ array( 'chronology_date'=>$chronology_date ),
+ array( 'start' )
+ );
+ $res .=
+ '<a href="'.$url.'">'
+ .$this->get_date_component_label($i, $page['chronology_date'][$i])
+ .'</a>';
+ }
+ else
+ {
+ $res .=
+ '<span class="calInHere">'
+ .$this->get_date_component_label($i, $page['chronology_date'][$i])
+ .'</span>';
+ }
+ }
+ return $res;
+ }
+
+//--------------------------------------------------------- private members ---
+ /**
+ * Returns a display name for a date component optionally using labels
+ */
+ function get_date_component_label($level, $date_component)
+ {
+ $label = $date_component;
+ if (isset($this->calendar_levels[$level]['labels'][$date_component]))
+ {
+ $label = $this->calendar_levels[$level]['labels'][$date_component];
+ }
+ elseif ('any' === $date_component )
+ {
+ $label = l10n('calendar_any');
+ }
+ return $label;
+ }
+
+ /**
+ * Gets a nice display name for a date to be shown in previos/next links.
+ */
+ function get_date_nice_name($date)
+ {
+ $date_components = explode('-', $date);
+ $res = '';
+ for ($i=count($date_components)-1; $i>=0; $i--)
+ {
+ if ('any' !== $date_components[$i])
+ {
+ $label = $this->get_date_component_label($i, $date_components[$i] );
+ if ( $res!='' )
+ {
+ $res .= ' ';
+ }
+ $res .= $label;
+ }
+ }
+ return $res;
+ }
+
+ /**
+ * Creates a calendar navigation bar.
+ *
+ * @param array date_components
+ * @param array items - hash of items to put in the bar (e.g. 2005,2006)
+ * @param string class_prefix - html class attribute prefix for span elements
+ * @param bool show_any - adds any link to the end of the bar
+ * @param bool show_empty - shows all labels even those without items
+ * @param array labels - optional labels for items (e.g. Jan,Feb,...)
+ * @return string the navigation bar
+ */
+ function get_nav_bar_from_items($date_components, $items,
+ $class_prefix, $show_any,
+ $show_empty=false, $labels=null)
+ {
+ global $conf, $page;
+
+ $nav_bar = '';
+
+ if ($conf['calendar_show_empty'] and $show_empty and !empty($labels) )
+ {
+ foreach ($labels as $item => $label)
+ {
+ if ( ! isset($items[$item]) )
+ {
+ $items[$item] = -1;
+ }
+ }
+ ksort($items);
+ }
+
+ foreach ($items as $item => $nb_images)
+ {
+ $label = $item;
+ if (isset($labels[$item]))
+ {
+ $label = $labels[$item];
+ }
+ if ($nb_images==-1)
+ {
+ $nav_bar .= '<span class="'.$class_prefix.'Empty">';
+ $nav_bar .= $label;
+ }
+ else
+ {
+ $nav_bar .= '<span class="'.$class_prefix.'">';
+ $url = duplicate_index_url(
+ array('chronology_date'=>array_merge($date_components,array($item))),
+ array( 'start' )
+ );
+ $nav_bar .= '<a href="'.$url.'">';
+ $nav_bar .= $label;
+ $nav_bar .= '</a>';
+ }
+ if ($nb_images > 0)
+ {
+ $nav_bar .= '('.$nb_images.')';
+ }
+ $nav_bar.= '</span>';
+ }
+
+ if ($conf['calendar_show_any'] and $show_any and count($items)>1 and
+ count($date_components)<count($this->calendar_levels)-1 )
+ {
+ $label = l10n('calendar_any');
+ $nav_bar .= '<span class="'.$class_prefix.'">';
+ $url = duplicate_index_url(
+ array('chronology_date'=>array_merge($date_components,array('any'))),
+ array( 'start' )
+ );
+ $nav_bar .= '<a href="'.$url.'">';
+ $nav_bar .= $label;
+ $nav_bar .= '</a>';
+ $nav_bar.= '</span>';
+ }
+ return $nav_bar;
+ }
+
+ /**
+ * Creates a calendar navigation bar for a given level.
+ *
+ * @param int level - the level (0-year,1-month/week,2-day)
+ * @return void
+ */
+ function build_nav_bar($level, $labels=null)
+ {
+ global $template, $conf, $page;
+
+ $query = '
+SELECT DISTINCT('.$this->calendar_levels[$level]['sql']
+ .') as period';
+ $query.= $this->inner_sql;
+ $query.= $this->get_date_where($level);
+ $query.= '
+ GROUP BY period
+;';
+
+ $level_items = array();
+ $result = pwg_query($query);
+ while ($row = mysql_fetch_array($result))
+ {
+ $level_items[$row['period']] = 0;
+ }
+
+ if ( count($level_items)==1 and
+ count($page['chronology_date'])<count($this->calendar_levels)-1)
+ {
+ if ( ! isset($page['chronology_date'][$level]) )
+ {
+ list($key) = array_keys($level_items);
+ $page['chronology_date'][$level] = (int)$key;
+
+ if ( $level<count($page['chronology_date']) and
+ $level!=count($this->calendar_levels)-1 )
+ {
+ return;
+ }
+ }
+ }
+
+ $dates = $page['chronology_date'];
+ while ($level<count($dates))
+ {
+ array_pop($dates);
+ }
+
+ $nav_bar = $this->get_nav_bar_from_items(
+ $dates,
+ $level_items,
+ 'calItem',
+ true,
+ true,
+ isset($labels) ? $labels : $this->calendar_levels[$level]['labels']
+ );
+
+ $template->append(
+ 'chronology_navigation_bars',
+ array(
+ 'CONTENT' => $nav_bar,
+ )
+ );
+ }
+
+ /**
+ * Assigns the next/previous link to the template with regards to
+ * the currently choosen date.
+ */
+ function build_next_prev()
+ {
+ global $template, $page;
+ $prev = $next =null;
+ if ( empty($page['chronology_date']) )
+ return;
+ $query = 'SELECT CONCAT_WS("-"';
+ for ($i=0; $i<count($page['chronology_date']); $i++)
+ {
+ if ( 'any' === $page['chronology_date'][$i] )
+ {
+ $query .= ','.'"any"';
+ }
+ else
+ {
+ $query .= ','.$this->calendar_levels[$i]['sql'];
+ }
+ }
+ $current = implode('-', $page['chronology_date'] );
+
+ $query.=') as period' . $this->inner_sql .'
+AND ' . $this->date_field . ' IS NOT NULL
+GROUP BY period';
+
+ $upper_items = array_from_query( $query, 'period');
+
+ usort($upper_items, 'version_compare');
+ $upper_items_rank = array_flip($upper_items);
+ if ( !isset($upper_items_rank[$current]) )
+ {
+ array_push($upper_items, $current);// just in case (external link)
+ usort($upper_items, 'version_compare');
+ $upper_items_rank = array_flip($upper_items);
+ }
+ $current_rank = $upper_items_rank[$current];
+
+ $tpl_var = array();
+
+ if ( $current_rank>0 )
+ { // has previous
+ $prev = $upper_items[$current_rank-1];
+ $chronology_date = explode('-', $prev);
+ $tpl_var['previous'] =
+ array(
+ 'LABEL' => $this->get_date_nice_name($prev),
+ 'URL' => duplicate_index_url(
+ array('chronology_date'=>$chronology_date), array('start')
+ )
+ );
+ }
+
+ if ( $current_rank < count($upper_items)-1 )
+ { // has next
+ $next = $upper_items[$current_rank+1];
+ $chronology_date = explode('-', $next);
+ $tpl_var['next'] =
+ array(
+ 'LABEL' => $this->get_date_nice_name($next),
+ 'URL' => duplicate_index_url(
+ array('chronology_date'=>$chronology_date), array('start')
+ )
+ );
+ }
+
+ if ( !empty($tpl_var) )
+ {
+ $existing = & $template->get_template_vars('chronology_navigation_bars');
+ if ( !empty($existing) )
+ {
+ $existing[ sizeof($existing)-1 ] =
+ array_merge( $existing[ sizeof($existing)-1 ], $tpl_var);
+ }
+ else
+ {
+ $template->append( 'chronology_navigation_bars', $tpl_var );
+ }
+ }
+ }
+}
+?>