README

Comments ui

This project is licensed under the GPL-3.0-only license

Usage

Composer

First add the following to your composer.json file:

"require": {
  "srag/commentsui": ">=0.1.0"
},

And run a composer install.

If you deliver your plugin, the plugin has it's own copy of this library and the user doesn't need to install the library.

Tip: Because of multiple autoloaders of plugins, it could be, that different versions of this library exists and suddenly your plugin use an older or a newer version of an other plugin!

So I recommand to use srag/librariesnamespacechanger in your plugin.

Trait usage

Your class in this you want to use CommentsUI needs to use the trait CommentsUITrait

...
use srag\CommentsUI\x\Utils\CommentsUITrait;
...
class x {
...
use CommentsUITrait;
...

Comment ActiveRecord

First you need to init the Comment active record class with your own table name prefix. Please add this very early in your plugin code self::comments()->withTableNamePrefix(self::COMMENT_TABLE_NAME_PREFIX)->withPlugin(self::plugin());


Add an update step to your `dbupdate.php`

```php
...
<#x>
<?php
\srag\CommentsUI\x\Comment\Repository::getInstance()->installTables();
?>

and not forget to add an uninstaller step in your plugin class too

...
self::comments()->dropTables();
...

Async ctrl class

...
use srag\CommentsUI\x\Ctrl\AbstractCtrl;
...
/**
 * ...
 *
 * @ilCtrl_isCalledBy srag\Plugins\x\Comment\Ctrl\XCtrl: ilUIPluginRouterGUI
 */
class XCtrl extends AbstractCtrl {
	/**
	 * @inheritDoc
	 */
	public function getCommentsArray(int $report_obj_id, int $report_user_id): array {
		...
	}
}

Languages

Expand you plugin class for installing languages of the library to your plugin

...
	/**
     * @inheritDoc
     */
    public function updateLanguages(/*?array*/ $a_lang_keys = null) : void {
		parent::updateLanguages($a_lang_keys);

		self::comments()->installLanguages();
	}
...

UI usage

...
use srag\Plugins\x\Comment\Ctrl\XCtrl;
...
self::output()->getHTML(self::commentsUI()->withPlugin(self::plugin())->withCtrlClass(new XCtrl()));

Requirements

ILIAS 6.0 - 7.999
PHP >=7.2

srag / commentsui

Maintainers

Details