<PluginName> (Directory)
	classes (Directory)
		class.il<PluginName>Plugin.php
		class.ilObj<PluginName>.php
		class.ilObj<PluginName>Access.php
		class.ilObj<PluginName>GUI.php
		class.ilObj<PluginName>ListGUI.php
	lang (Directory)
		ilias_<LangKey>.lang
	sql (Directory)
		dbupdate.php
	templates (Directory)
		images (Directory)
			...
		tpl...html
	plugin.php

<?php
$id = "xtst";
 
// code version; must be changed for all code changes
$version = "0.0.4";
 
// ilias min and max version; must always reflect the versions that should
// run with the plugin
$ilias_min_version = "5.1.0";
$ilias_max_version = "5.2.999";
 
// optional, but useful: Add one or more responsible persons and a contact email
$responsible = "ILIAS Development";
$responsible_mail = "info@ilias.de";
 
$supports_export = true;
 
// Enable learning progress
$learning_progress = true;
?>

<?php
 
include_once("./Services/Repository/classes/class.ilRepositoryObjectPlugin.php");
 
/**
 */
class ilTestRepositoryObjectPlugin extends ilRepositoryObjectPlugin
{
	const ID = "xtst";
 
	// must correspond to the plugin subdirectory
	function getPluginName()
	{
		return "TestRepositoryObject";
	}
 
	protected function uninstallCustom() {
		// TODO: Nothing to do here.
	}
}
?>

<?php
 
include_once("./Services/Repository/classes/class.ilObjectPlugin.php");
require_once("./Services/Tracking/interfaces/interface.ilLPStatusPlugin.php");
require_once("./Customizing/global/plugins/Services/Repository/RepositoryObject/TestRepositoryObject/classes/class.ilObjTestRepositoryObjectGUI.php");
 
/**
 */
class ilObjTestRepositoryObject extends ilObjectPlugin implements ilLPStatusPluginInterface
{
	/**
	 * Constructor
	 *
	 * @access        public
	 * @param int $a_ref_id
	 */
	function __construct($a_ref_id = 0)
	{
		parent::__construct($a_ref_id);
	}
 
	/**
	 * Get type.
	 */
	final function initType()
	{
		$this->setType(ilTestRepositoryObjectPlugin::ID);
	}
 
	/**
	 * Create object
	 */
	function doCreate()
	{
		global $ilDB;
 
		$ilDB->manipulate("INSERT INTO rep_robj_xtst_data ".
			"(id, is_online, option_one, option_two) VALUES (".
			$ilDB->quote($this->getId(), "integer").",".
			$ilDB->quote(0, "integer").",".
			$ilDB->quote("default 1", "text").",".
			$ilDB->quote("default 2", "text").
			")");
	}
 
	/**
	 * Read data from db
	 */
	function doRead()
	{
		global $ilDB;
 
		$set = $ilDB->query("SELECT * FROM rep_robj_xtst_data ".
			" WHERE id = ".$ilDB->quote($this->getId(), "integer")
		);
		while ($rec = $ilDB->fetchAssoc($set))
		{
			$this->setOnline($rec["is_online"]);
		}
	}
 
	/**
	 * Update data
	 */
	function doUpdate()
	{
		global $ilDB;
 
		$ilDB->manipulate($up = "UPDATE rep_robj_xtst_data SET ".
			" is_online = ".$ilDB->quote($this->isOnline(), "integer")."".
			" WHERE id = ".$ilDB->quote($this->getId(), "integer")
		);
	}
 
	/**
	 * Delete data from db
	 */
	function doDelete()
	{
		global $ilDB;
 
		$ilDB->manipulate("DELETE FROM rep_robj_xtst_data WHERE ".
			" id = ".$ilDB->quote($this->getId(), "integer")
		);
	}
 
	/**
	 * Do Cloning
	 */
	function doClone($a_target_id,$a_copy_id,$new_obj)
	{
		global $ilDB;
 
		$new_obj->setOnline($this->isOnline());
		$new_obj->setOptionOne($this->getOptionOne());
		$new_obj->setOptionTwo($this->getOptionTwo());
		$new_obj->update();
	}
 
	/**
	 * Set online
	 *
	 * @param        boolean                online
	 */
	function setOnline($a_val)
	{
		$this->online = $a_val;
	}
 
	/**
	 * Get online
	 *
	 * @return        boolean                online
	 */
	function isOnline()
	{
		return $this->online;
	}
 
