Dave at 23:53, 21 August 2012

2012-08-21T23:53:12Z

Dave at 23:52, 21 August 2012

2012-08-21T23:52:09Z

Dave at 23:47, 21 August 2012

2012-08-21T23:47:08Z

Dave: Created page with "Plugin modules are the heart of FreeDESK extensibility and are developed in PHP. All plugin modules extend the base class FreeDESK_PIM and provide some defined interfaces. Pl..."

2012-08-21T23:46:49Z

Created page with "Plugin modules are the heart of FreeDESK extensibility and are developed in PHP. All plugin modules extend the base class FreeDESK_PIM and provide some defined interfaces. Pl..."

New page

Plugin modules are the heart of FreeDESK extensibility and are developed in PHP. All plugin modules extend the base class FreeDESK_PIM and provide some defined interfaces.

Plugins can register functionality they provide in the main system, register additional pages and menu options for display, register custom API modes and handle request events.

= Plugin Modules (PIMs) =

PIMs provide some or all of the functionality listed in the FreeDESK_PIM module. For a plugin to work it must be installed in a named directory within the plugin folder, have a main PHP file of the same name and the main PIM class within that file of the same name.

<code lang="php">

<?php
/* -------------------------------------------------------------
This file is part of FreeDESK

FreeDESK is (C) Copyright 2012 David Cutting

FreeDESK is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

FreeDESK is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with FreeDESK. If not, see www.gnu.org/licenses

For more information see www.purplepixie.org/freedesk/
-------------------------------------------------------------- */

/**
* FreeDESK_PIM is the abstacr base class for all PIM components
**/
abstract class FreeDESK_PIM
{
/**
* FreeDESK instance
**/
protected $DESK = null;

/**
* File path for PIM
**/
protected $filepath = "";

/**
* Web path for PIM
**/
protected $webpath = "";

/**
* ID for PIM
**/
protected $ID = 0;

/**
* Main Constructor
* @param mixed $freeDESK FreeDESK instance
* @param string $filepath Path to plugin directory (filebase)
* @param string $webpath Path to plugin directory (webpath)
* @param int $id Internal FreeDESK ID for PIM
**/
function FreeDESK_PIM(&$freeDESK, $filepath, $webpath, $id)
{
$this->DESK = &$freeDESK;
$this->filepath = $filepath;
$this->webpath = $webpath;
$this->ID = $id;
}

/**
* Start (when an instance is started from within the system and is installed - to be overriden
**/
function Start()
{
//
}

/**
* Install - to be overriden
**/
function Install()
{
//
}

/**
* Activate - to be overriden
**/
function Activate()
{
//
}

/**
* De-Activate - to be overriden
**/
function Deactivate()
{
//
}

/**
* Uninstall - to be overriden
**/
function Uninstall()
{
//
}

/**
* API Call - to be overriden
* @param string $mode API Mode
**/
function API($mode)
{
//
}

/**
* Event Call - to be overriden
* @param string $event Event
* @param mixed &$data Event data (dependent on the event)
**/
function Event($event, &$data)
{
//
}

/**
* Build any menu items needed - to be overriden
**/
function BuildMenu()
{
//
}

/**
* Page has been called for this plugin - to be overriden
* @param string $page Page identifier
**/
function Page($page)
{
//
}

/**
* Static exec/registration function to list provided interfaces
* @param mixed $DESK Reference to current FreeDESK instance
**/
static function Exec(&$DESK)
{
//
}

}
?>
</code>

← Older revision		Revision as of 23:53, 21 August 2012
Line 443:		Line 443:
	var Workload = new workloadPIM();		var Workload = new workloadPIM();
	</source>		</source>
		+
		+	<source lang="css">
		+	hr.workload
		+	{
		+	color: green;
		+	background-color: green;
		+	border: 0;
		+	}
		+	</source>
		+
		+	For more examples look at the provided example plugins with the system.

@@ Line 7: / Line 7: @@
 PIMs provide some or all of the functionality listed in the FreeDESK_PIM module. For a plugin to work it must be installed in a named directory within the plugin folder, have a main PHP file of the same name and the main PIM class within that file of the same name.
-<code lang="php">
+<source lang="php">
 <?php
@@ Line 158: / Line 158: @@
+}
 ?>
-</code>
+</source>

Developing Plugin Modules - Revision history

Dave at 23:53, 21 August 2012

Dave at 23:52, 21 August 2012

Dave at 23:47, 21 August 2012

Dave: Created page with "Plugin modules are the heart of FreeDESK extensibility and are developed in PHP. All plugin modules extend the base class FreeDESK_PIM and provide some defined interfaces. Pl..."