plugin::add_pick_list($code,$list)    [OBSOLETE, USE plugin::return_pick_list() instead]

Create a pick list. This will be a 1-tiered combo with all items listed.

Creates and populates a pick-list for use in document tags. This function will do the same thing that you can do via the Config program, Settings tab, Document tags sub-tab.

$code = String, Pick list code.

$list = Array, pick list contents :

$list = array();
foreach ( [some loop condition] ) {
	$list[] = array(
				'value'=>[value to store in document tag],
				'label'=>[value to display in pick list]
			);
}

plugin::add_pick_list_grouped($code,$list)  [OBSOLETE, USE plugin::return_pick_list() instead]

Create a grouped pick list. This will be a 2-tiered combo with all items grouped by the first character of the label.

Creates and populates a pick-list for use in document tags. This function will do the same thing that you can do via the Config program, Settings tab, Document tags sub-tab.

$code = String, Pick list code.

$list = Array, pick list contents :

$list = array();
foreach ( [some loop condition] ) {
	$list[] = array(
				'value'=>[value to store in document tag],
				'label'=>[value to display in pick list]
			);
}

plugin::alert($msg)

Message popup on the screen. User clicks OK to close the dialogue and continue.

plugin::choose_file($caption,$path,$filter)

File open dialogue. Returns empty string on cancel.

Returns: String or FALSE if cancelled.

plugin::clear_pick_list($code)

Clears the contents from a pick list of the given $code.

plugin::debug()

Displays debug information. Helpful for testing and development of plugins but should be removed or commented out when not being used. Also triggered by the Debug checkbox on the settings tab of the plugin workbench.

plugin::err($msg)

Creates a modal error message popup on the screen. User clicks OK to close the dialogue and continue.

plugin::explorer($file (optional))

Open a Windows explorer. If file specified then opens with that file selected.

plugin::file_list($path)

List of files in given path/folder.

Returns: Array

plugin::folder_add($docstore_path,$folder)

Add a new folder to the document store.

$docstore_path = String, Full path to an existing folder in the document store. Starts with forward slash, all forward slashes. eg. /Pikaia/Invoices

$folder = String, Name of folder to add under the given $docstore_path.

plugin::form($form_title, $fields, $field_size, $defaults, $comment,$types)

Design and present a pop-up form to get input from the user. Returns an array of entered data. Very handy!

$form_title = String, Title displayed in pop-up for window title bar.

$fields = Array of strings listing all of the form field labels. The array order sets the order of the form fields.

$field_size = Array of integers listing the size of each entry field.

$defaults = (optional) Array of mixed default values for each form field.

$types = (optional) Array of string giving the data type of each field. Can be on of 'string', 'password', 'checkbox'. Defaults to string.

$comment = (optional) String of text to display on the form.

Returns: Array of FALSE if cancelled

 Example:

$title = 'Credit while attending outside training/meeting.';

$comment = "\n\nThis form is good for one class, one day, one time frame.\n
You will get credit for all training and incidents within the time frame you specified 
for that given day.\n\nA separate form will be requird for multiples times in one-day 
or multiple days in a month.\n\n";

$fields = array(
			'Date of Attendance', 
			'Time of Attendance (from)', 
			'Time of Attendance (to)', 
			'Type of Event', 
			'Location', 
			'Reason', 
			'Name'
			);

$size = array(80, 80, 80, 400, 400, 400, 400);
$defaults = array('','','','','','','');

// Repeat until user cancels or we have validated input
while (TRUE) {

    // Form displayed
    $data = plugin::form($title, $fields, $size, $defaults,$comment);

    // Returns FALSE if cancelled
    if ( $data === FALSE ) {
        // exit
        return;
    }

    // Validate returned data
    $date = $data[0];
    $time_from = $data[1];
    $time_to = $data[2];
    $type = $data[3];
    $location = $data[4];
    $reason = $data[5];
    $name = $data[6];
    
    // Set defaults to what was entered by the user. 
    //Ensures data that they entered is re-displyed for editing.
    $defaults = $data;
    
    if ( $date == '' ) {
        // Error message popup
        plugin::err('Date required');
        // Try again        
        continue;
    }

    // If we get to here then data is valid, break out of the loop
    break;

}

Arbitrary settings or values that can be saved and read locally on user pc. Used to save individual user settings.

Returns: Mixed

plugin::ini_write($var,$val)

Arbitrary settings or values that can be saved and read locally on user pc. Used to save individual user settings.

plugin::message($msg)

Creates a modal message popup on the screen. User clicks OK to close the dialogue and continue.

plugin::return_pick_list($list)

Create a pick list. This will be a 1-tiered combo with all items listed.

Creates and populates a pick-list for use in document tags.

To use this feature:

1. Save/Edit a copy of the plugin using the Plugin Workbench. On the Settings tab ensure that 'Run for pick lists' is checked.
2. Take a note of the plugin name.
3. Open the Configuration Program, Settings Tab, Document Tags sub-tab.
4. Select or add a document tag that will be a pick list.
5. In the Pick List frame select the 'Plugin' radio button.
6. Select this plugin in the 'Plugin Name' combo.
7. Save.

You have now linked the plugin to that document tag. Whenever anyone edits the contents of that tag this plugin will be
called to generate a pick list of options that the user can choose from.

$list = Array, pick list contents.

Example:

$list = array();
foreach ( [some loop condition] ) {
	$list[] = array(
				'value'=>[value to store in document tag],
				'label'=>[value to display in pick list]
			);
}

