base-calendar.inc.php

Go to the documentation of this file.

<?
class BaseCalendar extends MyManager
{
    public $startDay = 0;

    public $startMonth = 1;

    public $dayNames = array("S", "M", "T", "W", "T", "F", "S");
    
    public $monthNames = array("January", "February", "March", "April", "May", "June",
                            "July", "August", "September", "October", "November", "December");
                            
    public $daysInMonth = array(31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31);

    public $day = 0;
    
    public $dayCount = array();

    public $size;

    public $events = null;

    public function __construct($class = 'Event')
    {
        parent::__construct($class);
        
        if (!$this->page)
            $this->page = 'calendar';
    }
    
    public function getPagesXml()
    {
        $xml = parent::getPagesXml();
        $xml .= "<page name=\"upcoming\"/>\n";
        $xml .= "<page name=\"past\"/>\n";
        $xml .= "<page name=\"popular\"/>\n";
        $xml .= "<page name=\"calendar\">\n";
        $xml .= "\t<param name=\"month\" regex=\"/^[0-9]{1,2}$/\"/>\n";
        $xml .= "\t<param name=\"year\" regex=\"/^[0-9]{4}$/\"/>\n";
        $xml .= "</page>\n";
        $xml .= "<page name=\"date\">\n";
        $xml .= "\t<param name=\"year\" regex=\"/^[0-9]{4}$/\"/>\n";
        $xml .= "\t<param name=\"month\" regex=\"/^[0-9]{1,2}$/\"/>\n";
        $xml .= "\t<param name=\"day\" regex=\"/^[0-9]{1,2}$/\"/>\n";
        $xml .= "</page>\n";
        return $xml;
    }

    public function getSearchParamXml()
    {
        $xml = parent::getSearchParamXml();
        $xml .= <<<XML
            <param name="month" type="int"/>
            <param name="day" type="int"/>
            <param name="year" type="int"/>
            <param name="event_date_start" desc="start date for your query, eg 10-22-1983. it will get all the events happening on or after it" regex="/^[0-9]{4}-[0-9]{1,2}-[0-9]{1,2}([0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2})?$/"/>
            <param name="event_date_stop" desc="end date for your query. it will get all the events happening on or before it.  used with start date you can specify a range."  regex="/^[0-9]{4}-[0-9]{1,2}-[0-9]{1,2}([0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2})?$/"/>
XML;

        return $xml;
    }

    public function getSearchSelect($params)
    { 
        $sql = parent::getSearchSelect($params);

        $sql .= ", count(eg.user_id) AS guests ";

        return $sql;
    }

    public function getSearchFrom($params)
    {
        $from = parent::getSearchFrom($params);

        $from .= " LEFT OUTER JOIN {$this->object->guestTable} eg ON o.id = eg.event_id ";

        return $from;
    }
    
