Drost-Tenfelde.de

Personal website of Jannes Drost-Tenfelde, resident bass trombone player at Cologne Concert Brass and Brass Band Merum

User Tools

Site Tools


Sidebar

General

Upcoming Events

  • CCB: Open Air
    28 September 2014 10:00-17:00

    Location: Rondorf

Music

Media

IT

Additional

dokuwiki:plugins:facebookevents

facebookevents Plugin

This pluging allows you to connect to your Facebook page and display the page's events in DokuWiki. This plugin uses the Facebook PHP SDK and FQL.

Installation

:!: External requirements: This plugin requires the following additional components that must be installed separately:

  • This plugin uses the Facebook PHP SDK, which requires
    • The CURL PHP extension to be installed
    • The JSON PHP extension to be installed
  • Additionally, you must create a Facebook App, which allows you to connect to Facebook using
    • App ID, which identifies your Facebook App (you can have multiple Apps)
    • App Secret, which secures your Facebook App

Install the plugin:

  • Extract the archive into your lib/plugins directory. Make sure the files are put into a directory called facebookevents.
  • Done! You are now ready to use facebookevents.

Examples/Usage

  • {{facebookevents>appid=123456&secret=123456&fanpageid=123456}} 1)
  • {{facebookevents>appid=123456&secret=123456&fanpageid=123456&numberOfEntries=3&sort=DESC}} 2)
  • {{facebookevents>appid=123456&secret=123456&fanpageid=123456&numberOfEntries=3&sort=ASC&from=today}} 3)

See the plugin in action here. The sample page shows all the styles available with the plugin.

Syntax

{{facebookevents>key=value&..&key=value}}
key the parameter key to set optional
value the parameter value to set optional

Multiple key=value parameters can be set using the & as a seperator.

Available parameters:

Key Type Comments Requirement Version
appid string This is the mandatory App ID of your Facebook App mandatory all
secret string This is the mandatory App Secret of your Facebook App mandatory all
fanpageid string This is the ID of your Facebook page. You can find this ID by going to your Facebook page. Typically, the link of your page looks like https://www.facebook.com/#!/pages/<page name>/<page ID>. Copy the page ID from the URL and use it in the syntax. mandatory all
showAs string Default: default. Allows you to use alternate display of the wall posts using configuration parameters. You can add more templates by editing the default.php and metadata.php files in the conf/ directory. optional all
from date This indicates the date from which the wall posts should be displayed. Older wall posts are disregarded. Format is DD/MM/YYYY. The value 'today' is also valid. optional all
to date This indicates the date to which the wall posts should be displayed. Newer wall posts are disregarded. Format is DD/MM/YYYY. The value 'today' is also valid. optional all
numberOfEntries number Indicates the maximum number of entries to display. optional all
sort string Default: DESC. Allows you to sort by the date of the wall post. Valid values are 'ASC' and 'DESC'. optional all
showEndTimes onoff Default: on. Allows you to display end times of the event. optional all
limit number Default: 0. Allows you to limit the maximum number of characters displayed for the message. optional Version 1.1

Configuration and Settings

Key Type Comments Requirement Version
dformat date Formatting of the event date (See Format) required all
tformat date Formatting of the event time (See Format) required all
default string Default template for displaying wall posts. required all

Display templates

You may add your own configuration parameters in order to display the wall posts in different formats. The appropriate configuration parameter for the template can be set via the syntax parameter showAs.

In order to make a new template, for example one that displays all wall posts as an unsorted list, the configuration files must be changed as follows:

conf/metadata.php

If you wish to alter your self-created template in the administration panel, you must setup the metadata for this parameter.

Example:

$meta['unsortedlist'] = array('');

conf/default.php

If you wish to set a default setting for the newly created parameter, you can set it up in default.php. This is optional, you can also use the administration panel to setup the configuration parameter.

$conf['unsortedlist'] = '  * {datetime}: {title} {description} ';

showAs

Once the configuration parameter has been added, you can use it in the plugin syntax:

{{facebookevents>appid=123456&secret=123456&fanpageid=123456&showAs=unsortedlist}}

Template tags

The templates, which can be configured in conf/default.php, or via the administraton panel, is parsed using the following tags:

Tag Comments
{date} The date of the wall post. The date format can be configured in the conf/default.php file.
{time} The time of the wall post. The time format can be configured in the conf/default.php file.
{datetime} The date and time of the wall post. This functions as {date} {time}.
{startdatetime} The date and time of the start of the event.
{startdate} The date of the start of the event.
{starttime} The time of the start of the event.
{enddatetime} The date and time of the end of the event.
{enddatetime} The date of the end of the event.
{endtime} The time of the start of the event.
{timestamp} The unix timestamp of the event.
{title} The title of the event.
{description} The event description.
{location} The location of the event.
{image} The original picture of the event.
{image_large} A large version of the picture of the event.
{image_small} A small version of the picture of the event.
{image_square} A squared version of the picture of the event.
{url} The unformated URL of the event. You can use this in your template to make your own links to the event.
{more} This is a fomated link to the event, using the language files to output a Read more... link.

Development

Change Log

  • 2012-03-26 Version 1.1
    • Fixed timing problem
    • Added 'limit' parameter that allows you to set the maximum number of characters displayed for {description}.
    • Added template tags {startdatetime}, {startdate, {starttime}, {enddatetime}, {enddate}, {endtime} and {timestamp}.
  • 2012-02-14 Version 1.0
    • Initial release

Known Bugs and Issues

ToDo/Wish List

  • Attachments.
  • Add a 'like' button.

FAQ

Discussion

Thank you for your contributions!

1) Displays all status messages on the facebook wall
2) Displays the 3 newest status messages on the facebook wall
3) Displays the 3 events after today
dokuwiki/plugins/facebookevents.txt ยท Last modified: 2013/01/22 22:40 (external edit)

Page Tools