Welcome to the new Developer Guide for e107.

The Developer Guide is still under construction but more and more information is added over time.

You can use the menu on the left to navigate to the underlying pages.

Introduction

Best practices

• Do not modify the core database structure

• Do not (ab)use database tables and fields for other purposes

Database prefix

The default database table prefix is e107_ and can be customized by the user during the installation of e107. The prefix that is used on an installation can always be found in the e107_config.php file.

There are several ways the database prefix is used:

3. In rare cases, you may reference the MPREFIX constant. Its use is deprecated and not encouraged.

Database tables overview

The following table provides an overview of all database tables in a clean e107 installation, with their respective purposes.

Introduction

Your code should not produce any PHP warnings or notices during normal usage. This primarily implies that all variables must be defined before being used. It also implies that a corrupted installation may produce errors, although as far as practicable the code should accommodate this.

Browser addon

Example: yourwebsite.com/news.php?[debug=basic!]

Debug modes

Introduction

$cache = e107::getCache();

Cache methods

retrieve()

retrieve_sys()

set()

clear()

clear_sys()

Cache types

Introduction

...

Basic CSS methods

Including css in your plugin or theme may be achieved by using the following function:

e107::css($type, $value);

Examples

The table below provides an overview of the default folder structure of an e107 installation:

Introduction

Events methods

register()

e107::getEvent()->register(name, function, include);

Example 1: trigger myFunction() on user login.

e107::getEvent()->register('login', 'myFunction'); 

function myFunction($data)
{
   // do something    
}

Example 2: trigger myFunction() on user login. Function in external file.

e107::getEvent()->register('login', 'myFunction',  e_PLUGIN."myplugin/myFunctions.php");

Example 3: trigger a class and method on user login.

e107::getEvent()->register('login', array('myClass', 'myMethod'),  e_PLUGIN."myplugin/myClass.php");

trigger()

Triggers an event. This can be used by plugin authors to create their own plugin events that other developers can hook into.

e107::getEvent()->trigger($eventname, $data = '');

// Example for plugin authors to create their own plugin event:
e107::getEvent()->trigger("plugindir_customevent", $data = ''); // plugindir is the name of the plugin folder

Core Event triggers

User Event Triggers

Basic user functions

Custom page

News

Private Messenger

Forum

Chatbox

Admin Event Triggers

Admin changes their password

Comments Manager

Downloads

News

Pages

Users

Introduction

Use the following to retrieve the alerts class object.

$mes = e107::getMessage();

Alerts methods

addSuccess()

$mes = e107::getMessage();
$mes->addSuccess('You did it!');

addError()

$mes = e107::getMessage();
$mes->addError('There was a problem!');

addWarning()

$mes = e107::getMessage();
$mes->addWarning('You do not have access to this area!');

addInfo()

$mes = e107::getMessage();
$mes->addInfo('Please take note!');

addDebug()

$mes = e107::getMessage();
$mes->addInfo('Please take note!');

render()

None of the above methods will output anything, until you use this method to render them.

$mes = e107::getMessage();
$mes->addInfo('Please take note!');
echo $mes->render();

To create a simple test script, create a new file called helloworld.php in your root folder with the following PHP code:

Then point your browser to www.yoursite.com/helloworld.phpand you're ready!

Introduction

Use the following to retrieve the language class object

Language methods

bcDefs()

Overview

The table below provides a quick overview of all classes that are used in e107 and are commonly used by developers.

Include meta tags in the html header.

e107::meta($name, $content, $extended);

Examples

e107::meta('keywords','some words'); 
e107::meta('apple-mobile-web-app-capable','yes'); 

Introduction

Use the following to retrieve the render class object.

$ns = e107::getRender();

Render methods

tablerender()

Send HTML to the browser for output.

$ns->tablerender($caption, $text, $mode, $return);

Introduction

$gen = e107::getDate();

Date methods

computeLapse()

Calculate difference between two dates for display in terms of years/months/weeks....