    public function getSearchWhere($params)
    {
        global $me;

        $where = parent::getSearchWhere($params);

        //get our params..
        $year = $params['year'];
        $month = str_pad($params['month'], 2, "0", STR_PAD_LEFT);
        $day = str_pad($params['day'], 2, "0", STR_PAD_LEFT);

        //check and make sql.
        if ($year && (int)$month && (int)$day)
            $where .= " AND o.start_date <= '$year-$month-$day' AND o.end_date >= '$year-$month-$day'";
        else if ($year && (int)$month)
            $where .= " AND (
                (o.start_date >= '$year-$month-01' && o.start_date <= '$year-$month-31') OR
                (o.end_date >= '$year-$month-01' && o.end_date <= '$year-$month-31')
            )";
        else if ($year)
            $where .= " AND (
                (o.start_date >= '$year-01-01' && o.start_date <= '$year-12-31') OR
                (o.end_date >= '$year-01-01' && o.end_date <= '$year-12-31')
            )";

        //when is our event start date??
        $start = $params['event_date_start'];
        if ($start)
            $where .= " AND (o.start_date >= '$start' OR o.end_date >= '$start')";
        
        //what about event stop date?
        $stop = $params['event_date_stop'];
        if ($stop)
            $where .= " AND o.start_date <= '$stop'";

        //what about invite only stuff?
        if ($this->object->hasField('invite_only'))
            $where .= " AND (o.invite_only = 0 OR (o.invite_only = 1 AND eg.user_id = '$me->id')) ";
        
        return $where;
    }

    public function getSearchOrder($params)
    {
        //get our sort...
        $sort = $params['sort'];
        $order = $params['order'];

        //if we dont have order and sort... add date desc!
        if (!$sort)
            $params['sort'] = 'start_date';
        if (!$order)
            $params['order'] = 'ASC';

        return parent::getSearchOrder($params);
    }
    
    protected function getSortFieldsArray()
    {
        $sort = parent::getSortFieldsArray();

        $sort['name'] = 'sort by number of name';
        $sort['guests'] = 'sort by number of guests';
        $sort['start_date'] = 'sort by number of start date';
        $sort['end_date'] = 'sort by number of end date';

        return $sort;
    }

    public function getSearchGroupBy($params)
    {
        return ' GROUP BY o.id ';
    }

    public function search($params, $limit = null)
    {
        if (!$params['month'] && !$params['year'] && !$params['event_date_start'] && !$params['event_date_stop'])
            $params['event_date_start'] = date('Y-m-d');
        return parent::search($params, $limit);
    }

    public function findDate()
    {
        if ($this->params('month'))
            $month = (int)$this->params('month');
        if ($this->params('year'))
            $year = (int)$this->params('year');
        if ($this->params('day'))
            $day = (int)$this->params('day');
    
        if (!$month)
            $month = date('m');
        if (!$year)
            $year = date('Y');

        $this->setParam('month', $month);
        $this->setParam('year', $year);
    }

    public function initMainPage()
    {
        Util::redirect(".calendar");
    }

    public function initSearchPage()
    {
        parent::initSearchPage();
        
        $this->pageTitle = 'Calendar of Events';
    } 

    public function initCalendarPage()
    {
        //what date?
        $this->findDate();
        
        //box and title...
        $this->pageTitle = 'Calendar of Events - ' . $this->monthNames[(int)$this->params('month')-1];
    }

    public function initDatePage()
    {
        global $me;

        $this->pageTitle = "Events for " . $me->formatDate($this->params('year') . "-" . $this->params('month') . "-" . $this->params('day'));
    }

    public function initUpcomingPage()
    {
        $this->setParam('event_date_start', date('Y-m-d'));

        $this->initSearchPage();
        
        $this->pageTitle = 'Upcoming Events';
    }

    public function initPopularPage()
    {
        $this->setParam('event_date_start', date('Y-m-d'));
        $this->setParam('sort', 'guests');
        $this->setParam('order', 'desc');

        $this->initSearchPage();
        
        $this->pageTitle = 'Popular Events';
    }
    
    public function initPastPage()
    {
        $this->setParam('event_date_stop', date('Y-m-d'));
        $this->setParam('order', 'desc');
        $this->initSearchPage();
        
        $this->pageTitle = 'Past Events';
    }

    public function drawDatePage()
    {
        $year = $this->params('year');
        $month = $this->params('month');
        $day = $this->params('day');
    
        echo "<p>" . $this->object->getLink(".edit?date=$year-$month-$day", "Post a new event on this day.");
        echo " | " . $this->getLink(".calendar?month=$month&year=$year", "Back to " . date("M Y", strtotime("$year-$month-$day")));
        echo "</p>";
        
        $rs = $this->search($this->params());
        if (count($rs))
            $this->drawResults($rs);
        else
            echo "<p>Sorry, there aren't any events on this day yet.</p>";

    }
    
    public function drawCalendarPage()
    {
        $this->drawSearchForm();

        echo "<div id=\"bigCalendar\">";
        $this->drawCalendar($this->params('month'), $this->params('year'));
        echo "</div>";

        //draw our events
        $events = $this->getMonthEvents($month, $year);
        $this->drawResults($events);
    } 

    public function drawUpcomingPage()
    {
        $this->drawSearchPage();
    }
    
    public function drawPopularPage()
    {
        $this->drawSearchPage();
    }
    
    public function drawPastPage()
    {
        $this->drawSearchPage();
    }

    public function drawCalendar($month, $year, $size = 'big')
    {
        //remember our size.
        $this->size = $size;
        
        //get our month events...
        $this->setMonthEvents($month, $year);

        //draw our calendar.
        echo $this->getMonthView($month, $year);
    }

    protected function getMonthEvents($month, $year)
    {
        if ($this->events === null)
        {
            //check to see what events are on this calendar month.
            return $this->search(array(
                'month' => $month,
                'year' => $year,
            ));
        }
        else
            return $this->events;
    } 
    
    protected function setMonthEvents($month, $year)
    { 
        $this->events = $this->getMonthEvents($month, $year);
        
        //did we get any?
        if (count($this->events))
        {
            //loop thru and put them in our array.
            foreach ($this->events AS $ob)
            {
                if (preg_match('/(\d{4})-(\d{2})-(\d{2})/', $ob->start_date, $m))
                    $this->dayCount[(int)$m[3]]++;          
            }
        }
    }

    function getDayNames()
    {
        return $this->dayNames;
    }
    

    function setDayNames($names)
    {
        $this->dayNames = $names;
    }
    
    function getMonthNames()
    {
        return $this->monthNames;
    }
    
    function setMonthNames($names)
    {
        $this->monthNames = $names;
    }
    
    function getStartDay()
    {
        return $this->startDay;
    }
    
    function setStartDay($day)
    {
        $this->startDay = $day;
    }
    
    
    function getStartMonth()
    {
        return $this->startMonth;
    }
    
    function setStartMonth($month)
    {
        $this->startMonth = $month;
    }
    
    function getCalendarLink($month, $year)
    {
        return $this->getUrl(".calendar?month=$month&year=$year");
    } 
    
    function getDateLink($day, $month, $year)
    {
        return $this->getUrl(".date?year=$year&month=$month&day=$day");
    }

    function getDateContent($day, $month, $year)
    {
        $s = $day;
    
        //how many events?
        if ($this->dayHasEvent($day) && $this->size == 'big')
            $s .= "<br/>" . Util::pluralize($this->object->english, $this->dayCount[$day], true);
    
        return $s;
    }
    
    function getMonthView($month, $year, $showYear = true)
    {
        //start our table.
        $s = "<table class=\"calendar\">\n";
        
        //adjust our date so its correct.
        $a = $this->adjustDate($month, $year);
        $month = $a[0];
        $year = $a[1];        

        //get our header.
        $s .= $this->getMonthHeader($month, $year, $showYear);
        $s .= $this->getMonthBody($month, $year);
        
        $s .= "</table>\n";
        
        return $s;      
    }
    
    function getMonthHeader($month, $year, $showYear = true)
    {
        //our monthname
        $monthName = $this->monthNames[$month - 1];
        
        //get our previous/next months.
        $prev = $this->adjustDate($month - 1, $year);
        $next = $this->adjustDate($month + 1, $year);
        
        //do we want links to prev/next?
        if ($showYear)
        {
            $prevMonth = $this->getCalendarLink($prev[0], $prev[1]);
            $nextMonth = $this->getCalendarLink($next[0], $next[1]);
        }
        else
        {
            $prevMonth = "";
            $nextMonth = "";
        }
        
        //set our header.
        $header = $monthName . (($showYear) ? " " . $year : "");
        
        $s  = "<tr>\n";
        $s .= "<th valign=\"top\">" . (($prevMonth == "") ? "&nbsp;" : "<a href=\"$prevMonth\">&lt;&lt;</a>")  . "</th>\n";
        $s .= "<th valign=\"top\" colspan=\"5\">$header</th>\n"; 
        $s .= "<th valign=\"top\">" . (($nextMonth == "") ? "&nbsp;" : "<a href=\"$nextMonth\">&gt;&gt;</a>")  . "</th>\n";
        $s .= "</tr>\n";
        
        $s .= "<tr>\n";
        $s .= "<th>" . $this->dayNames[($this->startDay)%7] . "</th>\n";
        $s .= "<th>" . $this->dayNames[($this->startDay+1)%7] . "</th>\n";
        $s .= "<th>" . $this->dayNames[($this->startDay+2)%7] . "</th>\n";
        $s .= "<th>" . $this->dayNames[($this->startDay+3)%7] . "</th>\n";
        $s .= "<th>" . $this->dayNames[($this->startDay+4)%7] . "</th>\n";
        $s .= "<th>" . $this->dayNames[($this->startDay+5)%7] . "</th>\n";
        $s .= "<th>" . $this->dayNames[($this->startDay+6)%7] . "</th>\n";
        $s .= "</tr>\n";

        return $s;
    }
        
    protected function getMonthBody($month, $year)
    {
        //init return string.
        $s = '';
        
        //find out our day count and general date info.
        $daysInMonth = $this->getDaysInMonth($month, $year);
        $date = getdate(mktime(12, 0, 0, $month, 1, $year));
        
        //get our first date
        $first = $date["wday"];
        
        // We need to work out what date to start at so that the first appears in the correct column
        $d = $this->startDay + 1 - $first;
        while ($d > 1)
            $d -= 7;

        // Make sure we know when today is, so that we can use a different CSS style
        $today = getdate(time());
        
        //loop until we run out of days.
        while ($d <= $daysInMonth)
        {
            $s .= "<tr>\n";       
            
            //each week day.
            for ($i = 0; $i < 7; $i++)
            {
                //if its today, we want a special class.
                if ($this->dayHasEvent($d))
                    $s .= '<td class="hasEvent">';
                else if ($year == $today["year"] && $month == $today["mon"] && $d == $today["mday"])
                    $s .= '<td class="today">';
                else
                    $s .= '<td>';

                //if its in the month... draw the day.  
                if ($d > 0 && $d <= $daysInMonth)
                {
                    $link = $this->getDateLink($d, $month, $year);
                    $content = $this->getDateContent($d, $month, $year);
                    if ($link)
                        $s .= "<a href=\"$link\">$content</a>";
                    else
                        $s .= $content;
                }
                //otherwise leave it blank.
                else
                {
                    $s .= "&nbsp;";
                }

                //end it
                $s .= "</td>\n";

                //next day.
                $d++;
            }

            //next row
            $s .= "</tr>\n";    
        }

        return $s;
    }

    public function dayHasEvent($d)
    {
        return ($this->dayCount[$d]);
    }
    
    function getYearView($year)
    {
        $s = "";
        $prev = $this->getCalendarLink(0, $year - 1);
        $next = $this->getCalendarLink(0, $year + 1);
        
        $s .= "<table class=\"calendar\" border=\"0\">\n";
        $s .= "<tr>";
        $s .= "<td align=\"center\" valign=\"top\" align=\"left\">" . (($prev == "") ? "&nbsp;" : "<a href=\"$prev\">&lt;&lt;</a>")  . "</td>\n";
        $s .= "<td class=\"calendarHeader\" valign=\"top\" align=\"center\">" . (($this->startMonth > 1) ? $year . " - " . ($year + 1) : $year) ."</td>\n";
        $s .= "<td align=\"center\" valign=\"top\" align=\"right\">" . (($next == "") ? "&nbsp;" : "<a href=\"$next\">&gt;&gt;</a>")  . "</td>\n";
        $s .= "</tr>\n";
        $s .= "<tr>";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(0 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(1 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(2 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "</tr>\n";
        $s .= "<tr>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(3 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(4 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(5 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "</tr>\n";
        $s .= "<tr>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(6 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(7 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(8 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "</tr>\n";
        $s .= "<tr>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(9 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(10 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "<td class=\"calendar\" valign=\"top\">" . $this->getMonthHTML(11 + $this->startMonth, $year, 0) ."</td>\n";
        $s .= "</tr>\n";
        $s .= "</table>\n";
        
        return $s;
    }
    
    /********************************************************************************
        The rest are private methods. No user-servicable parts inside.
        You shouldn't need to call any of these functions directly.
    *********************************************************************************/


    protected function getDaysInMonth($month, $year)
    {
        if ($month < 1 || $month > 12)
        {
            return 0;
        }
   
        $d = $this->daysInMonth[$month - 1];
   
        if ($month == 2)
        {
            // Check for leap year
            // Forget the 4000 rule, I doubt I'll be around then...
        
            if ($year%4 == 0)
            {
                if ($year%100 == 0)
                {
                    if ($year%400 == 0)
                    {
                        $d = 29;
                    }
                }
                else
                {
                    $d = 29;
                }
            }
        }
    
        return $d;
    }

    protected function getYearHTML($year)
    {
    }

    protected function adjustDate($month, $year)
    {
        $a = array();  
        $a[0] = $month;
        $a[1] = $year;
        
        while ($a[0] > 12)
        {
            $a[0] -= 12;
            $a[1]++;
        }
        
        while ($a[0] <= 0)
        {
            $a[0] += 12;
            $a[1]--;
        }
        
        return $a;
    }
}
?>

---