Advanced Event Timeline With PHP, CSS & jQuery

22 January 2010 Friday

This application was viewed 1133 times

0

Advanced Event Timeline With PHP, CSS & jQuery

First I want to take the time to thank you, Tutorialzine’s readers, for all your support the past year and to wish you a happy new 2010! A lot of interesting tutorials are on their way and there are also some nice changes planned which I am sure you’ll like.

Now lets start the year with a brand new tut!

It all began last week, when I received this letter from one of our readers:

View The DEMO

Step 1 – XHTML

First, be sure to grab the example files from the button above, so that you can easily follow what is going on.

The first step of this tut is to create the XHTML structure, as seen in demo.php.

demo.php

<div id="timelineLimiter"> <!-- Hides the overflowing timelineScroll div -->
<div id="timelineScroll"> <!-- Contains the timeline and expands to fit -->
  
<!-- PHP code that generates the event list -->
  
<div class="clear"></div> 
</div> 
  
<div id="scroll"> <!-- The year time line -->
<div id="centered"> <!-- Sized by jQuery to fit all the years -->
<div id="highlight"></div> <!-- The light blue highlight shown behind the years -->
<?php echo $scrollPoints ?> <!-- This PHP variable holds the years that have events -->
<div class="clear"></div> 
  
</div> 
</div> 
  
<div id="slider"> <!-- The slider container -->
<div id="bar"> <!-- The bar that can be dragged -->
<div id="barLeft"></div>  <!-- Left arrow of the bar -->
<div id="barRight"></div>  <!-- Right arrow, both are styled with CSS -->
</div> 
</div> 
  
</div>

I have omitted some of the PHP code that generates the events so we can take a better look at the markup (we will get back to it in the next step).

Te main idea is that we have two divs – timelineLimiter and timelineScroll positioned inside it. The former takes the width of the screen, and the latter is expanded to fit all the event sections that are inserted inside it. This way only a part of the larger inner div is visible and the rest can be scrolled to the left and right by a jQuery slider we will be making in step 4.

Now lets take a look at the PHP back-end.

Step 2 – PHP

PHP selects all the events in the database and groups the events by year in the $dates array. It later loops through it and outputs all the events as <li> elements inside of unordered lists which belong to each of the event years.

demo.php

// We first select all the events from the database ordered by date: 
  
$dates = array(); 
$res = mysql_query("SELECT * FROM timeline ORDER BY date_event ASC"); 
  
while($row=mysql_fetch_assoc($res)) 
{ 
    // Store the events in an array, grouped by years: 
    $dates[date(´Y´,strtotime($row[´date_event´]))][] = $row; 
} 
  
$colors = array(´green´,´blue´,´chreme´); 
$scrollPoints = ´´; 
  
$i=0; 
foreach($dates as $year=>$array) 
{ 
    // Loop through the years: 
  
    echo ´ 
        <div class="event"> 
        <div class="eventHeading ´.$colors[$i++%3].´">´.$year.´</div> 
        <ul class="eventList">´; 
  
    foreach($array as $event) 
    { 
        // Loop through the events in the current year: 
  
        echo ´<li class="´.$event[´type´].´"> 
            <span class="icon" title="´.ucfirst($event[´type´]).´"></span> 
            ´.htmlspecialchars($event[´title´]).´
  
            <div class="content"> 
                <div class="body">´.($event[´type´]==´image´?´<div style="text-align:center"><img src="´.$event[´body´].´" alt="Image" /></div>´:nl2br($event[´body´])).´</div> 
                <div class="title">´.htmlspecialchars($event[´title´]).´</div> 
                <div class="date">´.date("F j, Y",strtotime($event[´date_event´])).´</div> 
            </div> 
            </li>´; 
    } 
  
    echo ´</ul></div>´; 
  
    // Generate a list of years for the time line scroll bar: 
    $scrollPoints.=´<div class="scrollPoints">´.$year.´</div>´; 
  
}

Thus the complete markup for the page is generated. Now we are ready to apply some styles.

Step 3 – CSS

After we’ve inserted the CSS stylesheet to the head section of the document, we can start laying down the rules. Only the more interesting ones are included here. You can view the rest in styles.css.

styles.css

.event{ 
    /* Contains the section title and list with events */
    float:left; 
    padding:4px; 
    text-align:left; 
    width:300px; 
    margin:0 5px 50px; 
} 
  
.eventList li{ 
    /* The individual events */
    background:#F4F4F4; 
    border:1px solid #EEEEEE; 
    list-style:none; 
    margin:5px; 
    padding:4px 7px; 
  
    /* CSS3 rounded corners */
    -moz-border-radius:4px; 
    -webkit-border-radius:4px; 
    border-radius:4px; 
} 
  
.eventList li:hover{ 
    /* The hover state: */
    cursor:pointer; 
    background:#E6F8FF; 
    border:1px solid #D4E6EE; 
    color:#548DA5; 
} 
  
li span{ 
    /* The event icon */
    display:block; 
    float:left; 
    height:16px; 
    margin-right:5px; 
    width:16px; 
} 
  