plugin::set_order($list,$headings,$title,$win_name)

Pop-up dialogue to display a list of items and let the user manually sort the list into any order.

$list = Array of arrays . List of rows to sort. Each row may have multiple columns.

$headings = (optional) Array of strings used as column headings. 

$title = (optional) String for pop-up dialogue window title.

$win_name = (optional) String used internally as an identifier for the pop-up. Used to save and restore pop-up window size and position.

Returns: Array or FALSE if cancelled.

Example:

$headings = array('Value','Size','Code');      // Defines number of columns
$list = array();
$list[] =  array('A',345,'c1');
$list[] =  array('B',2,'c99');
$list[] =  array('C',99,'c1');
$list[] =  array('D',99,'c1');
$list[] =  array('E',99,'c1');
$list[] =  array('F',99,'c1');
$list[] =  array('G',99,'c1');
$ordered_list = plugin::set_order($list,$headings,'Sort those arrays');
 

plugin::setting_read($var)

Arbitrary settings or values that can be saved and read across all users and plugins. Can be used as a way of sending data between plugins. See also ini_read.

Returns: Mixed

plugin::setting_write($var,$val)

Arbitrary settings or values that can be saved and read across all users and plugins. Can be used as a way of sending data between plugins. See also ini_read.

plugin::start_wait($cmd,$params)

Shell command and wait for completion.

$cmd = String command to run.

$params = (optional) String command line parameters.

plugin::start_no_wait($cmd,$params)

Shell command in background. Continue without waiting for completion.

$cmd = String command to run.

$params = (optional) String command line parameters.

plugin::string($title,$label,$prompt,$default,$err_msg,$width)

Get a string input from the user.

Returns: String

plugin::yes_no($question,$caption)

Ask user a Yes/No question. Returns TRUE/FALSE..

Returns: TRUE|FALSE

Hello World

Copy this into the Plugin PHP Script area.

echo "Hello world"; 
 

Click on the Run/Test button.

You should see Hello world displayed in the console area.

Now include the plugin::debug() funciton to see debug informaiton and a list of data that is available to use in your plugins.

 
plugin::debug(); 
echo "Hello world"; 
 

Click on the Run/Test button.

You will now see the debugger pop-up window. The Input section contains values that you can copy and paste into your plugin.

Using Supplied Values

There is a PHP array , $p, made available to all plugins. This array will contain data and document information that can be used by the plugins. Use the plugin::debug() function to see the $p array contents.  Here is an example plugin that uses some of the supplied values from the debugger pop-up and displays them in a pop-up message.

 
$msg = "Database DSN : ".$p['dsn']."\n\n"; $msg .= "My briefcase is folder : ".$p['briefcase']['root']; 
plugin::message($msg); 
 

Click on the Run/Test button.

Populate a Pick List

echo "Populating pick list : ".$p['plugin']['params']['selection_code']."\n";

// Array of pick list (selection) contents.
$pick_list = array();
$pick_list[] = array('value'=>'mike','label'=>'Mike');
$pick_list[] = array('value'=>'sally','label'=>'Sally');
$pick_list[] = array('value'=>'george','label'=>'George');
$pick_list[] = array('value'=>'mary','label'=>'Mary');

// Replace the pick list contents
plugin::return_pick_list($pick_list);

More Examples ....

Download and import these into your plugin workbench. There you can modify and experiment with these examples.

Hello World PHP Gtk : How to open a window.

Message of the Day : Display a message to all users when they first start the RocketDMS program.

Simple Form : Pop-up window with a form to get user input.

Restrict Folders :  Illustrates how to restrict the running of plugins to certain document store folders.

Calculator in Toolbar :  User selects their own calculator program. Calculator tool added to document list toolbar.

PHP-GTK User Guide : PHP-GTK Reference.

PHP-GTK Cookbook Samples : Many examples of php-gtk scripts. These examples can be pasted as-is as a RocketDMS plugin.

Plugins make a PHP5 interpreter along with the complete PHP-GTK2 gui programming environment available to you.

The scope for extending and customising RocketDMS is vast.

PHP is the programming language used for RocketDMS. All plugins are to be written in PHP. To write plugins in other languages create a small PHP wrapper to run your plugin in a shell.

PHP-GTK is a binding of PHP to the GTK libraries. All PHP-GTK functions are avalable to your plugins. This allows you to build GUI plugins and forms.

This system also gives us the ability to customise RocketDMS for you. We can do this very inexpensively as we do not need to re-compile or re-distribute new program versions to do this. Contact mike@rocketdms.co.nz

Remote or on-site installation.We will install and configure the user RocketDMS program on their PC.

For remote installation our remote support program must be able to run on the PC being installed and connect to our server.  This program makes a single outgoing connection on TCP port 5602. Alternatively you can choose and supply your own desktop sharing system. 

For on-site installation you must cover reasonable travel and accommodation costs.  

Training

Training is a one hour course for up to 3 users at a time using a shared desktop PC and voice. Each course can be tailored for your organisation. At the end of the course each user will be able to use all of the main features of RocketDMS with confidence.

Does not include communication costs such as phone calls and desktop sharing systems.

Support

Users (or a technical support person on behalf of that user) may contact us at any time with questions problems, big or small. We will raise a support ticket and make sure that the issue is resolved as quickly as we can.

The support packages gives you 3 tickets a calendar month. 

No document store or database setup. Subscribe to our cloud service and we will supply you with a document store server via the Internet.