Plugins (v19)

public function __construct($menuInit = FALSE)
{
    if ($menuInit)
    {
        // set $this->menus
        // set $this->authorize
        return;
    }
    // Do something else
}

<?php
/*
**********************
*
* MENU plugin example
*
**********************
*/

/**
* EXAMPLE: wikindx/components/plugins/test/config.php
*/

class test_CONFIG
{
	public $menus = array('plugin1');
    /**
    * $authorize
    *
    * 0 (public readonly access)
    * 1 (login required)
    * 2 (admin only)
    */
	public $authorize = 1;
	public $wikindxVersion = 5.8;
}

<?php
/*****
*	TEST plugin -- English messages.
*
* EXAMPLE: wikindx/components/plugins/test/messages/testMessages.php
*
* '###' is dynamic text to be inserted. e.g. $this->messages->text('helpMePlease', 'method') will replace '###' with 'method' in $this->text['helpMePlease'].
*
*****/

function testMessages()
{
    return [
/**
* Menu items
*/
        "testSub" => "Test plugin...",
        "menu1" => "Test Command 1",
        "menu2" => "Test Command 2",
        "menuHelp" => "Test plugin Help",

/**
* Other messages
*/
        "heading" => "Test Plugin Example",
        "command1" => "This is command 1",
        "command2" => "This is command 2",
        "noMethod" => "No method was input. Try the WIKINDX menu instead",
        "thisModule" => "this module",
        "noHelp" => "No help here. Try ### instead.",
        "helpMePlease" => "The method is ### and here I am.  Sadly, I cannot help.",
/**
* Tooltips
*/
		"tooltip" => "Help text that appears when the mouse hovers over the menu item",
    ];
}

<?php
/**
* EXAMPLE: wikindx/components/plugins/test/index.php
*/

class test_MODULE
{
    private $db;
    private $vars;
    private $html;
    private $messages;
    public $authorize;
    public $menus;

// constructor
	public function __construct($menuInit = FALSE)
	{
		include_once(__DIR__ . DIRECTORY_SEPARATOR . "config.php");
		$config = new test_CONFIG();
		include_once("core/messages/PLUGINMESSAGES.php");
// plugin folder name and generic message filename
		$this->messages = new PLUGINMESSAGES('test', 'testMessages');
		$this->session = FACTORY_SESSION::getInstance();
		$this->authorize = $config->authorize;
		if($menuInit)
		{
			$this->makeMenu($config->menus);
			return; // Need do nothing more as this is simply menu initialisation.
		}

		$authorize = FACTORY_AUTHORIZE::getInstance();
		if(!$authorize->isPluginExecutionAuthorised($this->authorize)) // not authorised
			FACTORY_CLOSENOMENU::getInstance(); // die

		$this->db = FACTORY_DB::getInstance();
		$this->vars = GLOBALS::getVars();
	}
/**
* Make the menu items
*
* $this->menus must exist and be public and can be in two forms:
* 1. a simple menu array without hierarchy under one of the available WIKINDX menu headings
* or
* 2. a menu comprising at least one submenu (each submenu can have its own submenu).
*
* Top level menu labels are: "wikindx", "res", "search", "metadata", "admin", "plugin1", "plugin2", "plugin3".
* "admin" is only available when logged in as admin, "text" will only show if there are metadata (quotes etc.)
* and the three 'pluginX' menu trees only show if they are populated.
* Typically, you will insert a submenu into one of the pluginX menus.
*
* The command to be executed when the user selects that option is the value of each member of the sub array and must be a public method (see below).
* In order to see the menu command when building and testing your menus, you must have declared the command's public method.
* Only in the case of a submenu (see $menu2 below) must the first element of the submenu tree have a FALSE value.
*/
	private function makeMenu($menuArray)
	{
// This first example shows 3 commands appearing simply in two menus -- solely for demonstration purposes
		$menus1[1][] => // top level menu label
			[
				'text' => $this->messages->text('menu1'),
				'link' => "command1",
				'tooltip' => $this->messages->text('tooltip')
			],
		$menus1[1][] => // top level menu label
			[
				'text' => $this->messages->text('menu2'),
				'link' => "command2",
				'tooltip' => ''
			],
		$menus1[0][] => // top level menu label
			[
				'text' => $this->messages->text('menuHelp'),
				'link' => "helpMe",
				'tooltip' => ''
			];
// This second example shows 3 commands appearing under one menu as a submenu -- the example uses this configuration
// 'xxxpluginSub' must be a unique name otherwise you risk overwriting other plugins
		$submenu[] = [
			'text' => $this->messages->text('menu1'),
			'link' => "command1",
			'tooltip' => ''
		];
		$submenu[] = [
			'text' => $this->messages->text('menu2'),
			'link' => "command2",
			'tooltip' => ''
		];
		$submenu[] = [
			'text' => $this->messages->text('menuHelp'),
			'link' => "helpMe",
			'tooltip' => ''
		];
		$menus2[0][] =>
		[
			'text' => $this->messages->text('testSub'),
			'link' => FALSE, // Must be FALSE
			'tooltip' => '',
			'submenu' => $submenu
		];
		$this->menus = $menus2;
	}
/**
* The name of this public function must be the same as one of the 'link' elements in a sub array of $this->menus
*/
	public function command1()
	{
		GLOBALS::setTplVar('heading', $this->messages->text('heading'));
		$pString = \HTML\p($this->messages->text('command1'));
		if(array_key_exists('method', $this->vars))
			$pString .= $this->{$this->vars['method']}();
		else
			$pString .= $this->messages->text('noMethod');
		GLOBALS::setTplVar('content', $pString);
	}
/**
* The name of this public function must be the same as one of the array values in a sub array of $this->menus
*/
	public function command2()
	{
		GLOBALS::setTplVar('heading', $this->messages->text('heading'));
		GLOBALS::setTplVar('content', $pString);
	}
/**
* The name of this public function must be the same as one of the array values in a sub array of $this->menus
*/
	public function helpMe()
	{
		GLOBALS::setTplVar('heading', $this->messages->text('heading'));
		$link = \HTML\a("link", $this->messages->text('thisModule'),
			htmlentities("index.php?action=test_command1&method=helpMePlease"));
		$pString = $this->messages->text('noHelp', $link);
		GLOBALS::setTplVar('content', $pString);
	}
/**
* A private method not referenced in the menus
*/
	private function helpMePlease()
	{
		return $this->messages->text('helpMePlease', \HTML\em($this->vars['method']));
	}
}

<?php
/*
**********************
*
* IN-LINE plugin example
*
**********************
*/

/*
* Example of an in-line plugin.  This inserts the phrase 'Hello sailor!' wherever the template
* designer has placed the 'inline1' container. In the default template that comes with WIKINDX,
* 'inline1' appears in content.tpl in the paging display and will print 'Hello sailor!' in bold in front
* of paging links when displaying lists.
*/
class inline1_MODULE
{
// constructor
	public function __construct()
	{
		GLOBALS::setTplVar('inline1', \HTML\strong('Hello sailor!'));
	}
}