$gen->computeLapse($older_date, $newer_date = FALSE, $mode = FALSE, $show_secs = TRUE, $format = 'long') 

convert_date()

Convert datestamp to human readable date. System time offset is considered.

$gen->convert_date($datestamp, $mask = '')

terms()

Return an array of language terms representing months

$gen->terms($type='month')

Introduction

Use the following to retrieve the parser class object.

$tp = e107::getParser();

Parser methods

toHTML()

Parse HTML in various ways. eg. replace constants, convert bbcode etc.

$tp->toHTML($text, $parseBB = false, $modifiers = '', $postID = '', $wrap = false)

Example

$tp->toHtml("<strong class="bbcode bold bbcode-b bbcode-b-page">Bold print</strong>", true, 'BODY'); 

toDate()

Convert a UNIX timestamp into a readable format.

$tp->toDate($datestamp = null, $format = 'short')

toText()

Convert html to plain text.

$tp->toText(string);

createConstants()

Convert e_xxxxx paths to their equivalent shortcodes. eg. e_PLUGIN becomes {e_PLUGIN}

$tp->createConstants(string);

replaceConstants()

Convert {e_XXXX} shortcode paths to their equivalent constants. eg. {e_PLUGIN} becomes e_PLUGIN

$tp->replaceConstants(string);

parseTemplate()

Parse an e107 template using core and/or custom shortcodes. ie. replaces all instances of {XXXXX_XXXX} etc.

$tp->parseTemplate($template, true, $custom_shortcodes);

thumbUrl()

Use to convert {e_MEDIA_IMAGE} and other image paths to an auto-sized image path for use inside an <img> tag.

$url   = "{e_MEDIA_IMAGE}2012-04/someimage.jpg";
$image = $tp->thumbUrl($url);

echo "<img src='".$image."' />

setThumbSize()

Set the width, height and crop of the thumbUrl function.

$tp->setThumbSize($width, $height, $crop);

toGlyph()

$tp->toGlyph("fa-anchor");

Advanced settings:

$tp->toGlyph("fa-anchor", array('size'=>'2x'));

toIcon()

Render an icon. If a .glyph extension is found, it will automatically use the toGlyph() function above.

$iconPath = "{e_MEDIA}myicon.png";
$tp->toIcon($iconPath);

toAvatar()

Render a user avatar. If empty, the current user's avatar will be displayed if found or a generic avatar image.

echo $tp->toAvatar(); // render avatar of the current user. 

$userData = e107::user(5);  // Get User data for user-id #5. 
echo $tp->toAvatar($userData); // requires as a minimum $userData['user_image'].

toImage()

Render an image.

$url = "{e_MEDIA_IMAGE}2012-04/someimage.jpg";
$parms = array('w'=>500, 'h'=>200,'crop'=>1, 'alt'=>'my image'); // if not width/height set, the default as set by {SETIMAGE} will be used.
echo $tp->toImage($url,$parms); 

lanVars()

define("LAN_EXAMPLE_01", "Update results: [x] records changed, [y] errors, [z] not changed");

$repl = array($changed, $errors, $unchanged);
$text = $tp->lanVars(LAN_EXAMPLE_01, $repl);

Parser options

// Set up the defaults
	private $e_optDefault = array(
		// default context: reflects legacy settings (many items enabled)
		'context'      => 'OLDDEFAULT',
		//
		'fromadmin'    => false,

		// Enable emote display
		'emotes'       => true,

		// Convert defines(constants) within text.
		'defs'         => false,

		// replace all {e_XXX} constants with their e107 value - 'rel' or 'abs'
		'constants'    => false,

		// Enable hooked parsers
		'hook'         => true,

		// Allow scripts through (new for 0.8)
		'scripts'      => true,

		// Make links clickable
		'link_click'   => true,

		// Substitute on clickable links (only if link_click == TRUE)
		'link_replace' => true,

		// Parse shortcodes - TRUE enables parsing
		'parse_sc'     => false,

		// remove HTML tags.
		'no_tags'      => false,

		// Restore entity form of quotes and such to single characters - TRUE disables
		'value'        => false,

		// Line break compression - TRUE removes newline characters
		'nobreak'      => false,

		// Retain newlines - wraps to \n instead of <br /> if TRUE (for non-HTML email text etc)
		'retain_nl'    => false
	);

