View source for Gold/Docs/Anatomy of a Search Plugin

== tl;dr; ==

This is intended to become a developer reference.

== How to get your plugin seen by the system ==

The Plugin will live in the <code>htdocs/search</code> directory and needs to extend the <code>PluginSearch</code> class. As with all Mahara plugins the class is loaded from/lives in the <code>lib.php</code> file in the plugin directory.

<pre>
htdocs/search/Mysearch
├── lib
│   └── PluginSearchMysearch.php
├── lib.php
└── version.php
</pre>

To keep things tidy we are adding a <code>lib</code> directory where the class files will live.  This isn't strictly needed, but if your plugin is going to create multiple classes this is a way to keep the line count per file down to a manageable level.  If you are only going to need one class though, skip this and just add it to the <code>lib.php</code> file.

The following methods need to be implemented by your Plugin.
* <code>search_user()</code> : 
* <code>search_group()</code> : 
* <code>group_search_user()</code> : 
* <code>self_search()</code> : 

=== Extras ===

* Implement <code>get_plugin_display_name()</code> to give your plugin a human readable name.

=== Configuration ===