	/**
	 * Get all user ids with LP status completed
	 *
	 * @return array
	 */
	public function getLPCompleted() {
		return array();
	}
 
	/**
	 * Get all user ids with LP status not attempted
	 *
	 * @return array
	 */
	public function getLPNotAttempted() {
		return array();
	}
 
	/**
	 * Get all user ids with LP status failed
	 *
	 * @return array
	 */
	public function getLPFailed() {
		return array(6);
	}
 
	/**
	 * Get all user ids with LP status in progress
	 *
	 * @return array
	 */
	public function getLPInProgress() {
		return array();
	}
 
	/**
	 * Get current status for given user
	 *
	 * @param int $a_user_id
	 * @return int
	 */
	public function getLPStatusForUser($a_user_id) {
		global $ilUser;
		if($ilUser->getId() == $a_user_id)
			return $_SESSION[ilObjTestRepositoryObjectGUI::LP_SESSION_ID];
		else
			return ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
	}
}
?>

<#1>
<?php
$fields = array(
	'id' => array(
		'type' => 'integer',
		'length' => 4,
		'notnull' => true
	),
	'is_online' => array(
		'type' => 'integer',
		'length' => 1,
		'notnull' => false
	),
	'option_one' => array(
		'type' => 'text',
		'length' => 10,
		'fixed' => false,
		'notnull' => false
	),
	'option_two' => array(
		'type' => 'text',
		'length' => 10,
		'fixed' => false,
		'notnull' => false
	)
);
 
$ilDB->createTable("rep_robj_xtst_data", $fields);
$ilDB->addPrimaryKey("rep_robj_xtst_data", array("id"));
?>

<?php
 
include_once("./Services/Repository/classes/class.ilObjectPluginGUI.php");
require_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
require_once("./Services/Form/classes/class.ilTextInputGUI.php");
require_once("./Services/Form/classes/class.ilCheckboxInputGUI.php");
require_once("./Services/Tracking/classes/class.ilLearningProgress.php");
require_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
require_once("./Services/Tracking/classes/status/class.ilLPStatusPlugin.php");
require_once("./Customizing/global/plugins/Services/Repository/RepositoryObject/TestRepositoryObject/classes/class.ilTestRepositoryObjectPlugin.php");
 
/**
 * @ilCtrl_isCalledBy ilObjTestRepositoryObjectGUI: ilRepositoryGUI, ilAdministrationGUI, ilObjPluginDispatchGUI
 * @ilCtrl_Calls ilObjTestRepositoryObjectGUI: ilPermissionGUI, ilInfoScreenGUI, ilObjectCopyGUI, ilCommonActionDispatcherGUI, ilExportGUI
 */
class ilObjTestRepositoryObjectGUI extends ilObjectPluginGUI
{
	const LP_SESSION_ID = 'xtst_lp_session_state';
 
	/** @var  ilCtrl */
	protected $ctrl;
 
	/** @var  ilTabsGUI */
	protected $tabs;
 
	/** @var  ilTemplate */
	public $tpl;
 
	/**
	 * Initialisation
	 */
	protected function afterConstructor()
	{
		global $ilCtrl, $ilTabs, $tpl;
		$this->ctrl = $ilCtrl;
		$this->tabs = $ilTabs;
		$this->tpl = $tpl;
	}
 
	public function executeCommand() {
		global $tpl;
 
 
		$next_class = $this->ctrl->getNextClass($this);
		switch ($next_class) {
			case 'ilexportgui':
				// only if plugin supports it?
				$tpl->setTitle($this->object->getTitle());
				$tpl->setTitleIcon(ilObject::_getIcon($this->object->getId()));
				$this->setLocator();
				$tpl->getStandardTemplate();
				$this->setTabs();
				include_once './Services/Export/classes/class.ilExportGUI.php';
				$this->tabs->activateTab("export");
				$exp = new ilExportGUI($this);
				$exp->addFormat('xml');
				$this->ctrl->forwardCommand($exp);
				$tpl->show();
				return;
				break;
		}
 
		$return_value = parent::executeCommand();
 
		return $return_value;
	}
 
	/**
	 * Get type.
	 */
	final function getType()
	{
		return ilTestRepositoryObjectPlugin::ID;
	}
 