Parser modifiers

// Super modifiers override default option values
	private $e_SuperMods = array(
		//text is part of a title (e.g. news title)
		'TITLE'        =>
			array(
				'nobreak' => true, 'retain_nl' => true, 'link_click' => false, 'emotes' => false, 'defs' => true, 'parse_sc' => true
			),
		'TITLE_PLAIN'  =>
			array(
				'nobreak' => true, 'retain_nl' => true, 'link_click' => false, 'emotes' => false, 'defs' => true, 'parse_sc' => true, 'no_tags' => true
			),
		//text is user-entered (i.e. untrusted) and part of a title (e.g. forum title)
		'USER_TITLE'   =>
			array(
				'nobreak' => true, 'retain_nl' => true, 'link_click' => false, 'scripts' => false, 'emotes' => false, 'hook' => false
			),
		// text is 'body' of email or similar - being sent 'off-site' so don't rely on server availability
		'E_TITLE'      =>
			array(
				'nobreak' => true, 'retain_nl' => true, 'defs' => true, 'parse_sc' => true, 'emotes' => false, 'scripts' => false, 'link_click' => false
			),
		// text is part of the summary of a longer item (e.g. content summary)
		'SUMMARY'      =>
			array(
				'defs' => true, 'constants' => 'full', 'parse_sc' => true
			),
		// text is the description of an item (e.g. download, link)
		'DESCRIPTION'  =>
			array(
				'defs' => true, 'constants' => 'full', 'parse_sc' => true
			),
		// text is 'body' or 'bulk' text (e.g. custom page body, content body)
		'BODY'         =>
			array(
				'defs' => true, 'constants' => 'full', 'parse_sc' => true
			),
		// text is parsed by the Wysiwyg editor. eg. TinyMce
		'WYSIWYG'      =>
			array(
				'hook' => false, 'link_click' => false, 'link_replace' => false, 'retain_nl' => true
			),
		// text is user-entered (i.e. untrusted)'body' or 'bulk' text (e.g. custom page body, content body)
		'USER_BODY'    =>
			array(
				'constants' => 'full', 'scripts' => false, 'nostrip' => false
			),
		// text is 'body' of email or similar - being sent 'off-site' so don't rely on server availability
		'E_BODY'       =>
			array(
				'defs' => true, 'constants' => 'full', 'parse_sc' => true, 'emotes' => false, 'scripts' => false, 'link_click' => false
			),
		// text is text-only 'body' of email or similar - being sent 'off-site' so don't rely on server availability
		'E_BODY_PLAIN' =>
			array(
				'defs' => true, 'constants' => 'full', 'parse_sc' => true, 'emotes' => false, 'scripts' => false, 'link_click' => false, 'retain_nl' => true, 'no_tags' => true
			),
		// text is the 'content' of a link (A tag, etc)
		'LINKTEXT'     =>
			array(
				'nobreak' => true, 'retain_nl' => true, 'link_click' => false, 'emotes' => false, 'hook' => false, 'defs' => true, 'parse_sc' => true
			),
		// text is used (for admin edit) without fancy conversions or html.
		'RAWTEXT'      =>
			array(
				'nobreak' => true, 'retain_nl' => true, 'link_click' => false, 'emotes' => false, 'hook' => false, 'no_tags' => true
			),
		'NODEFAULT'    =>
			array('context' => false, 'fromadmin' => false, 'emotes' => false, 'defs' => false, 'constants' => false, 'hook' => false,
			      'scripts' => false, 'link_click' => false, 'link_replace' => false, 'parse_sc' => false, 'no_tags' => false, 'value' => false,
			      'nobreak' => false, 'retain_nl' => false
			)
	);

