@gui

Caveats

This functionality was grown organically to solve a specific UI need, and thus may not be a silver bullet in running PHP applications on the same domain as Deki Wiki. /@gui/'s usage is subject to change in future releases.

Overview

You can pass in any path and parameters to the /@gui/ URL. For example:

/@gui/myfeature/
/@gui/myfeature/?param=value

All calls are rewritten by mod_rewrite to /proxy.php. 

Proxy.php

Proxy.php itself includes 3 files from Deki Wiki: LocalSettings.php, includes/GlobalFunctions.php, and includes/dream.php. These three files are considered the bare minimum overhead to allow /@gui/ to operate on the API. With these three files, you can use Deki Wiki's Plug methods to access all features inside the API.

Creating your own functionality

When you load up proxy.php, you'll see this code path: (this doc is being generated after 1.8.3c, so this code may not exactly  match what's below)

 switch ($requestType)
{
	// default api formatter
	case 'deki':
	
	//extension list
	case 'extensions': 
	//<iframe> for rss updates, so we don't slow down control panel
	case 'updates': 
	// page/file moving functions
	case 'move':
	// editor calls
	case 'editor':
	// link dialog related formatters
	case 'linknavigate':
	case 'linksearch':
		require_once(sprintf('%s/%s.php', FORMATTERS_DIR, $requestType));
		$formatterClass = sprintf('%sFormatter', $requestType);
		$Formatter = new $formatterClass;

		// process request formatter
		$Formatter->format($paths, $params);
		$Formatter->output();
		break;

	default:
		exit();
}

Each of the switch statements corresponds to a feature in /@gui/. For example, using this codepath, we currently have the following features:

• /@gui/deki/
• /@gui/extensions/
• /@gui/updates/
• /@gui/move/
• /@gui/editor/
• /@gui/linknavigate/
• /@gui/linksearch/

If you want to add your own feature, simply add another "case yourfeature:" after one of the existing case values.

 
class MyFeatureFormatter extends RequestFormatter
{
	public function MyFeatureFormatter()
	{
		$this->contentType = 'text/html';
	}
	public function format(&$path, &$params) 
	{
		echo('<p>Paths you sent in:</p>');
		echo('<pre>'.print_r($path, true).'</pre>');
		echo('<p>Parameters you sent in:</p>');
		echo('<pre>'.print_r($params, true).'</pre>');
	}
}

Real Usage

An example of /@gui/ usage is the /deki/ formatter - this will remap anything from the API in a format you'd like. This allows you to remix the data coming back in an optimal format for any functionality you'd like to create in the front-end.

An example /deki/ formatter is the printr formatter: http://wiki.opengarden.org/@gui/deki....format=printr does a print_r() to all data returned from http://wiki.opengarden.org/@api/deki/pages/HOME