	/**
	 * Handles all commmands of this class, centralizes permission checks
	 */
	function performCommand($cmd)
	{
		switch ($cmd)
		{
			case "editProperties":   // list all commands that need write permission here
			case "updateProperties":
			case "saveProperties":
			case "showExport":
				$this->checkPermission("write");
				$this->$cmd();
				break;
 
			case "showContent":   // list all commands that need read permission here
			case "setStatusToCompleted":
			case "setStatusToFailed":
			case "setStatusToInProgress":
			case "setStatusToNotAttempted":
				$this->checkPermission("read");
				$this->$cmd();
				break;
		}
	}
 
	/**
	 * After object has been created -> jump to this command
	 */
	function getAfterCreationCmd()
	{
		return "editProperties";
	}
 
	/**
	 * Get standard command
	 */
	function getStandardCmd()
	{
		return "showContent";
	}
 
//
// DISPLAY TABS
//
 
	/**
	 * Set tabs
	 */
	function setTabs()
	{
		global $ilCtrl, $ilAccess;
 
		// tab for the "show content" command
		if ($ilAccess->checkAccess("read", "", $this->object->getRefId()))
		{
			$this->tabs->addTab("content", $this->txt("content"), $ilCtrl->getLinkTarget($this, "showContent"));
		}
 
		// standard info screen tab
		$this->addInfoTab();
 
		// a "properties" tab
		if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
		{
			$this->tabs->addTab("properties", $this->txt("properties"), $ilCtrl->getLinkTarget($this, "editProperties"));
			$this->tabs->addTab("export", $this->txt("export"), $ilCtrl->getLinkTargetByClass("ilexportgui", ""));
		}
 
		// standard permission tab
		$this->addPermissionTab();
		$this->activateTab();
	}
 
	/**
	 * Edit Properties. This commands uses the form class to display an input form.
	 */
	protected function editProperties()
	{
		$this->tabs->activateTab("properties");
		$form = $this->initPropertiesForm();
		$this->addValuesToForm($form);
		$this->tpl->setContent($form->getHTML());
	}
 
	/**
	 * @return ilPropertyFormGUI
	 */
	protected function initPropertiesForm() {
		$form = new ilPropertyFormGUI();
		$form->setTitle($this->plugin->txt("obj_xtst"));
 
		$title = new ilTextInputGUI($this->plugin->txt("title"), "title");
		$title->setRequired(true);
		$form->addItem($title);
 
		$description = new ilTextInputGUI($this->plugin->txt("description"), "description");
		$form->addItem($description);
 
		$online = new ilCheckboxInputGUI($this->plugin->txt("online"), "online");
		$form->addItem($online);
 
		$form->setFormAction($this->ctrl->getFormAction($this, "saveProperties"));
		$form->addCommandButton("saveProperties", $this->plugin->txt("update"));
 
		return $form;
	}
 
	/**
	 * @param $form ilPropertyFormGUI
	 */
	protected function addValuesToForm(&$form) {
		$form->setValuesByArray(array(
			"title" => $this->object->getTitle(),
			"description" => $this->object->getDescription(),
			"online" => $this->object->isOnline(),
		));
	}
 
	/**
	 *
	 */
	protected function saveProperties() {
		$form = $this->initPropertiesForm();
		$form->setValuesByPost();
		if($form->checkInput()) {
			$this->fillObject($this->object, $form);
			$this->object->update();
			ilUtil::sendSuccess($this->plugin->txt("update_successful"), true);
			$this->ctrl->redirect($this, "editProperties");
		}
		$this->tpl->setContent($form->getHTML());
	}
 
