$tpl->js_file($path_to_file);

This code adds a javascript file link to the header. Just add the path to the JS-file.

Permission Changes

Permission-IDs

With the 0.7, you have to remove the auth_id from your add_permission-function. New:

// (Admin (a)/User (u), Name, Enables Y/N, Language cariable, array of user-group-ids that should have this permission)
$this->add_permission('a', 'import', 'N', $user->lang['dl_import']);

You can grant rights to Groups by adding the Group-IDs into an array and add it to your function-call:

$this->add_permission('a', 'import', 'N', $user->lang['dl_import'], array(1,2,3));

Pay attention: it doesn't care if the auth_default is Yes or No, the permission will be granted as Yes to the groups in your array!

Default Groups after installation:

• 1 = Guest-Group, undeletable
• 2 = Super-Admin, undeletable
• 3 = Admins, undeletable
• 4 = Members, undeletable
• 5 = Officers
• 6 = Writers

Permission Groups

to be implemented....

Grant permissions to the installing user

All plugin permissions will now be granted automatically to the installing user, so you should delete your own implementations from the plugin base class.

Data Fields Changes

The additional data fields (and their respective functions) introduced by eqDKP Plus 0.6 have been removed. The original data field now supports the following types:

var $valid_data_types = array('id', 'code', 'name', 'installed',
                              'contact', 'path', 'template_path',
                              'version', 'description', 'long_description',
                              'manuallink', 'homepage', 'imageurl',
                              'author'
                             );

Dependency System

Three different types of dependencies are now available to the plugin author to make sure their plugins are used in a system which fullfills some basic requirements. They can be set in your main plugin class as follows:

    $this->add_dependency(array(
      'plus_version'  => '0.7',
      'lib_version'   => '1.0.2',
      'games'         => array('aoc', 'eq', 'lotro', 'vanguard', 'wow'),
      'php_functions' => array('json_encode'),
      )
    );

You can skip each of them resulting in no respective restrictions. Each set dependency will be checked with the default checks. If you want to use custom checks you can implement the following method in your main plugin class:

  function check_dependency($dependency){
    // do checks and return true/false for all dependency types
  }

Breaking a dependency will prohibit the installation of your plugin, and maybe from initialisation in a future version (tba).

With these changes the plus_version data field and the $fwversion field in your plugin class will become obsolete.

Database Changes

Remove table constants

EQdkp no longer defines constants for SQL table names. In 0.6, you could use both: constants OR underscores. EQDKP-PLUS 0.7 will not longer allow constants. Instead, any name prefixed with two underscores will automatically gain the installation's EQdkp prefix.

Delete blocks like this from your <plugin>_plugin_class.php:

global $table_prefix;
if (!defined('WISHLIST_TABLE')) { define('WISHLIST_TABLE', $table_prefix . 'wishlist'); }
if (!defined('WISHLIST_DATA_TABLE')) { define('WISHLIST_DATA_TABLE', $table_prefix . 'wishlist_data'); }

Use the magic string instead of the constants:

// Define installation
// -----------------------------------------------------
$sql = "CREATE TABLE IF NOT EXISTS " . WISHLIST_TABLE . " (

becomes

// Define installation
// -----------------------------------------------------
$sql = "CREATE TABLE IF NOT EXISTS __wishlist (

Better sql Queries

This is completely optional but may clean up your code a bit.

You may have seen some code like this in EQdkp-Plus 0.6.x:

$insert = array(
        'wl_id'     => null,
        'wl_member' => ucfirst($user->data['username']),
        'wl_item'   => $_POST['wishlist_item'],
        'wl_type'   => $_POST['wishlist_type'],
);
 
$sql = INSERT INTO ' . WISHLIST_TABLE . $db->build_query('INSERT', $insert);
$db->query($sql);

The query method now takes an optional second parameter which, if an array, will be passed to build_query() and the results will replace a variable in the query called :params For example, the above lines could be re-written as one statement:

$db->query("INSERT INTO __wishlist :params", array(
        'wl_id'     => null,
        'wl_member' => ucfirst($user->data['username']),
        'wl_item'   => $_POST['wishlist_item'],
        'wl_type'   => $_POST['wishlist_type'],
));

The syntax is very similar for UPDATE queries, and the appropriate value is automatically detected and passed to build_query()

Portal Modules

If your plugin ships a portal module, there've been some changes, too. Instead of using a modules.php file in your plugin's 'portal' folder, you can now easily register your portal modules by calling:

$this->add_portal_module('nextraids');

for each of your modules (in this example it was the "nextraids" module) in your plugin object constructor.

Exchange Modules

You can add own exchange-modules for SOAP. Plase take a look at Plus Exchange for more information about creating an exchange module.

$this->add_exchange_module('shoutbox');

If you want to add an xml-feed, use the following code:

$this->add_exchange_module('shoutbox', true, 'shoutbox.xml');

Security Changes

Clean Input

$db->query("INSERT INTO __wishlist :params", array(
        'wl_id'     => null,
        'wl_member' => ucfirst($user->data['username']),
        'wl_item'   => $in->get('wishlist_item'),
        'wl_type'   => $in->get('wishlist_type'),
));