Introduction

....

Basic Javascript methods

Including Javascript in your plugin or theme may be achieved by using the following function:

e107::js($type, $data, $parm = null, $zone = null, $pre = '', $post = '')

type & data

Examples

Example #1

Load a script in the 'faqs' plugin directory and auto-load jQuery if not already loaded.

e107::js('faqs','js/faqs.js', 'jquery')

Example #2

Load a theme script in the footer

e107::js("theme", "js/scripts.js", 'jquery');  // no 'zone' value, loaded in the footer by default. 

Example #3

Load a theme script in the header

e107::js("theme", "js/scripts.js", 'jquery', 2); // including a 'zone' value loads it in the header 

settings

An associative array with configuration options.

• The array is merged directly into e107.settings.

• All plugins should wrap their actual configuration settings in another variable to prevent conflicts in the e107.settings namespace.

• Items added with a string key will replace existing settings with that key; items with numeric array keys will be added to the existing settings array.

JavaScript Behaviors

Behaviors are event-triggered actions that attach to page elements, enhancing default non-JavaScript UI's.

Behaviors are registered in the e107.behaviors object using the method 'attach' and optionally also 'detach' as follows:

var e107 = e107 || {'settings': {}, 'behaviors': {}};

(function ($)
{
  e107.behaviors.myBehavior = {
    attach: function (context, settings)
    {

    },
    detach: function (context, settings, trigger)
    {

    }
  };
})(jQuery);

e107.attachBehaviors is added to the jQuery ready event and so runs on initial page load. Developers implementing Ajax in their solutions should also call this function after new page content has been loaded, feeding in an element to be processed, in order to attach all behaviors to the new content.

See the e107_web/js/core/all.jquery.js file for more information.

Using jQuery

jQuery is now namespaced to avoid conflicts with other Javascript libraries such as Prototype. All your code that expects to use jQuery as $ should be wrapped in an outer context like so.

(function ($) {
  // All your code here.
})(jQuery);

If you don't, you may see the following error:Uncaught TypeError: Property '$' of object [object DOMWindow] is not a function or similar

jQuery Once

e107.behaviors will often be called multiple times on a page. For example, core/custom plugin performs some Ajax operation, all e107 behaviors will be executed again after page load, in order to attach any relevant JavaScript to the newly loaded elements.

This can have the undesired affect of applying JavaScript to elements each time e107 behaviors are executed, resulting in the same code being applied multiple times. To ensure that the JavaScript is applied only once, we can use the jQuery $.once() function. This function will ensure that the code inside the function is not executed if it has already been executed for the given element.

Using jQuery $.once() (integrated into e107 core), the developer experience of applying these effects is improved. Note that there is also the $.removeOnce() method that will only take effect on elements that have already applied the behaviors.

var e107 = e107 || {'settings': {}, 'behaviors': {}};

(function ($)
{

  e107.behaviors.myBehavior = {
    attach: function (context, settings)
    {
      $(context).find(".some-element").once('my-behavior').each(function ()
      {
        // All your code here.
      });
    }
  };

})(jQuery);

Settings passed locally to JavaScript Behaviors

e107.behaviors.myBehavior = {
  attach: function(context, settings) {
    $('#example', context).html(settings.myvar);
  }
};

How to override a JavaScript Behavior

If you want to override a bit of core (or third party) e107 JavaScript Behavior, just copy the behavior to your Javascript file (e.g in your plugin or theme), then load it after the original code using "zones".

Introduction

Use the following to retrieve the database class object

$sql = e107::getDb();

Basic database methods

select()

Selecting data from a database table

$sql->select($table, $fields = '*', $arg = '', $noWhere = false, $debug = false, $log_type = '', $log_remark = '')

Example #1: Simple select

$sql->select('tablename', 'field1, field2', 'field_id = 1');

Example #2: Using arguments

$sql->select("comments", "*", "comment_item_id = '$id' AND comment_type = '1' ORDER BY comment_datestamp");