	protected function showContent() {
		$this->tabs->activateTab("content");
		/** @var ilTemplate $template */
		$template = $this->plugin->getTemplate("tpl.content.html");
		/** @var ilObjTestRepositoryObject $object */
		$object = $this->object;
		$template->setVariable("TITLE", $object->getTitle());
		$template->setVariable("DESCRIPTION", $object->getDescription());
		$template->setVariable("ONLINE_STATUS", $object->isOnline()?"Online":"Offline");
		$template->setVariable("ONLINE_COLOR", $object->isOnline()?"green":"red");
 
		$template->setVariable("SET_COMPLETED", $this->ctrl->getLinkTarget($this, "setStatusToCompleted"));
		$template->setVariable("SET_COMPLETED_TXT", $this->plugin->txt("set_completed"));
 
		$template->setVariable("SET_NOT_ATTEMPTED", $this->ctrl->getLinkTarget($this, "setStatusToNotAttempted"));
		$template->setVariable("SET_NOT_ATTEMPTED_TXT", $this->plugin->txt("set_not_attempted"));
 
		$template->setVariable("SET_FAILED", $this->ctrl->getLinkTarget($this, "setStatusToFailed"));
		$template->setVariable("SET_FAILED_TXT", $this->plugin->txt("set_failed"));
 
		$template->setVariable("SET_IN_PROGRESS", $this->ctrl->getLinkTarget($this, "setStatusToInProgress"));
		$template->setVariable("SET_IN_PROGRESS_TXT", $this->plugin->txt("set_in_progress"));
 
		global $ilUser;
		$progress = new ilLPStatusPlugin($this->object->getId());
		$status = $progress->determineStatus($this->object->getId(), $ilUser->getId());
		$template->setVariable("LP_STATUS", $this->plugin->txt("lp_status_".$status));
		$template->setVariable("LP_INFO", $this->plugin->txt("lp_status_info"));
 
		$this->tpl->setContent($template->get());
	}
 
	/**
	 * @param $object ilObjTestRepositoryObject
	 * @param $form ilPropertyFormGUI
	 */
	private function fillObject($object, $form) {
		$object->setTitle($form->getInput('title'));
		$object->setDescription($form->getInput('description'));
		$object->setOnline($form->getInput('online'));
	}
 
	protected function showExport() {
		require_once("./Services/Export/classes/class.ilExportGUI.php");
		$export = new ilExportGUI($this);
		$export->addFormat("xml");
		$ret = $this->ctrl->forwardCommand($export);
 
	}
 
	/**
	 * We need this method if we can't access the tabs otherwise...
	 */
	private function activateTab() {
		$next_class = $this->ctrl->getCmdClass();
 
		switch($next_class) {
			case 'ilexportgui':
				$this->tabs->activateTab("export");
				break;
		}
 
		return;
	}
 
	private function setStatusToCompleted() {
		$this->setStatusAndRedirect(ilLPStatus::LP_STATUS_COMPLETED_NUM);
	}
 
	private function setStatusAndRedirect($status) {
		global $ilUser;
		$_SESSION[self::LP_SESSION_ID] = $status;
		ilLPStatusWrapper::_updateStatus($this->object->getId(), $ilUser->getId());
		$this->ctrl->redirect($this, $this->getStandardCmd());
	}
 
	protected function setStatusToFailed() {
		$this->setStatusAndRedirect(ilLPStatus::LP_STATUS_FAILED_NUM);
	}
 
	protected function setStatusToInProgress() {
		$this->setStatusAndRedirect(ilLPStatus::LP_STATUS_IN_PROGRESS_NUM);
	}
 
	protected function setStatusToNotAttempted() {
		$this->setStatusAndRedirect(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM);
	}
}
?>

<?php
include_once("./Services/Repository/classes/class.ilObjectPluginAccess.php");
 
/**
* Access/Condition checking for Example object
*
* Please do not create instances of large application classes (like ilObjExample)
* Write small methods within this class to determine the status.
*
* @author 		Alex Killing <alex.killing@gmx.de>
* @version $Id$
*/
class ilObjExampleAccess extends ilObjectPluginAccess
{
 
	/**
	* Checks wether a user may invoke a command or not
	* (this method is called by ilAccessHandler::checkAccess)
	*
	* Please do not check any preconditions handled by
	* ilConditionHandler here. Also don't do usual RBAC checks.
	*
	* @param	string	$a_cmd		command (not permission!)
	* @param	string	$a_permission	permission
	* @param	int		$a_ref_id		reference id
	* @param	int		$a_obj_id		object id
	* @param	int		$a_user_id		user id (default is current user)
	*
	* @return	boolean		true, if everything is ok
	*/
	function _checkAccess($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id = "")
	{
		global $ilUser, $ilAccess;
 
		if ($a_user_id == "")
		{
			$a_user_id = $ilUser->getId();
		}
 
		switch ($a_permission)
		{
			case "read":
				if (!ilObjExampleAccess::checkOnline($a_obj_id) &&
					!$ilAccess->checkAccessOfUser($a_user_id, "write", "", $a_ref_id))
				{
					return false;
				}
				break;
		}
 
		return true;
	}
 