/* Individual background images for each type of event: */
  
li.news span.icon {     background:url(img/icons/newspaper.png) no-repeat; } 
li.image span.icon {    background:url(img/icons/camera.png) no-repeat; } 
li.milestone span.icon {    background:url(img/icons/chart.png) no-repeat; } 
  
#timelineLimiter{ 
    /* Hides the overflowing timeline */
    width:100%; 
    overflow:hidden; 
    padding-top:10px; 
    margin:40px 0; 
} 
  
#scroll{ 
    /* The small timeline below the main one. Hidden here and shown by jQuery if JS is enabled: */
    display:none; 
    height:30px; 
  
    background:#F5F5F5; 
    border:1px solid #EEEEEE; 
    color:#999999; 
} 
  
.scrollPoints{ 
    /* The individual years */
    float:left; 
    font-size:1.4em; 
    padding:4px 10px; 
    text-align:center; 
    width:100px; 
  
    position:relative; 
    z-index:10; 
}

Here the .event class styles the event years sections (these are the divs that group events that have happened in the same year).

Near the middle of the code you can see that we’ve used some CSS3 rounded corners which work in the majority of browsers (not supported by IE and Opera).

We also define individual background images for each of the event types – image, news or milestone.

Step 4 – jQuery

The last step is to insert a layer of interactivity into the browser. We will be doing this with the help of the jQuery JavaScript library, included in the head section of demo.php.

I’ve split the code below in two parts so they are more comprehensible.

script.js – Part 1

$(document).ready(function(){ 
  
    /* This code is executed after the DOM has been completely loaded */
  
    /* The number of event sections / years with events */
  
    var tot=$(´.event´).length; 
  
    $(´.eventList li´).click(function(e){ 
  
        showWindow(´<div>´+$(this).find(´div.content´).html()+´</div>´); 
    }); 
  
    /* Each event section is 320 px wide */
    var timelineWidth = 320*tot; 
  
    var screenWidth = $(document).width(); 
  
    $(´#timelineScroll´).width(timelineWidth); 
  
    /* If the timeline is wider than the screen show the slider: */
    if(timelineWidth > screenWidth) 
    { 
        $(´#scroll,#slider´).show(); 
        $(´#centered,#slider´).width(120*tot); 
  
        /* Making the scrollbar draggable: */
        $(´#bar´).width((120/320)*screenWidth).draggable({ 
  
            containment: ´parent´, 
            drag: function(e, ui) { 
  
            if(!this.elem) 
            { 
                /* This section is executed only the first time the function is run for performance */
  
                this.elem = $(´#timelineScroll´); 
  
                /* The difference between the slider´s width and its container: */
                this.maxSlide = ui.helper.parent().width()-ui.helper.width(); 
  
                /* The difference between the timeline´s width and its container */
                this.cWidth = this.elem.width()-this.elem.parent().width(); 
  
                this.highlight = $(´#highlight´); 
            } 
  
            /* Translating each movement of the slider to the timeline: */
            this.elem.css({marginLeft:´-´+((ui.position.left/this.maxSlide)*this.cWidth)+´px´}); 
  
            /* Moving the highlight: */
            this.highlight.css(´left´,ui.position.left) 
        } 
  
    }); 
  
    $(´#highlight´).width((120/320)*screenWidth-3); 
} 
});

As you may have noticed in the PHP section of the tut (if not check it out – around line 33) that with each event we include a set of div elements which contain additional information (title, text and date). Those are hidden with display:none in our CSS file, and are accessed by jQuery so that the pop-up window can be populated with data without the need of sending AJAX requests (not to mention that this content is visible to search engines and is great for SEO). So it is a win-win solution.

The data itself is being fetched in the second part of the script below:

script.js – Part 2

function showWindow(data) 
{ 
    /* Each event contains a set of hidden divs that hold 
additional information about the event: */
  
    var title = $(´.title´,data).text(); 
    var date = $(´.date´,data).text(); 
    var body = $(´.body´,data).html(); 
  
    $(´<div id="overlay">´).css({ 
  
        width:$(document).width(), 
        height:$(document).height(), 
        opacity:0.6 
  
    }).appendTo(´body´).click(function(){ 
  
        $(this).remove(); 
        $(´#windowBox´).remove(); 
   }); 
  
   $(´body´).append(´<div id="windowBox"><div id="titleDiv">´+title+´</div>´+body+´<div id="date">´+date+´</div></div>´); 
  
   $(´#windowBox´).css({ 
  
        width:500, 
        height:350, 
        left: ($(window).width() - 500)/2, 
        top: ($(window).height() - 350)/2 
    }); 
}

In this function we are basically treating the parameter passed from Part 1 above, where the function is called, as regular HTML and use the standard jQuery selectors thus populating the title, date and body variables.

Step 5 – MySQL

This last step is only needed if you plan to run the demo on your own server, or like an addition to your current site.

To make it all tick, you have to recreate the timeline MySQL table from timeline.sql, provided in the download archive. You will also need to fill in your database credentials in connect.php.

With this our Event Timeline is complete!

Tags: php, css, jquery, timeline,