Example #3: Using arguments with noWhere option

$sql->select("chatbox", "*", "ORDER BY cb_datestamp DESC LIMIT $from, ".$view, true);

Example #4: BIND support

$sql->select('user', 'user_id, user_name', 'user_id=:id OR user_name=:name ORDER BY user_name', array('id' => 999, 'name'=>'e107'))

fetch()

Selecting, looping through and displaying selected data with the fetch() method:

$sql->select('tablename', 'field1, field2', 'field_id = 1');

while($row = $sql->fetch())
{
    echo $row['field1'];
}

insert()

Inserting data into a database table:

$insert = array(
   'data'  => array('field1' => 'value1', 'field2' => 'value2'),
   'WHERE' => 'field_id = 1'
);

$sql->insert('tablename', $insert);

update()

Updating information in a database:

$update = array(
   'data'  => array('field1' => 'value1', 'field2' => 'value2'),
   'WHERE' => 'id = 1'
);

$sql->update('tablename', $update);

retrieve()

$sql->retrieve($table = null, $fields = null, $where = null, $multi = false, $indexField = null, $debug = false)

Example #1: Get a single value

$string = $sql->retrieve('user', 'user_email', 'user_id = 1');

Example #2: Get multiple table-row values

if($allRows = $sql->retrieve('user', 'user_name, user_email', '', true))
{
	foreach($allRows as $row)
	{
		echo $row["user_name"]." - ".$row["user_email"]."<br/>";  
	}
}

Example #3: Fetch all, don't append WHERE to the query, index by user_id, noWhere auto detected (string starts with upper case ORDER)

$array = $sql->retrieve('user', 'user_id, user_email, user_name', 'ORDER BY user_email LIMIT 0,20', true, 'user_id');

Example #4: Same as above but retrieve() is only used to fetch, not useable for single return value

if($sql->select('user', 'user_id, user_email, user_name', 'ORDER BY user_email LIMIT 0,20', true))
{
     $array = $sql->retrieve(null, null, null,  true, 'user_id');
}

Example #5: Using whole query example, in this case default mode is 'one'

