# Welcome
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
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.
# Hello world example
To create a simple test script, create a new file called `helloworld.php` in your root folder with the following PHP code:
```php
tablerender("My Caption", "Hello World"); // Render Caption and Text according to Theme style.
require_once(FOOTERF); // Load and output the theme's HTML for the $FOOTER.
exit;
```
Then point your browser to `www.yoursite.com/helloworld.php`and you're ready!
# Folder structure
The table below provides an overview of the default folder structure of an e107 installation:
| Folder | Can be modified | Description |
| --------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| e107\_admin | No | Contains main files used for the admin area. |
| e107\_core | No |
Contains core assets. You should not make changes within this folder.
|
| e107\_handlers | No |
Contains core functions and classes. You should not make changes within this folder.
|
| e107\_images | Not usually |
Contains core images. You should notnormally need to make changes within this folder.
|
| e107\_languages | Not the English folder. |
Contains core language files.
Themes and plugins have their own language folder
|
| e107\_media | Not usually | Contains Media such as downloadable images or files which are specific to your installation. |
| e107\_plugins | Yes |
Contains all plugins, installed and uninstalled. You may manually add plugins to this folder if need be.
|
| e107\_system | Not usually | Contains **private** files such as logs, plugin and theme downloads which are specific to your installation. |
| e107\_theme | Yes |
Contains all themes, installed and uninstalled. You may manually add themes to this folder if need be.
|
| e107\_web | No | Contains core *js* and *css* packages. |
# Database structure
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
### Best practices
* **Do not modify the core database structure**
:thumbsup: Use your own tables (for example by [creating a plugin](/plugin-development/introduction)) if you want to work with additional data in the database.
* **Do not (ab)use database tables and fields for other purposes**
:thumbsup: Stick to purposes [defined in the database tables](/getting-started/database-structure#database-tables-overview) overview, or create your own database tables
### 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:
1. **Recommended:** It is strongly recommend to make use of the [database methods](/classes-and-methods/database#database-methods). Using these methods, the database table prefix is processed automatically.
2. By using the `#` sign, one can automatically refer to the database prefix. This is generally used when using the[ e107::getDB()->gen()](/classes-and-methods/database#gen) method, to manually construct an SQL query.
3. In rare cases, you may reference the `MPREFIX` constant. Its use is deprecated and **not** encouraged.
## Database tables overview
{% hint style="info" %}
TODO: Finish table below.
{% endhint %}
The following table provides an overview of all database tables in a clean e107 installation, with their respective purposes.
| Table name | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| admin\_log | |
| audit\_log | |
| banlist | |
| comments | |
| core | |
| core\_media | |
| core\_media\_cat | |
| cron | |
| dblog | |
| generic |
Table for generic purposes. Generally used to store temporary date. Currently also used by welcome message. Developers are discouraged to use this table!
|
| links | |
| mail\_recipients | |
| mail\_content | |
| menus | |
| news | |
| news\_category | |
| online | |
| page | |
| page\_chapters | |
| plugin | |
| rate | |
| submitnews | |
| tmp | |
| upload | |
| user | |
| userclass\_classes | |
| user\_extended | |
| | |
# Debugging & problem solving
## 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.
{% hint style="warning" %}
By default, all PHP errors, warnings and notices are suppressed and not visible to the public. You can use debugging to show them.
{% endhint %}
{% hint style="info" %}
A blank page or a page that has not been fully loaded, usually indicates a PHP fatal error. Server logs (such as Apache Error Logs) often also provide useful information.
{% endhint %}
## Browser addon
We recommend this collection of :point\_right: [Firefox Addons](https://addons.mozilla.org/en-US/firefox/collections/camer0n/e107developer/). The most important being the `e107 Debugger`. If you don't wish to use the debugger, you can still activate various [debugging modes](/getting-started/debugging-and-problem-solving#debug-modes) manually, by changing the query string of the URL and adding the debug mode. For example: directly after `.php` add `?[debug=xxxx]`
*Example:* `yourwebsite.com/news.php?[debug=basic!]`
## Debug modes
| Query | Description |
| -------------------- | ------------------------------------------- |
| \[debug=basic!] | Display basic error information |
| \[debug=traffic!] | Display traffic information |
| \[debug=showsql!] | Display basic SQL queries |
| \[debug=time!] | Display load/processing times |
| \[debug=notice!] | Display PHP Notices |
| \[debug=warn!] | Display PHP Warnings |
| \[debug=backtrace!] | Display PHP Backtraces |
| \[debug=deprecated!] | Display deprecated method or function calls |
| \[debug=inc!] | Display included files |
| \[debug=paths!] | Display paths and variables |
| \[debug=bbsc!] | Display BBCodes and Shortcodes |
| \[debug=sc!] | Display Shortcode placement |
| \[debug=sql!] | Display detailed SQL analysis |
| \[debug=everything!] | Display all debugging details |
| \[debug=off!] | Disable debugging |
{% hint style="info" %}
As of e107 v2.3.1 - the `+` sign has been changed to an exclamation mark `!`. \
For example: `[debug=basic!]` instead of `[debug=basic+]`
{% endhint %}
# Introduction
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Overview
The table below provides a quick overview of all classes that are used in e107 and are commonly used by developers.
| Class | Description |
| ----------------------------------------------- | -------------------------------------------------- |
| [Database](/classes-and-methods/database) | All methods related to interaction with a database |
| [Forms](/classes-and-methods/forms) | |
| [Parser](/classes-and-methods/parser) | . |
| [Render](/classes-and-methods/render) | |
| [Preferences](/classes-and-methods/preferences) | |
| [Javascript](/classes-and-methods/javascript) | |
| [CSS](/classes-and-methods/css) | |
| [User Data](/classes-and-methods/user-data) | |
| [Meta](/classes-and-methods/meta) | |
| [Events](/classes-and-methods/events) | |
| [Alerts](/classes-and-methods/alerts) | |
| [Logging](/classes-and-methods/logging) | |
| [Redirection](/classes-and-methods/redirection) | |
| [URLs](/classes-and-methods/urls) | |
| [Cache](/classes-and-methods/cache) | |
##
# Alerts
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
Use the following to retrieve the alerts class object.
```php
$mes = e107::getMessage();
```
## Alerts methods
### addSuccess()
```php
$mes = e107::getMessage();
$mes->addSuccess('You did it!');
```
### addError()
```php
$mes = e107::getMessage();
$mes->addError('There was a problem!');
```
### addWarning()
```php
$mes = e107::getMessage();
$mes->addWarning('You do not have access to this area!');
```
### addInfo()
```php
$mes = e107::getMessage();
$mes->addInfo('Please take note!');
```
### addDebug()
{% hint style="info" %}
*Messages assigned here will only be displayed when* [*debug mode*](/getting-started/debugging-and-problem-solving) *is active.*
{% endhint %}
```php
$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.
```php
$mes = e107::getMessage();
$mes->addInfo('Please take note!');
echo $mes->render();
```
# Cache
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
```php
$cache = e107::getCache();
```
## Cache methods
### retrieve()
### retrieve\_sys()
### set()
### clear()
### clear\_sys()
## Cache types
{% hint style="info" %}
Work in progress
{% endhint %}
| Type | content? |
| --------------------------------------------------------------------------------- | ------------------------------ |
| online\_menu\_totals | |
| wmessage | |
| news | |
| 'newsarchive' | \_caption,\_title,\_diz,\_rows |
| "nq\_othernews" | |
| news\_php\_extend\_'.$id.'\_' | |
| 'nq\_news\_latest\_menu\_'.md5(serialize($parm).USERCLASS\_LIST.e\_LANGUAGE); | |
| 'nq\_news\_categories\_menu\_'.md5(serialize($parm).USERCLASS\_LIST.e\_LANGUAGE); | |
| 'nq\_news\_months\_menu\_'.md5(serialize($parm).USERCLASS\_LIST.e\_LANGUAGE); | |
| 'news.php\_default\_' | |
| 'news.php\_'.e\_QUERY | |
| comment.php?{$table}.{$id} | |
| nq\_chatbox | |
| nomd5\_linkwords | |
| nomd5\_user\_ranks | |
| 'menus\_'.USERCLASS\_LIST.'\_'.md5(e\_LANGUAGE.$menu\_layout\_field) | |
# CSS
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
...
## Basic CSS methods
Including css in your plugin or theme may be achieved by using the following function:
```php
e107::css($type, $value);
```
| Type | Value | Description |
| ------ | ----------------------------------- | ------------------------------------------------------------ |
| theme | path relative to the theme's folder | Include a theme css file in the header of the site |
| url | full url to css file | Include a remote css file in the header of the site |
| inline | css code | Include raw css code in the header of every page of the site |
## Examples
{% hint style="info" %}
TODO: add examples
{% endhint %}
# Database
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
Use the following to retrieve the database class object
```php
$sql = e107::getDb();
```
## Basic database methods
### select()
Selecting data from a database table
```php
$sql->select($table, $fields = '*', $arg = '', $noWhere = false, $debug = false, $log_type = '', $log_remark = '')
```
| Parameter | Type | Description | Mandatory? |
| ----------- | ------------- | ------------------------------------------------------------------------- | ---------- |
| **table** | string | Name of the database table | **Yes** |
| fields | string | Comma separated list of fields or "`*`" or a single field name (get one); | |
| arg | string\|array | .... | |
| noWhere | boolean | | |
| debug | boolean | | |
| log type | | | |
| log\_remark | | | |
#### Example #1: Simple select
```php
$sql->select('tablename', 'field1, field2', 'field_id = 1');
```
#### Example #2: Using arguments
```php
$sql->select("comments", "*", "comment_item_id = '$id' AND comment_type = '1' ORDER BY comment_datestamp");
```
#### Example #3: Using arguments with noWhere option
```php
$sql->select("chatbox", "*", "ORDER BY cb_datestamp DESC LIMIT $from, ".$view, true);
```
#### Example #4: BIND support
```php
$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:
```php
$sql->select('tablename', 'field1, field2', 'field_id = 1');
while($row = $sql->fetch())
{
echo $row['field1'];
}
```
### insert()
Inserting data into a database table:
```php
$insert = array(
'data' => array('field1' => 'value1', 'field2' => 'value2'),
'WHERE' => 'field_id = 1'
);
$sql->insert('tablename', $insert);
```
### update()
Updating information in a database:
```php
$update = array(
'data' => array('field1' => 'value1', 'field2' => 'value2'),
'WHERE' => 'id = 1'
);
$sql->update('tablename', $update);
```
### retrieve()
Combined [select()](/classes-and-methods/database#select) and [fetch()](/classes-and-methods/database#fetch) method.
```php
$sql->retrieve($table = null, $fields = null, $where = null, $multi = false, $indexField = null, $debug = false)
```
| Parameter | Type | Description |
| ---------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| table | string |
Name of the database table to retrieve data from.
If empty, enters fetch only mode
|
| fields | string |
Comma separated list of fields or "\*" or a single field name (get one);
If $fields is of type boolean and $where is not found, $fields overrides $multi
|
| where | string | WHERE/ORDER/LIMIT etc. clause. |
| multi | string |
If set to true, fetch all (multi mode)
Default: false
|
| indexField | boolean |
Field name to be used for indexing when in multi mode
Default: null
|
| debug | boolean |
....
Default: false
|
#### Example #1: Get a single value
```php
$string = $sql->retrieve('user', 'user_email', 'user_id = 1');
```
#### Example #2: Get multiple table-row values
```php
if($allRows = $sql->retrieve('user', 'user_name, user_email', '', true))
{
foreach($allRows as $row)
{
echo $row["user_name"]." - ".$row["user_email"]." ";
}
}
```
#### Example #3: Fetch all, don't append WHERE to the query, index by user\_id, noWhere auto detected (string starts with upper case ORDER)
```php
$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
```php
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'
```php
$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
```php
$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.
```php
$sql->delete("user", "user_id = 2");
```
### gen()
Generic query function to use various SQL commands.
#### *Example: perform a JOIN with gen():*
```php
$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()
```php
$sql->connect($mySQLserver, $mySQLuser, $mySQLpassword, $newLink = false)
```
| Parameter | Type | Description |
| ------------- | ------- | ----------------------------------------------------------------------------- |
| mySQLserver | string | IP or hostname of the SQL server |
| mySQLuser | string | SQL username |
| mySQLpassword | string | SQL password |
| newLink | boolean |
force a new link connection if set to true Default: false
|
### count()
### database()
```php
$sql->database($database, $prefix = MPREFIX, $multiple=false)
```
| Parameter | Type | Description |
| --------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| database | string | Database name |
| prefix | string | Prefix of the database tables (e.g. "e107\_"). Defaults to [MPREFIX](/getting-started/database-structure#database-prefix). |
| multiple | boolean | Set to true to maintain connection to a secondary database |
| newLink | boolean |
force a new link connection if set to true Default: false
|
### getLastErrorNumber()
### getLastErrorText()
# Date
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
```php
$gen = e107::getDate();
```
## Date methods
### computeLapse()
Calculate difference between two dates for display in terms of years/months/weeks....
```php
$gen->computeLapse($older_date, $newer_date = FALSE, $mode = FALSE, $show_secs = TRUE, $format = 'long')
```
| Parameter | Type | Description | Mandatory? |
| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | ---------- |
| **older\_date** | integer | UNIX timestamp | **Yes** |
| newer\_date | integer |
UNIX timestamp
Default: current time
| No |
| mode | boolean |
if true return value is an array. Otherwise return value is a string
Default: false
| No |
| show\_secs | boolean | *Default: true* | No |
| format | string |
Format of the human readable date. Options:
long
short (omits the year)
Default: long
| No |
### convert\_date()
Convert datestamp to human readable date. System time offset is considered.
```php
$gen->convert_date($datestamp, $mask = '')
```
| Parameter | Type | Description | Mandatory? |
| --------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| datestamp | integer | UNIX timestamp | **Yes** |
| mask | string |
| No |
{% hint style="info" %}
The configuration of the *mask* formats are specified in :point\_right: Admin Area > Preferences > [Date Display options](https://userguide.e107.org/administration/settings/preferences#date-display-options).
{% endhint %}
### terms()
Return an array of language terms representing months
```php
$gen->terms($type='month')
```
| Parameter | Type | Description | Mandatory? |
| --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| type | string |
Options:
month (August)
month-short (Aug)
day (Tuesday)
day-short (Tue)
day-shortest (Tu)
Default: month
| **Yes** |
# Events
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
Plugin developers can hook into various e107 core events and [trigger functions of their own](/classes-and-methods/events#trigger). Typically, an [e\_event.php](/plugin-development/extending-core-functionality-addons#e_event-php) file is used to store this information since it is loaded with every page.
{% hint style="info" %}
From e107 version 2.1.2 onwards you can use [e\_event.php](/plugin-development/extending-core-functionality-addons#e_event-php) addon to catch the events instead of using [e\_module.php](/plugin-development/extending-core-functionality-addons#e_module-php)
{% endhint %}
## Events methods
### register()
| Parameter | Description | Mandatory? |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **name** | The event you wish to hook into. ([see tables below](/classes-and-methods/events#event-triggers)) | **Yes** |
| **function** | Your function or class/method to trigger when this event occurs. string for function, or for classes use an array (class, method). | **Yes** |
| include | include (optional) path: a file to include if required. | No |
```php
e107::getEvent()->register(name, function, include);
```
#### **Example 1**: trigger `myFunction()` on user login.
```php
e107::getEvent()->register('login', 'myFunction');
function myFunction($data)
{
// do something
}
```
#### **Example 2**: trigger `myFunction()` on user login. Function in external file.
```php
e107::getEvent()->register('login', 'myFunction', e_PLUGIN."myplugin/myFunctions.php");
```
#### **Example 3**: trigger a class and method on user login.
```php
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.
```php
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
```
| Parameter | Description | Mandatory? |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **eventname** |
The name of the event you wish to trigger (new event name).
Format: plugindir\_eventname (see example above).
| **Yes** |
| data | The data that you wish to send alongside the event | No |
## Core Event triggers
### User Event Triggers
#### Basic user functions
| Trigger Name | Description | Data |
| ----------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
| login | User login/signin | Array of user data |
| logout | User logout/signout | Notice event |
| user\_file\_upload | User uploads a file | Array of file information |
| user\_signup\_submitted | User submits signup form | Array of user data |
| user\_signup\_activated | User activates newly created account. (email link) | Array of user data |
| user\_xup\_login | User signs in via a social media account. eg. Facebook, Twitter etc. | Array of user data |
| user\_xup\_signup | User creates an account using their social media login. Facebook, Twitter etc. | Array of user data |
| user\_profile\_display | User has viewed a profile | Array of data |
| user\_profile\_edit | User has edited their profile | Array of data of user who changed the settings |
| user\_comment\_posted | User has posted a new comment | Array of data |
| preuserset | Before usersettings are updated | Array of new user settings ($\_POST) |
| postuserset | After usersettings are updated | Array of new user settings ($\_POST) |
| userdatachanged | After usersettings are updated (same time and data as user\_profile\_edit) | Array of data of user who changed the settings |
#### **Custom page**
| Trigger function | Description | Data |
| ------------------------ | ----------------------------- | ------------- |
| user\_page\_item\_viewed | User has viewed a custom page | Array of data |
#### **News**
| Trigger Name | Description | Data |
| ------------------------ | -------------------------- | ------------- |
| user\_news\_item\_viewed | User viewed a news item | Array of data |
| user\_news\_submit | User submitted a news item | Array of data |
#### **Private Messenger**
| Trigger name | Description | Data |
| -------------- | ------------------------------- | ------------- |
| user\_pm\_sent | User has sent a private message | Array of data |
| user\_pm\_read | User has read a private message | Array of data |
#### **Forum**
| Trigger Name | Description | Data |
| ----------------------------------------- | ----------------------------------------------- | ------------- |
| user\_forum\_topic\_created | User creates a forum topic | Array of data |
| user\_forum\_topic\_created\_probationary | New user creates a forum topic | Array of data |
| user\_forum\_topic\_updated | User updates a forum topic | Array of data |
| user\_forum\_topic\_deleted | User deletes a forum topic | Array of data |
| user\_forum\_topic\_moved | User has moved forum topic to a different forum | Array of data |
| user\_forum\_topic\_split | User has split the forum topic | Array of data |
| user\_forum\_post\_created | User creates a forum post/reply | Array of data |
| user\_forum\_post\_updated | User updates a forum post/reply | Array of data |
| user\_forum\_post\_deleted | User deletes a forum post/reply | Array of data |
| user\_forum\_post\_report | User has reported a forum post/reply | Array of data |
#### **Chatbox**
| Trigger function | Description | Data |
| ---------------------------- | --------------------------------- | ------------------------------ |
| user\_chatbox\_post\_created | User has posted a chatbox message | Array of data (ip and message) |
### Admin Event Triggers
#### **Admin changes their password**
| Trigger Name | Description | Data |
| ----------------------- | ---------------------------- | --------------------------------------------- |
| admin\_password\_update | Admin updates their password | Array containing user\_id and time of change. |
#### **Comments Manager**
| Trigger Name | Description | Data |
| ---------------------- | ----------------------- | --------------------- |
| admin\_comment\_update | Admin updates a comment | Array of comment data |
| admin\_comment\_delete | Admin deletes a comment | Array of comment data |
#### **Downloads**
| Trigger Name | Description | Data |
| ----------------------- | ----------------------------- | ---------------------- |
| admin\_download\_create | Admin creates a download item | Array of download data |
| admin\_download\_update | Admin updates a download item | Array of download data |
| admin\_download\_delete | Admin deletes a download item | Array of download data |
#### **News**
| Trigger Name | Description | Data |
| ----------------------------- | ----------------------------- | ------------------ |
| admin\_news\_create | Admin creates a news item | Array of news data |
| admin\_news\_update | Admin updates a news item | Array of news data |
| admin\_news\_delete | Admin deletes a news item | Array of news data |
| admin\_news\_category\_create | Admin creates a news category | Array of news data |
| admin\_news\_category\_update | Admin updates a news category | Array of news data |
| admin\_news\_category\_delete | Admin deletes a news category | Array of news data |
#### **Pages**
| Trigger Name | Description | Data |
| ------------------- | ------------------------------ | -------------------------------- |
| admin\_page\_create | Admin creates a page/menu item | Array of page data |
| admin\_page\_update | Admin updates a page/menu item | Array of page data (new and old) |
| admin\_page\_delete | Admin deletes a page/menu item | Array of page data |
#### **Users**
| Trigger Name | Description | Data |
| --------------------- | ---------------------------------- | -------------------------------- |
| admin\_user\_create | Admin creates a new user | Array of user data |
| admin\_user\_update | Admin modifies user data | Array of user data (new and old) |
| admin\_user\_delete | Admin deletes a user | Array of user data |
| admin\_user\_activate | Admin activates an unverified user | Array of user data |
| admin\_user\_loginas | Admin logs in as another user | Array of user data |
| admin\_user\_logoutas | Admin logs out as another user | Array of user data |
# Forms
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
Use the following to retrieve the form class object
```php
$frm = e107::getForm();
```
## Forms methods
### open()
Returns a form opening tag.
```php
$frm->open('myform');
```
```php
$frm->open('myform', 'get', 'myscript.php', array('autocomplete' => 'on', 'class' => 'formclass'));
```
| Parameter | Type | Description | Mandatory | |
| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -- |
| **name** | string | Name of the form | **Yes** | |
| mode | string |
post | get 'post' by default
| No |
| target | string |
The request URL e\_REQUEST\_URI by default
| No | |
| options | array |
Specify options such as class or autocomplete
autocomplete - on/off (boolean)
class - (any string)
...
| No | |
### close()
Returns a form closing tag
```php
$frm->close();
```
### text()
Returns a text field form element
```php
$frm->text('my-field', 'current_value', 100, array('size' => 'large')); // returns
```
| Parameter | Type | Description | Mandatory |
| --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| name | string | Name of the text field | |
| value | string | Value of the text field | |
| maxlength | integer | Specifies the maxlength element of the text field | |
| options | array |
Specify options such as class, size or selectize
class: (any string)
size: mini, small, medium, large, xlarge, xxlarge
selectize: array with selectize.js options
| |
### textarea()
```php
$frm->textarea($name, $value, $rows, $cols, $options, $counter);
```
### bbarea()
```php
$frm->bbarea($name, $value, $template, $mediaCat, $size, $options);
```
| Parameter | Type | Description | Mandatory |
| --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| **name** | string | Name of the field | **Yes** |
| **value** | string | Contents of the field | **Yes** |
| template | string |
A string defining the button template to use with bbarea. Included in the core are the following: news, submitnews, extended, admin, mailout, page, comment, signature
But you can also use the name of the plugin (e.g. forum) if the plugin provides a bbcode\_template.php
| No |
| mediaCat | string |
Name of the media catalog to use (default: \_common)
Is only used by TinyMCE plugin (if installed and used)
| No |
| size | string |
Size of the bbarea/editor. Use one of the following values: tiny, small, medium, large (default: large)
| No |
| options | array |
Array with options to use with the editor: id: string - In case the bbarea/editor id should be different to the name class: string - the css classes to use counter: boolean - Show a character counter wysiwyg: boolean/string -
False in case you want disable the wysiwyg editor for this field and use the default bbcode editor.
True to enable the current installed (and enabled) wysiwyg editor
Name of the editor (e.g. tinymce4 or simplemde) to use, in case wysiwyg is generally enabled and the supplied editor is installed.
| No |
{% hint style="info" %}
**TODO:** Clarify possible options and add more examples
{% endhint %}
#### *Examples:*
```php
$frm->datepicker('my_field',time(),'mode=date');
$frm->datepicker('my_field',time(),'mode=datetime&inline=1');
$frm->datepicker('my_field',time(),'mode=date&format=yyyy-mm-dd');
$frm->datepicker('my_field',time(),'mode=datetime&format=MM, dd, yyyy hh:ii');
$frm->datepicker('my_field',time(),'mode=datetime&return=string');
```
# Javascript
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
....
## Basic Javascript methods
Including Javascript in your plugin or theme may be achieved by using the following function:
```php
e107::js($type, $data, $parm = null, $zone = null, $pre = '', $post = '')
```
| Parameter | Value | Description | Mandatory? |
| --------- | --------------------------------- | ---------------------------------------------------- | ---------- |
| type | See [type & data](#type-and-data) | | **Yes** |
| data | See [type & data](#type-and-data) | | **Yes** |
| parm | jquery \| array | Specifies dependencies or other parameters | No |
| zone | | Specifies the zone in which the javascript is loaded | No |
| pre | | | No |
| post | | | No |
### type & data
| Type | Data | Description |
| ---------------------------------------------------- | ------------------------------------------------------- | -------------------------------------------------------------- |
| core | path relative to the core folder | Include a core js file |
| url | full URL to javascript file | Include a remote js file |
| inline | javascript code | Include raw javascript code |
| theme | path to js file, relative to the current theme's folder | Include a theme js file |
| (any plugin folder name) | path to js file, relative to the plugin's folder | Include a plugin js file |
| [settings](/classes-and-methods/javascript#settings) | array | Adds settings to e107's global storage of JavaScript settings. |
### Examples
#### *Example #1*
Load a script in the 'faqs' plugin directory and auto-load jQuery if not already loaded.
```php
e107::js('faqs','js/faqs.js', 'jquery')
```
#### *Example #2*
Load a theme script in the footer
```php
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
```php
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.
{% hint style="info" %}
Remember that loading from URL may take more time than local resources. Use dependency if needed!
{% endhint %}
## 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:
```javascript
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.
```javascript
(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.
```javascript
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
```javascript
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".
# Language
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
Use the following to retrieve the language class object
```php
$lng = e107::getLanguage()
```
## Language methods
### bcDefs()
# Logging
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## **Introduction**
You can log events to the admin [System Logs](https://userguide.e107.org/administration/tools/system-logs) by using the built in log class.\
\
Use the following to retrieve the alerts class object.
```php
$log = e107::getLog();
```
## Logging methods
### add()
| Parameter | Description |
| --------- | ------------------------------------------------------------------------------------------------------ |
| name | Title or name for the log event. |
| details | Details for the log event - can be either a string of text or an array. |
| type | The type of event. ([see table below](/classes-and-methods/logging#logging-types)) |
| code | Custom reference code for your type of event. It should be short, ALL CAPITALS and not contain spaces. |
```php
$log = e107::getLog();
$log->add(name, details, type, code);
//Example:
$log->add('My Event Name', $myDetailedData, E_LOG_INFORMATIVE, 'MYCODE');
```
## Logging types
| Type | Description |
| ------------------- | ------------------- |
| E\_LOG\_INFORMATIVE | Informational event |
| E\_LOG\_NOTICE | Notice event |
| E\_LOG\_WARNING | Warning event |
| E\_LOG\_FATAL | Fatal event |
# Meta
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
Include meta tags in the html header.
```php
e107::meta($name, $content, $extended);
```
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| name | ... | .. |
| content | ... | ... |
| extended | ... | ... |
## Examples
```php
e107::meta('keywords','some words');
e107::meta('apple-mobile-web-app-capable','yes');
```
{% hint style="info" %}
TODO: add more examples
{% endhint %}
# Parser
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
Use the following to retrieve the parser class object.
```php
$tp = e107::getParser();
```
## Parser methods
### toHTML()
Parse HTML in various ways. eg. replace constants, convert bbcode etc.
```php
$tp->toHTML($text, $parseBB = false, $modifiers = '', $postID = '', $wrap = false)
```
| **Yes** |
###
# Preferences
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
### Introduction
Use the following to retrieve the render class object.
```php
$pref = e107::getPref();
```
### Retrieving preferences
Developers may retrieve admin preferences for their theme or plugin, or a core preference using the following method:
```php
e107::pref(type, value);
```
*Example: Load a stored value that was saved in the preferences admin area of the 'faqs' plugin*
```php
$faqPrefs = e107::pref('faqs'); // returns an array.
```
Or load a single preference value.
```php
$FaqPerPage = e107::pref('faqs', 'faqs_per_page');
```
| Type | Value (optional) |
| ------------------------ | ------------------------------------------------------ |
| core | all core preference values. |
| theme | preferences of the currently selected front-end theme. |
| (any plugin folder name) | preferences of a particular plugin |
# Redirection
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
* You can redirect to a URL using the following static method:
```php
$url = "https://www.yourwebsite.com".
e107::redirect($url);
```
* To redirect to the homepage, simply leave the URL blank.
```php
e107::redirect();
```
* To redirect to the Admin Area, use the value 'admin'.
```php
e107::redirect('admin');
```
# Render
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
Use the following to retrieve the render class object.
```php
$ns = e107::getRender();
```
## Render methods
### tablerender()
Send HTML to the browser for output.
```php
$ns->tablerender($caption, $text, $mode, $return);
```
| Parameter | Type | Description | Mandatory |
| ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | --------- |
| **caption** | string | Text for header/caption | **Yes** |
| **text** | string | Actual text/content | **Yes** |
| mode | string |
Unique name for what is being rendered. eg contact-menu Used in themes and plugins.
Default: default
| No |
| return | boolean |
When set to true the content is returned instead of being echoed
Default: false
| No |
# Route
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
{% hint style="info" %}
{% endhint %}
# URLs
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
You can generate a Search Engine Friendly (SEF) URLs using the following method:
```php
e107::url($plugin, $key, $row, $options);
```
Parameter
Type
Description
Mandatory?
plugin
string
Folder name of the plugin. (will use data from e_url.php)
Yes
key
string
Unique key
Yes
row
array
Array of variable data such as id, title etc. eg. user_id, user_name
No
options
array
An associative array of additional options, with the following elements:
mode: abs | full (returning the absolute path or full URL)
query: an array of query key/value-pairs (without any URL-encoding) to append to the URL.
fragment: a fragment identifier (named anchor) to append to the URL. Do not include the leading '#' character.
(optional)
No
## **Examples**
### **Example 1: Forum topic URLs**
In this example we will generate search-engine-friendly URLs for a forum topic with the following code: .
```php
// these values are usually loaded from the database.
$data = array(
'forum_sef' => 'my-sef-forum-name',
'thread_id' => 2,
'thread_sef' => 'my-forum-topic'
);
$url = e107::url('forum','topic', $data);
```
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`:
```php
$config['topic'] = array(
'regex' => '^forum/(.*)/(d*)-([w-]*)/???(.*)',
'sef' => 'forum/{forum_sef}/{thread_id}-{thread_sef}/',
'redirect' => '/e107_plugins/forum/forum_viewtopic.php?id=$2'
);
```
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.
The end result would look something like this:
### Example 2: Using optional parameters
{% hint style="info" %}
**TODO: Add examples using the options parameter**
{% endhint %}
# User Data
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
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.
```php
e107::user($user_id);
$userData = e107::user(USERID); // Example - currently logged in user.
$userData = e107::user(5); // Example User ID #5.
```
{% hint style="info" %}
todo: add example output
{% endhint %}
# Introduction
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
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
*
## [ADMIN-UI ](/plugin-development/admin-ui)
## [addons](/plugin-development/extending-core-functionality-addons)
# Plugin Builder
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
By far, the quickest and easiest way to develop a plugin for e107 is to use the [Plugin Builder](/plugin-development/plugin-builder), because:
* It allows you to select the database file ([plugin\_sql.php](/plugin-development/installation-and-configuration#plugin_sql-php)) file from the plugin folder, or directly from the database table list, and it will generate most of the new code for the [Admin-UI](/plugin-development/admin-ui) of your plugin.
* It will generate the new [plugin.xml](/plugin-development/installation-and-configuration#plugin-xml) meta-file, which is used during installation of your plugin and also when sharing plugins via this site.
{% hint style="success" %}
The Plugin Builder can be found in Admin Area > Manage > Plugin Manager > Plugin Builder.
{% endhint %}
## 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)
5. Go to Admin Area > Manage > [Plugin Manager](https://userguide.e107.org/administration/manage/plugin-manager) > Plugin Builder and choose "*myplugin*" from the dropdown menu and then follow the prompts.
6. Thoroughly check the details of each Table Tab (and Preferences Tab if you need them) before proceeding with the creation process.
## Basic info
{% hint style="info" %}
This section has not been finished yet!
{% endhint %}
## Database tables
{% hint style="info" %}
This section has not been finished yet!
{% endhint %}
field
caption
type
data
width
batch
filter
inline
validate
display
R/O
Helptip
ReadParms
WriteParms
## Preferences
{% hint style="info" %}
This section has not been finished yet!
{% endhint %}
## Addons
{% hint style="info" %}
This section has not been finished yet!
{% endhint %}
# Admin-UI (User Interface)
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
The Admin-UI (Admin User Interface) is .....
{% hint style="info" %}
TODO: explain what it is and what it does
{% endhint %}
### Advantages of the Admin-UI
:thumbsup: The advantages of using the new [Admin-UI](/plugin-development/admin-ui) are numerous - including, but not limited to:
* 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.
{% hint style="info" %}
:thumbsup: **TIP:** The [Plugin Builder](/plugin-development/plugin-builder) is very useful tool to use for the Admin-UI as it will generate most of the new code for the Admin-UI of your plugin.
{% endhint %}
{% content-ref url="/pages/-M8L7UlhkmSR6OQuNPAr" %}
[Plugin Builder](/plugin-development/plugin-builder)
{% endcontent-ref %}
### **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.
{% hint style="warning" %}
It is strongly recommended to use **admin\_config.php** as the filename!
{% endhint %}
```php
"Type 1", 'type_2' => 'Type 2');
if($mode == 'read')
{
return vartrue($types[$curVal]).' (custom!)';
}
if($mode == 'batch') // Custom Batch List for blank_type
{
return $types;
}
if($mode == 'filter') // Custom Filter List for blank_type
{
return $types;
}
return $frm->select('blank_type', $types, $curVal);
}
}
new plugin_blank_admin();
require_once(e_ADMIN."auth.php");
e107::getAdminUI()->runPage();
require_once(e_ADMIN."footer.php");
```
## Classes, methods, variables
{% hint style="warning" %}
This section will summarize the various options which may be used while utilizing the Admin-UI class.
**Please note that the documentation for this section is a work-in-progress.** \
Thank you for your patience!
{% endhint %}
### 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:*
```php
protected $fields = array(
'myfield_id' => array(
"title" => "My Title",
"type" => "text",
"data" => "str",
"width" => "auto",
"inline" => true
),
// .....
);
```
| Key | Format | Description |
| ---------- | ----------------- | ----------------------------------------------------- |
| title | string | Field Title |
| type | string | Type of Field |
| data | string | Data Type |
| width | string | width of the column (List View) |
| inline | boolean \| string | Enable or disable inline editing. |
| help | string | Popup helper text (tooltip) |
| readParms | array | Parameters specific to the 'list' mode. |
| writeParms | array | Parameters specific to the 'edit' and 'create' modes. |
#### type
| Type | Description |
| ---------------------- | -------------------------------------------------------------------------------------- |
| text | text box |
| number | text box (number) |
| checkbox | checkbox (0 or 1 is returned) |
| icon | icon (from media manager) |
| textarea | text area (text only) |
| boolean | radio buttons with enable/disable |
| bbarea | right text area (html) |
| dropdown | dropdown list (ie. `` ) |
| userclass | drop-down list of userclasses |
| userclasses | checkboxes for multiple userclasses |
| datestamp | date / time text box |
| user | user selection text box. (type 3 letters to find/search) |
| hidden | hidden field |
| ip | text field with ip decoding |
| email | text field for email addresses |
| url | text field for urls (becomes clickable in list mode) |
| password | password field (with optional generator) |
| image | Media-manager image selection tool for a single image |
| images | Media-manager image selection tool for multiple images |
| file | Media-manager file selection tool for a single file |
| files | Media-manager file selection tool for multiple files |
| media | Media-Manager selection tool for images, mp4, youtube and gylphs. (requires type=json) |
| method | custom method |
| lanlist | drop-down list of installed languages |
| language | drop-down list of all languages |
| templates | Dropdown list of templates (from a template file) |
| null (without quotes) | Ignore this field and do not save it's data |
| false (without quotes) | Hide this field but save it's data if a posted key value is found. |
#### data
| Value | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------ |
| str | Posted data is converted to string before saving to the database |
| safestr | Posted data is run through a filter (using `filter_var(FILTER_SANITIZE_STRING)`) and thus strips HTML. |
| int | Posted data is converted to integer before saving to the database |
| array | Posted data is converted to an e107 array format. (use `e107::unserialize()` to decode) |
| json | Posted data is converted to json format before saving to the database |
| false (no quotes) | Posted data from this field is not saved to the database |
#### readParms (list mode)
| Key | Value | Field-type | Comments |
| ------ | ---------------------------------------------- | ------------------------ | ----------------------- |
| thumb | (integer) | image | Set the thumbnail width |
| url | (string) e\_url.php key value or a field key. | number, text, tags, null | Wrap value in a link |
| target | (string) blank \| dialog | number, text, tags, null | Target for 'url' above. |
#### writeParms (create/edit mode)
| Key | Value | Field-type | Comments |
| ------------ | ------------------------------------------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------- |
| pre | (html) | (all) | Render html just before the field |
| post | (html) | (all) | Render html just after the field |
| media | (string) | bbarea | Sets the media-owner category to be used by the media-manager |
| video | 0 or 1 | image | Show video selector tab in media-manager |
| path | 'plugin' or null | image | When set to 'plugin', images will be stored in the 'plugin' folder within e107\_media |
| glyphs | 0 or 1 | icon | Show glyph selector tab in media-manager |
| size | large, xlarge, xxlarge, block-level | text, url, email, textarea, dropdown | Set the size (width) of input field |
| optArray | (array of key=>value pairs) | dropdown, checkboxes | Set the keys/values to be used in the dropdown or checkboxes. |
| placeholder | (string) | text, url, email, textarea | Placeholder text |
| pattern | (regexp) | text, url, email | Regular expression validation |
| type | date or datetime | datestamp | Choose between date or date and time |
| readonly | 0 or 1 | datestamp | Make element read-only |
| auto | 0 or 1 | datestamp | Insert current date/time automatically |
| label | yesno | boolean | Change "Enabled" and "Disabled" to "Yes" and "No". |
| inverse | 0 or 1 | boolean | Invert the values of 0 and 1. ie. "Disabled" = 1 and "Enabled" = 0. |
| enabled | (string) | boolean | Alternate text to replace "Enabled" |
| disabled | (string) | boolean | Alternate text to replace "Disabled" |
| classlist |
| userclass | Set which userclasses should be displayed. |
| tdClassLeft | (string) | (all) | Set the css class for the left-side table cell. |
| tdClassRight | (string) | (all) | Set the css class for the right-side table cell. |
| trClass | (string) | (all) | Set the css class for the table row. |
| nolabel | 0 or 1 | (all) | Hide the left table cell |
## 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:
```php
protected $sortField = 'field1';
protected $sortParent = 'field2';
protected $treePrefix = 'field3';
```
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
{% hint style="info" %}
Examples can be found in the forum and download plugin.
{% endhint %}
```php
protected $sortField = 'download_category_order';
protected $sortParent = 'download_category_parent';
protected $treePrefix = 'download_category_name';
```
# Installation & configuration
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## Introduction
## Folder structure & files
The table below lists the files that can be used in a plugin. Only few of them are mandatory.
{% hint style="info" %}
**Note:** Please replace the cursive *plugin* with the name of the plugin folder. \
(\**menu.php, \*\_setup.php, \*\_shortcodes.php, \*\_sql.php).*
{% endhint %}
{% hint style="success" %}
**TIP:** the \_blank plugin contains useful examples as reference material.
{% endhint %}
Plugin category. Choose from: - settings - users - content - tools - manage - misc - menu - about
Yes
<keywords>
No
<word>
Keyword
No
<adminLinks>
No
<link>
Yes
url
URL of the link
Yes
description
Description of the link
Yes
icons
icon path
Yes
<sitelinks>
No
<link>
Link name
Yes
url
URL of the link
Yes
<pluginPrefs>
No
<pref>
Value of the pref
Yes
name
Name of the pref
Yes
<dependencies>
No
<plugin>
No
name
Yes
min_version
No
<PHP>
No
name
Yes (= core)
min_version
Yes
<MySQL>
No
name
Yes (= server)
min_version
Yes
<extension>
No
name
Yes
min version
No
<userClasses>
No
<class>
Yes
name
class_name (lowercase)
Yes
description
Description of the userclass
Yes
<extendedFields>
No
<field>
Yes
name
Name of the EUF
Yes
type
Type of the EUF. Choose from:
EUF_TEXT
EUF_RADIO
EUF_DROPDOWN
EUF_DB_FIELD
EUF_TEXTAREA
EUF_INTEGER
EUF_DATE
EUF_LANGUAGE
EUF_PREDEFINED
EUF_CHECKBOX
EUF_PREFIELD
EUF_ADDON
EUF_COUNTRY
EUF_RICHTEXTAREA
Yes
default
Yes
active
true/false
Yes
### Examples
#### Simple
```markup
This plugin's description.content
LAN_CONFIGURE
Newsfeeds
```
#### Advanced
```markup
Add frequently asked questions to your e107 website.A simple plugin to add Frequently Asked Questions to your website.Copyright e107 Inc e107.org, Licensed under GPLcontentfaqquestionanswer
LAN_CONFIGURE
LAN_PLUGIN_FAQS_NAME
2552550
```
### **Commercial plugins**
Commercial plugins can make use of a few extra attributes to the \ element, so that this information will be displayed correctly in the admin area under :point\_right: "[Find Plugins](https://userguide.e107.org/administration/manage/plugin-manager#find-plugins)".
| Attribute | Description |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Price |
Purchasing price of the plugin (in xx.xx format).
Example: 25.00
|
| Currency |
Currency codes (ISO 4217)
Example: EUR
|
| URL |
Direct path to the website page where the plugin can be purchased. When the user clicks to download your plugin, the URL will be displayed.
❗Note: do not add the URL to the generic homepage of your website, but only the URL to the specific page for that specific plugin.
|
#### Example
```markup
```
## *plugin*\_menu.php
....
## *plugin*\_setup.php
{% hint style="info" %}
Do not forget to use your plugin name in the filename, e.g. "*myplugin\_setup.php*"
{% endhint %}
{% hint style="info" %}
TODO: Add this section, provide example.
{% endhint %}
## *plugin\_shortcodes.php*
Please refer to the [Plugin shortcodes](#plugin_shortcodes.php) page
{% content-ref url="/pages/-MUU-xAktEgx\_STyxzDR" %}
[Plugin shortcodes](/plugin-development/plugin-shortcodes)
{% endcontent-ref %}
## *plugin*\_sql.php
{% hint style="info" %}
Do not forget to use your plugin name in the filename, e.g. "*myplugin\_sql.php*"
{% endhint %}
This file contains the SQL database structure of the plugin. It will be analyzed on plugin install and missing tables will be installed automatically.
Any differences between the defined structure here and the table structure on the server will be detected and the user will be informed in the Admin Area.
{% hint style="success" %}
:thumbsup:**TIP:** To check if the table structure is still valid, run :point\_right:"Admin Area > Tools > Database > [Check for Updates](https://userguide.e107.org/administration/tools/database#check-for-updates)"
{% endhint %}
### Supported operations
For the moment, the following operations are supported:
* Create table
* Change field type, field size, field null or not, field default value
* Add index
### Unsupported operations
Operations that are currently NOT supported are:
* **Rename table:** by renaming the tablename, e.g. "blank" > "blank2"). The renamed table will be considered as new!
* **Drop a table:** e.g. if you remove the "blank" table definition from this file, the table will NOT be deleted from the database!)
* **Rename or drop a field:** a renamed field will be considered new, a missing field definition will NOT be recognized at all!
* **Change an index/key:** the change is recognized, but leads to an error message and the change is not applied.
* **Rename or drop an index/key:** rename is recognized as a new index and the missing index is not recognized at all!)
* A field definition containing "NULL DEFAULT NULL". The "Check for updates" method will always detect a change.
* but fails silently when trying to update. In that case remove the first "NULL" and run the the "Check for updates" again.
{% hint style="success" %}
:thumbsup:**TIP:** Check the *blank\_setup.php* file or the forum\_setup.php file for examples on renaming/dropping/modifying tables, fields and indexes.
{% endhint %}
### Example
```sql
CREATE TABLE blank (
`blank_id` int(10) NOT NULL AUTO_INCREMENT,
`blank_icon` varchar(255) NOT NULL,
`blank_type` varchar(10) NOT NULL,
`blank_name` varchar(50) NOT NULL,
`blank_folder` varchar(50) DEFAULT NULL,
`blank_version` varchar(5) NOT NULL,
`blank_author` varchar(50) NOT NULL,
`blank_authorURL` varchar(255) NOT NULL,
`blank_date` int(10) NOT NULL,
`blank_compatibility` varchar(5) NOT NULL,
`blank_url` varchar(255) NOT NULL,
`blank_media` json DEFAULT NULL,
`blank_class` int(10) NOT NULL,
PRIMARY KEY (`blank_id`)
) ENGINE=MyISAM;
```
## admin\_config.php
Please refer to the[ Admin-UI (User Interface) page. ](/plugin-development/admin-ui)
{% content-ref url="/pages/-M8AVDQ4CL\_ofKpUF9gG" %}
[Admin-UI (User Interface)](/plugin-development/admin-ui)
{% endcontent-ref %}
# Plugin shortcodes
## myplugin\_shortcodes.php
# Internationalisation (LAN)
## 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.
{% hint style="warning" %}
:thumbsup: **You should always include the English language files in your plugin!**
{% endhint %}
## Language files
### File Types
There are three types of language files that can be used in your plugin.
| Language File | Usage |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| English\_front.php | Used **only** for the frontend of your plugin |
| English\_admin.php | Used **only** for the Admin Area of your plugin |
| English\_global.php | Used site-wide, for example in :point\_right: [plugin.xml](/plugin-development/installation-and-configuration#plugin-xml), files such as`xxxx_menu.php`or :point\_right: [addons](/plugin-development/extending-core-functionality-addons). |
## Defining Language Terms
Language Terms are more commonly known as *LAN's.* You can define LAN's by using PHP constants:
```php
define("LAN_PLUGIN_MYPLUGIN_NAME", "Blank Plugin");
define("LAN_PLUGIN_MYPLUGIN_DIZ", "A Blank Plugin to help you get started in plugin development. More details can be added here.");
define("LAN_PLUGIN_MYPLUGIN_LINK", "Blank Link");
```
### Best practices
:thumbsup: **Always use the format LAN\_PLUGIN\_{FOLDER}\_{TYPE} to prevent conflicts.**
#### Avoid duplicating terms, particularly in the admin area.
:thumbsup: If defining terms for admin, always search `lan_admin.php` for existing LANs which may match what you require.
#### Never use HTML or URLs inside LAN definitions.
:thumbsup: Use double quotes within the defines and use `str_replace()` or :point\_right: [lanVars()](/classes-and-methods/parser#lanvars) for [variables ](/plugin-development/internationalisation#substitution)where needed.
#### 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.
:thumbsup: If embedding values into a phrase, use [substitution](/plugin-development/internationalisation#substitution).
#### Avoid using [substitution](/plugin-development/internationalisation#substitution) terms which are real words or known BBCodes.
:thumbsup: Use brackets `[..]` and values such as x, y, z. See [examples ](/plugin-development/internationalisation#examples)below.
### Examples
#### **Good**
```php
define("LAN_XXX", "Thank you Firstname");
define("LAN_XXX", "Go to [x] to see the results."); // Good - replace [ and ] with and using str_replace()
define("LAN_XXX", "I want to [quote] here"); // Good - replace [ and ] with " " using str_replace()
```
#### **Bad**
```php
define("LAN_XXX", "Thank you Firstname"); // Bad contains HTML
define("LAN_XXX", "Thank you Firstname"); // Bad contains HTML and allows translator to modify link.
```
#### **Substitution**
```php
define("LAN_EXAMPLE_01", "Update results: [x] records changed, [y] errors, [z] not changed");
$repl = array($changed, $errors, $unchanged);
$text = e107::getParser()->lanVars(LAN_EXAMPLE_01, $repl);
```
## Loading Language Files
### e107::lan()
To load a language file from a plugin folder, use `e107::lan()`:
```php
e107::lan('faqs');
e107::lan('faqs', true);
e107::lan('faqs', false, true);
e107::lan('faqs', true, true);
```
This will include the following paths:
```
e107_plugins/faqs/languages/English_front.php
e107_plugins/faqs/languages/English_admin.php
e107_plugins/faqs/languages/English/English_front.php
e107_plugins/faqs/languages/English/English_admin.php
```
# Extending core functionality (addons)
{% hint style="danger" %}
**Please note:** This page is under construction and has not been finished yet.
{% endhint %}
## 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.
{% hint style="warning" %}
**Please note:** If addons are added after plugin installation, you may need to run the :point\_right: "[Scan plugin directories](https://userguide.e107.org/administration/tools/database#scan-plugin-directories)" option in Admin Area > Tools > [Database](https://userguide.e107.org/administration/tools/database).
{% endhint %}
{% hint style="info" %}
**TIP:** The `_blank` plugin in the e107\_plugins folder contains example addons that may be an easy reference for you.
{% endhint %}
### Overview of all plugin addons
| Name | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [e\_admin](#e_admin.php) | Allows to extend areas of the [Admin UI](/plugin-development/admin-ui) |
| [e\_bb](#e_bb.php) | Allows a plugin to add customized BBCodes. |
| [e\_comment](#e_comment.php) | Allows a plugin to override the default :point\_right:[comments 'engine'](https://userguide.e107.org/administration/manage/comments-manager#engine) |
| [e\_cron](#e_cron.php) | Allows a plugin to add additional :point\_right:[Scheduled Tasks](https://userguide.e107.org/administration/tools/schedule-tasks) (or 'cronjobs') to e107. |
| [e\_dashboard](#e_dashboard.php) | Adds custom plugin information to the dashboard of e107's admin area. |
| [e\_emailprint](#e_emailprint.php) |
|
| [e\_event](#e_event.php) | Allows a plugin to easily hook into system events and trigger their own methods/functions. |
| [e\_featurebox](#e_featurebox.php) | Allows a plugin to generate content for the :point\_right:[Featurebox plugin](https://userguide.e107.org/core-plugins/featurebox). |
| [e\_footer](#e_footer.php) | Allows a plugin to include code in the footer of every page of the site |
| [e\_frontpage](#e_frontpage.php) | Allows a plugin developer to add their plugin as a :point\_right:[Frontpage](https://userguide.e107.org/administration/settings/front-page) option. |
| [e\_gsitemap](#e_gsitemap.php) | Allows a plugin to create automated entries for the :point\_right:[Google Sitemap plugin](https://userguide.e107.org/core-plugins/google-sitemap). |
| [e\_header](#e_header.php) | Allows a plugin developer to add data to `` of every page. |
| [e\_help](#e_help.php) |
Deprecated!
Allowed plugin developers to add information to the plugin configuration page sidebar. This has now been integrated within the Admin-UI through the renderHelp() method.
|
| [e\_list](#e_list.php) | Allows a plugin to hook into the :point\_right:[List Latest plugin](https://app.gitbook.com/@e107/s/user-guide/core-plugins/list-latest) |
| [e\_mailout](#e_mailout.php) | Allows a plugin to use e107's mailout feature for bulk mailing. |
| [e\_menu](#e_menu.php) | Provide configuration options for each instance of the plugin's menus. |
| [e\_meta](#e_meta.php) |
|
| [e\_module](#e_module.php) | Is loaded every time the core of e107 is included and allows a developer to modify or define code which should be loaded prior to the header or anything that is sent to the browser as output. |
| [e\_notify](#e_notify.php) | Adds a plugin to the [notifications](https://userguide.e107.org/administration/tools/notify) section in e107's admin area. |
| [e\_output](#e_output.php) | Allows a plugin to hook into all pages at the end (after closing ``) |
| [e\_parse](#e_parse.php) | Allows a plugin to hook into e107's [parser methods](/classes-and-methods/parser#parser-methods) |
| [e\_print](#e_print.php) | Allows a plugin developer to specify content that is displayed in printer-friendly format. |
| [e\_rss](#e_rss.php) | Adds a plugin to the RSS plugin, and generates RSS feeds. |
| [e\_related](#e_related.php) | Adds a plugin to the search which generates 'related' links in news items and pages. |
| [e\_search](#e_search.php) | Adds a plugin to the :point\_right:[Search page](https://userguide.e107.org/administration/settings/search). |
| [e\_shortcode](#e_shortcode.php) | Allows a plugin to make their shortcodes available to core templates and templates of other plugins. |
| [e\_sitelink](#e_sitelink.php) | Allows a plugin to automatically generate :point\_right:[Navigation](https://userguide.e107.org/administration/settings/navigation) links |
| [e\_status](#e_status.php) |
|
| [e\_upload](#e_upload.php) | Allows a plugin to set categories for :point\_right:[Public Uploads](https://userguide.e107.org/administration/content/public-uploads) |
| [e\_url](#e_url.php) | Provides a simple way to add mod-rewrite redirects to a plugin's page. Used to create search-engine-friendly URLs through the [e107::url()](/classes-and-methods/urls) method. |
| [e\_user](#e_user.php) | Adds information about a specific user to the user's profile page, allows to add fields to the user settings page and allows to specify a routine that is run upon user deletion. |
## Plugin addons
{% hint style="warning" %}
:thumbsup: Be sure to replace `plugindir` with your plugin's directory name in all examples below.
{% endhint %}
### e\_admin.php
{% hint style="info" %}
**TODO**: Add example. See social plugin for an example.
{% endhint %}
### e\_bb.php
{% hint style="info" %}
**TODO**: Add example.
{% endhint %}
### e\_comment.php
{% hint style="info" %}
**TODO**: Add example. See social plugin for an example.
{% endhint %}
### e\_cron.php
This addon allows a plugin to add additional scheduled task options to e107. (see Admin Area > Tools > [Scheduled Tasks](https://userguide.e107.org/administration/tools/schedule-tasks)).
#### *Example:*
```php
class plugindir_cron // plugin-folder name + '_cron'
{
function config() // Setup
{
$cron = array();
$cron[] = array(
'name' => "Name of my function", // Displayed in admin area. .
'function' => "myFunction", // Name of the function which is defined below.
'category' => 'mail', // Choose between: mail, user, content, notify, or backup
'description' => "Description of what my function does" // Displayed in admin area.
);
return $cron;
}
public function myFunction()
{
// Do something.
}
}
```
### 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.
{% hint style="info" %}
Previously, the `e_latest` and `e_status` addons were used separately for this. They have now been incorporated into the e\_dashboard addon.
{% endhint %}
#### *Example:*
```php
class plugindir_dashboard // plugin-folder name + '_dashboard'
{
private $title; // dynamic title.
function chart()
{
$config = array();
$config[] = array(
'text' => $this->activity(),
'caption' => $this->title,
);
return $config;
}
/**
* Non-functional example.
*/
function activity()
{
// do something
}
function status() // Status Panel in the admin area
{
$var[0]['icon'] = "";
$var[0]['title'] = "My Title";
$var[0]['url'] = e_PLUGIN_ABS."plugindir/plugin.php";
$var[0]['total'] = 10;
return $var;
}
function latest() // Latest panel in the admin area.
{
$var[0]['icon'] = "";
$var[0]['title'] = "My Title";
$var[0]['url'] = e_PLUGIN_ABS."plugindir/plugin.php";
$var[0]['total'] = 10;
return $var;
}
}
```
### e\_emailprint.php
{% hint style="warning" %}
**Deprecated!**\
This addon has been deprecated. Use [e\_print.php](/plugin-development/extending-core-functionality-addons#e_print-php) instead.
{% endhint %}
### 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.
{% hint style="success" %}
You can make use of the [event methods](https://devguide.e107.org/classes-and-methods/events#events-methods) and [event triggers](https://devguide.e107.org/classes-and-methods/events#event-triggers).
{% endhint %}
#### *Example:*
```php
class plugindir_event // plugin-folder + '_event'
{
function config()
{
$event = array();
// Hook into a core event, in this case "login".
$event[] = array(
'name' => "login", // when this is triggered...
'function' => "myfunction", // ..run this function (see below).
);
// Hook into a custom plugin event (created by that plugin author)
$event[] = array(
'name' => "pluginfolder_customevent", // hook into a custom plugin event
'function' => "otherfunction", // ..run another function (see below).
);
return $event;
}
function myfunction($data) // the method to run.
{
// var_dump($data);
}
function otherfunction($data) // the method to run.
{
// var_dump($data);
}
}
```
### e\_featurebox.php
{% hint style="info" %}
**TODO:** Add example.
{% endhint %}
### e\_footer.php
This addon allows a plugin to include code in the footer of every page of the site.
{% hint style="info" %}
Please find an example in the "tinymce4" plugin.
{% endhint %}
### e\_frontpage.php
This addon allows a plugin developer to add their plugin as a :point\_right:[Frontpage](https://userguide.e107.org/administration/settings/front-page) option.
#### ***Example:***
```php
class plugindir_frontpage // plugin-folder + '_frontpage'
{
// Option 1: individual item
function config()
{
$frontPage = array(
'page' => '{e_PLUGIN}_blank/_blank.php',
'title' => LAN_PLUGIN__BLANK_NAME
);
return $frontPage;
}
// Option 2: multiple items
function config()
{
$config = array();
$config['title'] = LAN_PLUGIN__BLANK_NAME;
$config['page'] = array(
0 => array(
'page' => '{e_PLUGIN}_blank/_blank.php',
'title'=>'Main Page'
),
);
return $config;
}
}
```
### e\_gsitemap.php
{% hint style="info" %}
**TODO:** Add example. See "news" plugin folder for an example.
{% endhint %}
### e\_header.php
This addon allows a plugin developer to add data to the `` of every page. This file is loaded in the header of each page of your site. ie. Wherever you see `require_once(HEADERF)` in a script.\
\
Typically you would use one or all of the following functions within this file: [`e107::js()`](/classes-and-methods/javascript), [`e107::css()`](/classes-and-methods/css) or [`e107::meta()`](/classes-and-methods/meta)
{% hint style="danger" %}
**Warning:** Output should never be echoed or printed from this file!
{% endhint %}
#### *Example:*
```php
if(deftrue('USER_AREA')) // prevents inclusion of JS/CSS/meta in the admin area.
{
e107::js('_blank', 'js/blank.js'); // loads e107_plugins/_blank/js/blank.js on every page.
e107::css('_blank', 'css/blank.css'); // loads e107_plugins/_blank/css/blank.css on every page
e107::meta('keywords', 'blank,words'); // sets meta keywords on every page.
}
```
### e\_help.php
{% hint style="warning" %}
**Deprecated!** \
This addon allowed plugin developers to add information to the plugin configuration page *sidebar*. \
\
This has now been integrated within the [Admin-UI](/plugin-development/admin-ui) through the `renderHelp()` method.
{% endhint %}
### e\_latest.php
{% hint style="warning" %}
**Deprecated!**\
This addon has been deprecated. Use [e\_dashboard.php](/plugin-development/extending-core-functionality-addons#e_dashboard-php) instead.
{% endhint %}
### e\_library.php
{% hint style="info" %}
Please find an example in the "\_blank" plugin.
{% endhint %}
### e\_linkgen.php
{% hint style="warning" %}
**Deprecated!**\
This addon has been deprecated. Use [e\_sitelink.php](/plugin-development/extending-core-functionality-addons#e_sitelink-php) instead.
{% endhint %}
### e\_list.php
{% hint style="info" %}
**TODO:** Add example.
{% endhint %}
### e\_mailout.php
This addon allows a plugin to use e107's mailout feature for bulk mailing.
{% hint style="info" %}
Please find an example in the "newsletter" plugin.
{% endhint %}
### e\_menu.php
This addon provides configuration options for each instance of the plugin's menus.
{% hint style="info" %}
The `e_menu.php` addon is a replacement for the old `config.php` file used in e107 v1.x.
{% endhint %}
#### *Example:*
```php
class plugindir_menu // plugin-folder name + '_menu'
{
function __construct()
{
}
/**
* Configuration Fields.
* See Admin-UI field configurations (https://devguide.e107.org/plugin-development/admin-ui)
* @return array
*/
public function config($menu='')
{
$fields = array();
$fields['blankCaption'] = array('title' => "Caption", 'type' => 'text', 'multilan'=>true, 'writeParms'=>array('size'=>'xxlarge'));
$fields['blankCount'] = array('title' => "Enabled", 'type' => 'number');
$fields['blankCustom'] = array('title' => "Enabled", 'type' => 'method'); // see below.
return $fields;
}
}
// optional - for when using custom methods above.
class plugindir_menu_form extends e_form
{
function blankCustom($curVal)
{
$frm = e107::getForm();
$opts = array(1, 2, 3, 4);
$frm->select('blankCustom', $opts, $curVal);
}
}
```
### e\_meta.php
{% hint style="warning" %}
**Deprecated!**\
This addon has been deprecated. Use [e\_header.php](/plugin-development/extending-core-functionality-addons#e_header-php) instead.
{% endhint %}
### 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
This addon adds the plugin to the :point\_right: [Notify](https://userguide.e107.org/administration/tools/notify) section in the Admin Area and allows a plugin to send notifications.
#### *Example:*
```php
class plugindir_notify extends notify // plugin-folder name + '_notify'
{
function config()
{
$config = array();
$config[] = array(
'name' => "New Trigger Name", // Displayed in admin area.
'function' => "plugindir_mytrigger",
'category' => ''
);
return $config;
}
function plugindir_mytrigger($data)
{
$message = print_a($data,true);
$this->send('plugindir_mytrigger', "My Subject", $message);
}
}
```
The notification can then be triggered by using:
```php
e107::getEvent()->trigger("plugindir_mytrigger", $data);
```
### e\_output.php
This addon allows to hook into all pages at the very end (after the closing ``). This is useful for example when capturing :point\_right: [*output buffering*](https://www.php.net/manual/en/book.outcontrol.php)*.*
### e\_parse.php
This addon allows to hook into e107's [parser methods](/classes-and-methods/parser#parser-methods)
#### *Example:*
```php
class plugindir_parse // plugin-folder name + '_parse'
{
/**
* Process a string before it is sent to the browser as html.
* @param string $text html/text to be processed.
* @param string $context Current context ie. OLDDEFAULT | BODY | TITLE | SUMMARY | DESCRIPTION | WYSIWYG etc.
* @return string
*/
function toHTML($text, $context = '')
{
$text = str_replace('****', '', $text);
return $text;
}
/**
* Process a string before it is saved to the database.
* @param string $text html/text to be processed.
* @param array $param nostrip, noencode etc.
* @return string
*/
function toDB($text, $param = array())
{
$text = str_replace('', '****', $text);
return $text;
}
}
```
### e\_print.php
This addon allows a plugin developer to specify content that is displayed in printer-friendly format
#### ***Example:***
```php
class plugindir_print // plugin-folder + '_print'
{
public function render($parm)
{
$text = "Hello {$parm}!";
return $text;
}
}
```
### e\_rss.php
This addon adds the plugin to the RSS plugin, and generates RSS feeds for the plugin.
#### *Example:*
```php
class plugindir_rss // plugin-folder name + '_rss'
{
/**
* Admin RSS Configuration
*/
function config()
{
$config = array();
$config[] = array(
'name' => 'Feed Name',
'url' => 'blank',
'topic_id' => '',
'description' => 'This is the RSS feed for the blank plugin', // that's 'description' not 'text'
'class' => e_UC_MEMBER,
'limit' => '9'
);
return $config;
}
/**
* Compile RSS Data
* @param array $parms
* @param string $parms['url']
* @param int $parms['limit']
* @param int $parms['id']
* @return array
*/
function data($parms=array())
{
$sql = e107::getDb();
$rss = array();
$i = 0;
if($items = $sql->select('blank', "*", "blank_field = 1 LIMIT 0,".$parms['limit']))
{
while($row = $sql->fetch())
{
$rss[$i]['author'] = $row['blank_user_id'];
$rss[$i]['author_email'] = $row['blank_user_email'];
$rss[$i]['link'] = "_blank/_blank.php?";
$rss[$i]['linkid'] = $row['blank_id'];
$rss[$i]['title'] = $row['blank_title'];
$rss[$i]['description'] = $row['blank_message'];
$rss[$i]['category_name'] = '';
$rss[$i]['category_link'] = '';
$rss[$i]['datestamp'] = $row['blank_datestamp'];
$rss[$i]['enc_url'] = "";
$rss[$i]['enc_leng'] = "";
$rss[$i]['enc_type'] = "";
$i++;
}
}
return $rss;
}
}
```
### e\_related.php
This addon adds the plugin to the search which generates 'related' links in news items and pages of e107.
#### *Example:*
```php
class plugindir_related // plugin-folder name + '_menu'
{
function compile($tags,$parm=array())
{
$sql = e107::getDb();
$items = array();
$tag_regexp = "'(^|,)(".str_replace(",", "|", $tags).")(,|$)'";
$query = "SELECT * FROM `#_blank` WHERE _blank_id != ".$parm['current']." AND _blank_keywords REGEXP ".$tag_regexp." ORDER BY _blank_datestamp DESC LIMIT ".$parm['limit'];
if($sql->gen($query))
{
while($row = $sql->fetch())
{
$items[] = array(
'title' => varset($row['blank_title']),
'url' => e107::url('other',$row),
'summary' => varset($row['blank_summary']),
'image' => '{e_PLUGIN}_blank/images/image.png'
);
}
return $items;
}
}
}
```
### e\_search.php
This addon adds the plugin to the 'search page' of e107.
#### *Example:*
```php
class plugindir_search extends e_search // plugin-folder name + '_search'
{
function config()
{
$search = array(
'name' => "Blank Plugin",
'table' => 'blank',
'advanced' => array(
'date' => array('type' => 'date', 'text' => LAN_DATE_POSTED),
'author'=> array('type' => 'author', 'text' => LAN_SEARCH_61)
),
'return_fields' => array('blank_id', 'blank_nick', 'blank_message', 'blank_datestamp'),
'search_fields' => array('blank_nick' => '1', 'blank_message' => '1'), // fields and weights.
'order' => array('blank_datestamp' => 'DESC'),
'refpage' => 'chat.php'
);
return $search;
}
/* Compile Database data for output */
function compile($row)
{
preg_match("/([0-9]+)\.(.*)/", $row['blank_nick'], $user);
$res = array();
$res['link'] = e_PLUGIN."blank_menu/_blank.php?".$row['blank_id'].".fs";
$res['pre_title'] = LAN_SEARCH_7;
$res['title'] = $user[2];
$res['summary'] = $row['blank_message'];
$res['detail'] = e107::getParser()->toDate($row['blank_datestamp'], "long");
return $res;
}
/**
* Optional - Advanced Where
* @param $parm - data returned from $_GET (ie. advanced fields included. in this case 'date' and 'author' )
*/
function where($parm=null)
{
$tp = e107::getParser();
$qry = "";
if (vartrue($parm['time']) && is_numeric($parm['time']))
{
$qry .= " blank_datestamp ".($parm['on'] == 'new' ? '>=' : '<=')." '".(time() - $parm['time'])."' AND";
}
if (vartrue($parm['author']))
{
$qry .= " blank_nick LIKE '%".$tp->toDB($parm['author'])."%' AND";
}
return $qry;
}
}
```
### 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:*
```php
class plugindir_shortcodes extends e_shortcode
{
public $override = false; // when set to true, existing core/plugin shortcodes matching methods below will be overridden.
// Example: {PLUGINDIR_CUSTOM} shortcode - available site-wide.
function sc_plugindir_custom($parm = null) // Naming: "sc_" + [plugin-directory] + '_uniquename'
{
return "Hello World!";
}
}
```
### 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:*
```php
class plugindir_sitelink // plugin-folder name + '_sitelink'
{
function config()
{
$links = array();
$links[] = array(
'name' => 'Drop-Down MegaMenu',
'function' => 'megaMenu' // see method below
);
$links[] = array(
'name' => "Drop-Down Links",
'function' => "myCategories" // see method below
);
return $links;
}
function megaMenu()
{
$text = '
![](".e_PLUGIN."plugindir/images/blank_16.png){kind=spacer}
";
$var[0]['title'] = "My Title";
$var[0]['url'] = e_PLUGIN_ABS."plugindir/plugin.php";
$var[0]['total'] = 10;
return $var;
}
function latest() // Latest panel in the admin area.
{
$var[0]['icon'] = "