The $in variable references an instance of the Input class.

Clean Output

Always use "$db->escape()", for every single variable you'd in your sql queries. Here, settings.php forces the GET variable 'id' to be an integer:

$sql = "DELETE FROM " . RAIDPLAN_TABLE . "
        WHERE ( wl_id = " . intval($_GET['id']) . " )
        AND ( wl_member = '" . ucfirst($user->data['username']) . "' )
        LIMIT 1";

But we can have Input do this for us by passing it an integer as the second parameter, its default value if 'id' doesn't exist.

$sql = "DELETE FROM __wishlist
        WHERE ( wl_id = " . $db->escape($in->get('id', 0)) . " )
        AND ( wl_member = '" . $db->escape(ucfirst($user->data['username'])) . "' )
        LIMIT 1";

Cross-Site Scripting (XSS) Protection

Never trust what's being displayed to the user. Always sanitize() any variables being printed.

$tpl->assign_block_vars('raidplan_row', array(
        'ROW_CLASS'     => $eqdkp->switch_row_class(),
        'ITEM'          => sanitize($row['wl_item']),
        'ZONE'          => sanitize($row['wl_zone']),
        'BOSS'          => sanitize($row['wl_boss']),
));

Class and Race changes

In 0.7 we removed the __classes and __races table. All information about classes and races can now be fetched by using the new game-class. The three most used functions are:

get an array of $type: $game->get($type, $lang=false) => $type is e.g. classes, races, etc.; $lang is optional, if not given default language is used. if given: the language must be written as a word (e.g: german, english, french)
$game->get_name($type, $id, $lang=false) => $type is same as above; $id should be clear; $lang is same as above
$game->get_id($type, $name) => $type is same as above, $name is the string for which you want to get the ID. All available languages of the game are searched.

If you need further information about the game-class search this article.

Changed plus functions

changes globals

Global $eqdkp does not exist anymore. Use $core instead.

removed global functions

• clean_data()

changed global functions

• System_Message(..) ==> $eqdkp->message(..)
• ArraySystemMessage(..) ==> $eqdkp->messages(..)
• sql_highlight(..) ==> $db->sql_highlight(..)

added global functions

• compareVersion($version1, $version2) - compare two versions, up to 4 digit blocks (p.e. 0.4.2.10)

Changed html.class.php

The pluskernel/include/html.class.php has been deleted in 0.7. Most of the functions have been copied into the library html.class.php (which can be accessed by $html). But all the functions, which follow are NOT in the "new" html.class.php:

All the following functions can be used by using $plus instead of $html:

• CopyRightYear
• Copyright
• createVTable
• createGraph
• createpieGraph
• toggleIcons
• CreateDynamicIframeJS
• adminmenu
• get_php_setting
• get_curl_setting
• check_PHP_Function

Changed plus.functions.php

We cleaned up the plus.functions.php, too. All functions which are not listed here, should be available just as in 0.6:

The following functions have been removed and the functionality is little different as before:

In 0.7 you should not use class or race_names as index. Use the ID instead.

There are two functions which are usually needed to manage this.
$game->get_name($type, $id, $lang=false) => $type is e.g. classes, races, etc.; $id should be clear; $lang is optional, if you want to use this: the language must be written as a word (e.g: german, english, french)
$game->get_id($type, $name) => $type is same as above, $name is the string for which you want to get the ID. All available languages of the game are searched.
The two functions which has been removed because of this are:

• renameClasstoenglish
• renameRacetoenglish

The following Icon functions have been deleted and can now be found in the game-class. Usage as follows: $game->decorate($type, $params)

• get_RankIcon => $game->decorate('ranks', array($rank_id))
• get_RaceIcon => $game->decorate('races', array($race_id))
• get_ClassIcon => $game->decorate('classes', array($class_id))
• getEventIcon => $game->decorate('events', array($event_id))

get_class_color_code => changed to $game->get_class_color($class_id) (there are always css-classes defined with the class_colors: class_.$class_id)

This two functions can be called by $game->callFunc($funcname, $params)

• get_wow_talent_spec
• showAllvatarWoW_Signatur

This functions are now implemented into the pdh:

• get_classNamebyMemberName => $pdh->get('member', 'classname', array($member_id))
• get_RankNamebyMemberName => $pdh->get('member', 'racename', array($member_id))

This functions have been removed completely:

• get_classImgListmembers
• get_classNameImgListmembers
• get_classNameImgViewmembers
• get_coloredLinkedName
• get_classColorChecked

get_multi_pools and get_events_for_poolid can now be fetched by:

• $pdh->get('multidkp', 'id_list', array())
• $pdh->get('multidkp', 'name', array($multidkp_id))
• $pdh->get('multidkp', 'event_ids', array($multidkp_id))

check_auth_admin => use $user->check_auth('a_', false) instead

Plus Data Handler

You can also register new modules for our brand new data handler within your plugin object constructors by calling either:

$this->add_pdh_read_module('module_name');

or

$this->add_pdh_write_module('module_name');