	/**
	* Check online status of example object
	*/
	static function checkOnline($a_id)
	{
		global $ilDB;
 
		$set = $ilDB->query("SELECT is_online FROM rep_robj_xexo_data ".
			" WHERE id = ".$ilDB->quote($a_id, "integer")
			);
		$rec  = $ilDB->fetchAssoc($set);
		return (boolean) $rec["is_online"];
	}
 
}
 
?>

<?php
 
include_once "./Services/Repository/classes/class.ilObjectPluginListGUI.php";
 
/**
 * handles the presentation in container items (categories, courses, ...)
 * together with the corresponding ...Access class.
 *
 * PLEASE do not create instances of larger classes here. Use the
 * ...Access class to get DB data and keep it small.
 */
class ilObjTestRepositoryObjectListGUI extends ilObjectPluginListGUI
{
 
	/**
	 * Init type
	 */
	function initType() {
		$this->setType(ilTestRepositoryObjectPlugin::ID);
	}
 
	/**
	 * Get name of gui class handling the commands
	 */
	function getGuiClass()
	{
		return "ilObjTestRepositoryObjectGUI";
	}
 
	/**
	 * Get commands
	 */
	function initCommands()
	{
		return array
		(
			array(
				"permission" => "read",
				"cmd" => "showContent",
				"default" => true),
			array(
				"permission" => "write",
				"cmd" => "editProperties",
				"txt" => $this->txt("edit"),
				"default" => false),
		);
	}
 
	/**
	 * Get item properties
	 *
	 * @return        array                array of property arrays:
	 *                                "alert" (boolean) => display as an alert property (usually in red)
	 *                                "property" (string) => property name
	 *                                "value" (string) => property value
	 */
	function getProperties()
	{
		global $lng, $ilUser;
 
		$props = array();
 
		$this->plugin->includeClass("class.ilObjTestRepositoryObjectAccess.php");
		if (!ilObjTestRepositoryObjectAccess::checkOnline($this->obj_id))
		{
			$props[] = array("alert" => true, "property" => $this->txt("status"),
				"value" => $this->txt("offline"));
		}
 
		return $props;
	}
}
?>

obj_xtst#:#Test Repository Object
objs_xtst#:#Test Repository Objects
obj_xtst_duplicate#:#Copy
objs_xtst_duplicate#:#Copy Test Repository Objects
obj_xtst_select#:#Select Test Repository Object
xtst_add#:#Add Test Repository Object
xtst_new#:#Add New Test Repository Object
xtst_read#:#Read access to Test Repository Object
xtst_write#:#Edit Test Repository Object
xtst_delete#:#Delete Test Repository Object
xtst_visible#:#Test Repository Object is visible
xtst_edit_permission#:#Change permission settings
crs_create_xtst#:#Create Test Repository Object
grp_create_xtst#:#Create Test Repository Object
fold_create_xtst#:#Create Test Repository Object
root_create_xtst#:#Create Test Repository Object
cat_create_xtst#:#Create Test Repository Object
title#:#Title
description#:#Description
online#:#Online
save#:#Save
update#:#Update
properties#:#Properties
content#:#Content
copy#:#Copy
edit#:#Edit
export#:#Export
set_not_attempted#:#Set LP Status to not attempted
set_in_progress#:#Set LP Status to in progress
set_passed#:#Set LP Status to not completed
set_failed#:#Set LP Status to not failed
set_completed#:#Set LP Status to completed
lp_status_0#:#Not Attempted
lp_status_1#:#In Progress
lp_status_2#:#Completed
lp_status_3#:#Failed
lp_status_#:#No state yet.
lp_status_info#:#Attention: Setting the LP Status will set the LP status of the currently logged in user to the chosen Stauts. THE STATUS OF EVERY OTHER USER WILL BE SET TO NOT ATTEMPTED!
offline:#:Offline

<?php
 
include_once("./Services/Repository/classes/class.ilObjectPluginGUI.php");
 
/**
* User Interface class for example repository object.
* ...
* @ilCtrl_isCalledBy ilObjExampleGUI: ilRepositoryGUI, ilAdministrationGUI, ilObjPluginDispatchGUI
* @ilCtrl_Calls ilObjExampleGUI: ilPermissionGUI, ilInfoScreenGUI, ilObjectCopyGUI
* @ilCtrl_Calls ilObjExampleGUI: ilCommonActionDispatcherGUI
*/