$array = $sql->retrieve('
    SELECT p., u.user_email, u.user_name 
    FROM `#user` AS u
    LEFT JOIN `#myplug_table` AS p 
    ON p.myplug_table = u.user_id
    ORDER BY u.user_email LIMIT 0,20
');

Example #6: Using whole query example, multi mode - $fields argument mapped to $multi

$array = $sql->retrieve('SELECT u.user_email, u.user_name FROM #user AS U ORDER BY user_email LIMIT 0,20', true);

delete()

Delete a record from a database table.

$sql->delete("user", "user_id = 2");

gen()

Generic query function to use various SQL commands.

Example: perform a JOIN with gen():

$sql->gen("SELECT f.*,u.user_name FROM #faqs AS f LEFT JOIN #users as u ON f.faq_author = u.user_id ");

Advanced database methods

connect()

$sql->connect($mySQLserver, $mySQLuser, $mySQLpassword, $newLink = false)

count()

database()

$sql->database($database, $prefix = MPREFIX, $multiple=false)

getLastErrorNumber()

getLastErrorText()

Introduction

$plg = e107::getPlug();

Plugin methods

load()

Load specified plugin data, can be used in conjunction with other methods.

$plg->load($plugdir)

Introduction

$log = e107::getLog();

Logging methods

add()

$log = e107::getLog();
$log->add(name, details, type, code);

//Example: 
$log->add('My Event Name', $myDetailedData, E_LOG_INFORMATIVE, 'MYCODE');

Logging types

Introduction

You can generate a Search Engine Friendly (SEF) URLs using the following method:

Examples

Example 1: Forum topic URLs

In this example we will generate search-engine-friendly URLs for a forum topic with the following code: .

The code above loads the following file: e107_plugins/forum/e_url.php and generates a URL from the following array data with the unique key topic:

Only the value of 'sef' is used in this array. it substitutes the values {forum_sef}, {thread_id} and {thread_sef} with the variables in the $data array.

Example 2: Using optional parameters

Introduction

Use the following to retrieve the form class object

Forms methods

open()

Returns a form opening tag.

close()

Returns a form closing tag

text()

Returns a text field form element

textarea()

bbarea()

select()

checkbox()

hidden()

button()

carousel()

Render a Bootstrap carousel

tabs()

Render Bootstrap tabs

datepicker()

Date field with popup calendar. Returns UNIX timestamp or string value on submit.

Examples:

• You can redirect to a URL using the following static method:

$url = "https://www.yourwebsite.com".
e107::redirect($url);

• To redirect to the homepage, simply leave the URL blank.

e107::redirect();

• To redirect to the Admin Area, use the value 'admin'.

e107::redirect('admin');

myplugin_shortcodes.php

Returns an array of user data for a specific user. Input can be either a specific ID ($user_id) or use USERID for the currently logged in user.

e107::user($user_id);

$userData = e107::user(USERID); // Example - currently logged in user. 
$userData = e107::user(5); // Example  User ID #5.

Introduction

Use the following to retrieve the render class object.

$pref = e107::getPref();

Retrieving preferences

Developers may retrieve admin preferences for their theme or plugin, or a core preference using the following method:

e107::pref(type, value);

Example: Load a stored value that was saved in the preferences admin area of the 'faqs' plugin

$faqPrefs = e107::pref('faqs'); // returns an array.

Or load a single preference value.

$FaqPerPage = e107::pref('faqs', 'faqs_per_page');

Introduction

How to use the Plugin Builder

1. Create an empty plugin folder in e107_plugins (eg. "myplugin")

2. Create a new text file with the *_sql.php extension. (eg. "myplugin_sql.php")

3. Using a tool such as phpMyAdmin, create your database table structure, and then export it in SQL format.

4. Copy and paste the database structure ("CREATE TABLE") to your your *_sql.php file. (see other plugins for examples)

6. Thoroughly check the details of each Table Tab (and Preferences Tab if you need them) before proceeding with the creation process.

Basic info

Database tables

field

caption

type

data

width

batch

filter

inline

validate

display

R/O

Helptip

ReadParms

WriteParms

Preferences

Addons

Plugins extended the functionality of e107 and allow for endless possibilities.

CORE/THIRD PARTY - LINK TO USER GUIDE

ARCHITECTURE

The plugin architecture is developed to be as simple as possible. Often you can copy a file from an existing plugin and simply modify a few parameters in order to get similar functionality in your own plugin

Folder structure

Example: blank plugin

• images

  • sizes?

• languages

  • English

    • ...

• templates

• addon files

Required files

• plugin.xml

Optional files

• admin_config.php

• *_setup.php

• *_sql.php

• e_*.php addons

• *_shortcodes.php

Introduction

The Admin-UI (Admin User Interface) is .....

Advantages of the Admin-UI

• No need to code in the HTML or the process of reading or writing to your database.

• Consistent interface with the rest of Admin Area

• Users can select which fields from your database table they wish to view - based on your predefined list.

• The Media-Manager is integrated into the system.

• Easily add drag and drop sorting/re-ordering to your plugin.

• Easily add batch functionality such as deleting, copying, featurebox creation, sitelink creation, userclass modification, etc.

• Easily add inline editing to your data.

• Easily add tabs to keep your plugin's admin-area well organized.

File structure

Below you can find the basic file structure of of the admin_config.php file. This file serves the Admin-UI to the administrators.

Classes, methods, variables

class plugin_blank_admin

extends e_admin_dispatcher

$modes

...

class plugin_blank_admin_ui

extends e_admin_ui

$fields

Database fields are defined by the $fields value in the Admin-UI class.

Example:

type

data

readParms (list mode)

writeParms (create/edit mode)

Creating a tree structure

The Admin-UI allows to automatically create a tree structure based on parent/child relationship tables. In order to add a tree structure, add the following code:

In this case:

• field1 represents the field which determines the order (for example an ID field).

• field2 represents the field which is the parent

• field3 represents the field which is the child

Examples

Introduction

There are several ways to extend the core functionality of e107. One of those ways is by using so-called "addons". These addons are files which reside in each plugin's folder and allow a plugin to embed itself inside e107's core pages and functions.

The addons can be recognised by their e_xxxxx.php naming format. By simply placing them inside your plugin's folder, they will be auto-detected during installation and integrated into the system.

Overview of all plugin addons

Plugin addons

e_admin.php

e_bb.php

e_comment.php

e_cron.php

Example:

e_dashboard.php

This addon adds custom plugin information to the dashboard of e107's admin area. The 'latest', 'status' and 'website stats' areas may all contain information from your plugin.

Example:

e_emailprint.php

e_event.php

This addon allows a plugin to easily hook into system events and trigger their own methods and functions using data provided by those events.

Example:

e_featurebox.php

e_footer.php

This addon allows a plugin to include code in the footer of every page of the site.

e_frontpage.php

Example:

e_gsitemap.php

e_header.php

Example:

e_help.php

e_latest.php

e_library.php

e_linkgen.php

e_list.php

e_mailout.php

This addon allows a plugin to use e107's mailout feature for bulk mailing.

e_menu.php

This addon provides configuration options for each instance of the plugin's menus.

Example:

e_meta.php

e_module.php

This addon is loaded every time the core of e107 is included. ie. Wherever you see require_once("class2.php") in a script.

It allows a developer to modify or define constants, parameters etc. which should be loaded prior to the header or anything that is sent to the browser as output. It may also be included in Ajax calls.

e_notify.php

Example:

The notification can then be triggered by using:

e_output.php

e_parse.php

Example:

e_print.php

This addon allows a plugin developer to specify content that is displayed in printer-friendly format

Example:

e_rss.php

This addon adds the plugin to the RSS plugin, and generates RSS feeds for the plugin.

Example:

e_related.php

This addon adds the plugin to the search which generates 'related' links in news items and pages of e107.

Example:

e_search.php

This addon adds the plugin to the 'search page' of e107.

Example:

e_shortcode.php

This addon allows a plugin to make their shortcodes available to core templates and templates of other plugins.

It's content is identical to that of a regular shortcode class except that all the methods must follow the following naming convention: sc_plugindir_name()

The $override property can be used to override existing core/plugin shortcodes. When set to true existing core/plugin shortcodes matching methods below will be overridden.

Example:

e_sitelink.php

This addon adds a sitelink sublink-generating function for your plugin. An example is auto-generated navigation drop-down menus for 'latest articles'.

Example:

e_status.php

e_tohtml.php

e_upload.php

e_url.php

Example:

e_user.php

This addon allows to:

• add information about a specific user to the user's profile page

• add and save fields to the user configuration page (/usersettings.php)

• specify a routine that is run upon user deletion

Example:

Introduction

......

Common theme shortcodes

theme_shortcodes.php

These shortcodes may be used in your theme.html and layout/xxx _layout.html files which reside inside your theme's folder. eg. Using the example below: {MY_SHORTCODE} and {MY_OTHER_SHORTCODE} will be substituted with "Something" and "Something else".

Introduction

Your website can be used in different languages. In order for your plugin or theme areas to be displayed in a specific language, it needs to be translated.

Language files

File Types

There are three types of language files that can be used in your plugin.

Defining Language Terms

Language Terms are more commonly known as LAN's. You can define LAN's by using PHP constants:

Best practices

Avoid duplicating terms, particularly in the admin area.

Never use HTML or URLs inside LAN definitions.

Avoid short language strings for common words

Examples are words such as 'and', 'to' and so on. There aren't always equivalents in other languages.

Examples

Good

Bad

Substitution

Loading Language Files

e107::lan()

To load a language file from a plugin folder, use e107::lan():

This will include the following paths: