Events Module

From Fishcakes Wiki

Events Module

Information about structure of Exponent Events Module developed by Fishcakes for Cubitt Artists.
For information about using this module, see the Events Module User Guide.

Contents 1 About Events Module 2 File Structure 2.1 Module Folder 2.2 Definitions 2.3 Datatypes 2.4 Class 2.5 Actions 2.6 Views 2.7 Subsystem Files Datatypes 2.8 Subsystem Files Module Views 2.9 Javascript Files 2.10 Tutorial Files 3 Database Fields 3.1 Configuration Fields 3.2 Map Fields 4 Subsystems 4.1 Curator's List 5 Revisions 6 Search 7 Tags & Wizards 8 Workflow 9 Code Corrections 10 Code Modifications 10.1 Switch Off HTML Editor for Map Description field 11 Events Module See Also 12 Exponent CMS Resources 12.1 Official Exponent Resources 12.2 Unofficial Exponent Resources 12.3 MySQL Resources 12.4 PHP Resources

About Events Module

A module for displaying a list of Events on a home page, current page, upcoming page and archive page.

• Developed by Dan Salmon, October 2007.

File Structure

Module Folder

• modules/eventsmodule — contains files as indicated below.

Definitions

• datatypes/definitions/eventsmodule_config.php — creates database table of XXX fields with configuration settings for the module.
• datatypes/definitions/eventsitem.php — creates database table of XXX fields with setting for individual Events.
• datatypes/definitions/eventsitem.info.php — creates database table of 1 field.

Datatypes

• datatypes/eventsmodule_config.php — field input definitions for module configuration.
• datatypes/eventsitem.php — field input definitions for Events.

Class

• modules/eventsmodule/class.php — class definition.
• modules/eventsmodule/deps.php — list of dependencies.
• modules/eventsmodule/manifest.php — list of files.

Actions

• modules/eventsmodule/actions/delete.php — delete Event.
• modules/eventsmodule/actions/edit.php — edit Event.
• modules/eventsmodule/actions/save.php — save Event.
• modules/eventsmodule/actions/view.php — view Event.
• modules/eventsmodule/actions/view_all_events.php — view all Events.
• modules/eventsmodule/actions/view_expired.php — view expired Event.

Views

• modules/eventsmodule/views/Default.tpl — default view.
• modules/eventsmodule/views/Featured Events.tpl — tbd.
• modules/eventsmodule/views/Summary - Extended.tpl — tbd.
• modules/eventsmodule/views/Summary.tpl — tbd.
• modules/eventsmodule/views/_form_edit.tpl — tbd.
• modules/eventsmodule/views/_group_by_tags.tpl — tbd.
• modules/eventsmodule/views/_view_unpublished.tpl — tbd.
• modules/eventsmodule/views/_viewSingle.tpl — tbd.
• modules/eventsmodule/views/_workflowview.tpl — tbd.

Subsystem Files Datatypes

• subsystems/lang/eng_US/datatypes/eventsmodule_config.php — text (English US) used by datatypes template.
• subsystems/lang/eng_US/datatypes/eventsitem.php — text (English US) used by datatypes template.

Subsystem Files Module Views

Text files (English US) used by views templates:

• subsystems/lang/eng_US/modules/eventsmodule/views/Default.php.

Javascript Files

• tbd

Tutorial Files

• modules/eventsmodule/tutorial/index.html — tutorial page with module User Guide.
• modules/eventsmodule/tutorial/style.css — css style sheet.
• modules/eventsmodule/tutorial/images/ — images for tutorial.

Database Fields

Configuration Fields

• id — (id) — module id.
• location_data — (string 200) — module location data.
• SORT
• item_limit — (id) — [numeric, default 10]
• sortorder — (id) — acending/desending
• sortfield — (id) — posted date/published date - add curators/artists
• aggregate — (id) — combind all Events feeds
• RSS
• enable_rss — (id) — [tick]
• feed_title — (id) — [input box]
• feed_desc — (id) — [text box]
• TAGS
• enable_tags — (id) — [tick]
• collections — (id) — ????
• group_by_tags — (id) — ????
• show_tags — (id) — ????

Map Fields

• id — (id) — module id.
• location_data — (string 200) — module location.
• file_id — (id) — file id.
• rank — (integer) — rank allows maps to be moved up and down page.

• name — (string 200) — map title.
• map_link — (string 500) — url link to display Google Map.
• map_width — (integer) — map width.
• map_height — (integer) — map height.
• map_width_perc — (boolean) — display map width by percent.
• map_height_perc — (boolean) — display map height by percent (currently unused).
• map_controls — (string 10) — map controls (pan, zoom, type, scale, overlay) on/off.
• map_markers — (string 9) — turn Google Search markers on/off (Personal Markers are not affected).
• body — (string 5000) — text box to display (don't display if empty).
• notes — (string 5000) — notes, display on edit page only.

Subsystems

Dropdown lists used by datatype files for Module configuration and Map configuration.

Curator's List

Used to select the Curator's of each event:

• Subsystem — subsystems/lang/eng_US/datatypes/eventsTBD.php
• Datatype List — datatypes/eventsTBD.php

Values:

• tbd

Revisions

Not yet implemented.

Search

Not yet implemented.

Tags & Wizards

Not yet implemented.

Workflow

Not yet implemented.

Code Corrections

Necessary code changes required to fix bugs.

Code Modifications

Optional code changes which extend functionality.

Switch Off HTML Editor for Map Description field

To have a simple text field for your map description (body field) rather than using the HTML Editor. Edit file datatypes/events.php.

Remove the // from line 79:

// $form->register('body',$i18n['input_body'],new texteditorcontrol($object->body,6,false,5000));

Add the // to line 80 (or delete the line):

$form->register('body',$i18n['input_body'],new htmleditorcontrol($object->body));

Events Module See Also

• tbd

Exponent CMS Resources

Official Exponent Resources

• exponentcms.org — official website.
• exponentcms.org Download — get Exponent.
• sourceforge.net Exponent — get Exponent from SourceForge.
• exponentcms.org Download Themes — change the look.
• exponentcms.org Download Modules — extend Exponent.
• exponentcms.org Forums — for advice.
• exponentcms.org FAQ — How Do I guide to common questions.
• exponentcms.org User Guides — PDF downloads.

• exponentcms.org Designers Guide — doesn't really exist yet!
• exponentcms.org Developers Guide — doesn't really exist yet!
• exponentcms.org How To Create a Module — basic module structure explained.

Unofficial Exponent Resources

• phpxref.com Exponent — online browsing of Exponent 0.96.3 source code.
• netstepcms.com eXponent Overview — good review of what's on offer.
• zimmertech.com Tutorials — excellent tutorials on variety of topics, including great Themes tutorial.

MySQL Resources

• mysql.com — MySQL official website.
• mysql.com Documentation — official user guide.
• wikipedia.org MySQL — good history and definition.
• php.net MySQL Functions — using PHP and MySQL together.

PHP Resources

• php.net — PHP Hypertext Processor official website.
• wikipedia.org PHP — good history and definition.
• w3schools.com PHP Tutorial — excellent online tutorial.
• php.resourceindex.com — index of PHP code snippets for the seriously techie.