How to write a subtype value into registry via php hook

AlexS 2021-01-14 06:52:34 UTC #1

Dear Developers,

First of all, Happy new Year!

In the following line

EGroupware/egroupware/blob/208817054b57e1ab4d4315a086443362b62a208f/api/js/etemplate/et2_extension_nextmatch_controller.ts#L399


		{
			// Create a generic cancel action in order to cancel drop action
			// applied for all apps plus file and link action.
			drop_cancel = mgr.addAction('drop', 'egw_cancel_drop', this.egw.lang('Cancel'), egw.image('cancel'), function(){},true);
			drop_cancel.set_group('99');
			drop_cancel.acceptedTypes = drop_cancel.acceptedTypes.concat(Object.keys(egw.user('apps')).concat(['link', 'file']));
			this._actionLinks.push (drop_cancel.id);
		}


		// Check if this app supports linking
		if(!egw.link_get_registry(this.dataStorePrefix || this.egw.appName, 'query') ||
			egw.link_get_registry(this.dataStorePrefix || this.egw.appName, 'title'))
		{
			if(drop_action)
			{
				drop_action.remove();
				if(this._actionLinks.indexOf(drop_action.id) >= 0)
				{
					this._actionLinks.splice(this._actionLinks.indexOf(drop_action.id),1);
				}
			}

Nextmatch gets a value for ‘query’ and ‘title’ “callback” based on the dataStorePrefix from the registry.

I have defined 'infolog.infolog_ui’ as a dataStorePrefix

The question is how I can set a value for ‘title’ and ‘query’ in setup/hooks so that egw.link_get_registry can find it
not based on the app but on the above mentioned dataStorePrefix 'infolog.infolog_ui’

Thank you for your support and best regards!

Alex

RalfBecker 2021-01-14 08:59:40 UTC #2

Hi Alex,

you can set the registry for your app with a “search_link” hook:

github.com

EGroupware/egroupware/blob/master/api/src/Link.php#L33


* Please note: this class can NOT and does not need to be initialised, all methods are static
*
* To participate in the linking an applications has to implement the following hooks:
*
* 	/**
*	 * Hook called by link-class to include app in the appregistry of the linkage
*	 *
*	 * @param array|string $location location and other parameters (not used)
*	 * @return array with method-names
*	 *%
*	function search_link($location)
*	{
*		return array(
*			'query' => 'app.class.link_query',		// method to search app for a pattern: array link_query(string $pattern, array $options)
*			'title' => 'app.class.link_title',		// method to return title of an entry of app: string/false/null link_title(int/string $id)
*			'titles' => 'app.class.link_titles',	// method to return multiple titles: array link_title(array $ids)
*			'view'  => array(						// get parameters to view an entry of app
*				'menuaction' => 'app.class.method',
*			),
*			'types' => array(				// Optional list of sub-types to filter (eg organisations), app to handle different queries
*				'type_key' => array(

An example would be eg. InfoLog:

github.com

EGroupware/egroupware/blob/master/infolog/inc/class.infolog_hooks.inc.php#L45




		return $config['group_owners'];
	}


	/**
	 * Hook called by link-class to include infolog in the appregistry of the linkage
	 *
	 * @param array|string $location location and other parameters (not used)
	 * @return array with method-names
	 */
	static function search_link($location)
	{
		unset($location);	// not used, but part of hook signature


		return array(
			'query'      => 'infolog.infolog_bo.link_query',
			'title'      => 'infolog.infolog_bo.link_title',
			'titles'     => 'infolog.infolog_bo.link_titles',
			'view'       => array(
				'menuaction' => 'infolog.infolog_ui.edit',
			),

Ralf

AlexS 2021-01-14 09:49:34 UTC #3

Hello Ralf,
thank you. I have used that before. As I understand this registers i.e. ‘query’ for the app infolog.
But I would like to register ‘query’ for my dataStoreprefix ’infolog.infolog_ui’ . It there a way to do this?

In projectmanager I found

github.com

EGroupware/projectmanager/blob/cdb2b0f9dff631b4f9e31c5dedaf2e3c7ac324ff/inc/class.projectmanager_hooks.inc.php#L81


			'add_id'     => 'link_id',
			'add_popup'  => '900x450',
			'edit'       => array(
				'menuaction' => 'projectmanager.projectmanager_ui.edit',
			),
			'edit_id'    => 'pm_id',
			'edit_popup' => '900x480',
			'file_access' => 'projectmanager.projectmanager_bo.file_access',
			'file_access_user' => true,	// file_access supports 4th parameter $user
			'additional' => array(
				'projectelement' => array(
					'view' => array(
						'menuaction' => 'projectmanager.projectmanager_elements_ui.edit',
					),
					'view_id' => 'pe_id',
					'view_popup' => '600x450',
					'edit' => array(
						'menuaction' => 'projectmanager.projectmanager_elements_ui.edit',
					),
					'edit_id' => 'pe_id',
					'edit_popup' => '600x450',

So it seems that there is a way to hook additional ‘keys’ for an application to the registry.

But the dataStoreprefix ‘projectmanager_elements’ of the project elements has not the same key i.e. ‘projectelement’

github.com

EGroupware/projectmanager/blob/cdb2b0f9dff631b4f9e31c5dedaf2e3c7ac324ff/inc/class.projectmanager_elements_ui.inc.php#L971


					2 => 'Subelements',
					3 => 'Details of subelements',
					4 => 'Cumulated elements too',
					5 => 'Details of cumulated',
				),
				'col_filter' => array('pe_resources' => null),	// default value, to suppress loop
				'order'          =>	'pe_modified',// IO name of the column to sort after (optional for the sortheaders)
				'sort'           =>	'DESC',// IO direction of the sort: 'ASC' or 'DESC'
				'default_cols'   => '!cat_id,pe_used_time_pe_planned_time_pe_replanned_time,legacy_actions',
				'row_id' => 'elem_id',	// pe_app:pe_app_id:pe_id
				'dataStorePrefix' => 'projectmanager_elements',
				'parent_id'      => 'parent_id',
				'is_parent'		 => 'is_parent'
			);
			// use the state of the last session stored in the user prefs
			if (($state = @unserialize($this->prefs['pe_index_state'])))
			{
				$content['nm'] = array_merge($content['nm'],$state);
			}

So I am quite confused…

Thanks again for your support

Alex

RalfBecker 2021-01-14 14:10:19 UTC #4

I just commit something similar for SmallPART, our new online learning app:

It has courses, consisting out of videos/lectures/tests and for tests questions:

regular “smallpart” link-registry defines everything for courses
“smallpart-overlay” defines the link-registry for questions
questions have an own index page / list, which uses “smallpart-overlay” as datastorePrefix
if a question is changed we call Framework::refresh_opener(“smallpart-overlay”, $overlay_id, “edit”)
to make the refresh work, I have to call $temp->set_dom_id(“smallpart-overlay”), as my template is called “smallpart.questions”

Ralf

Nextmatch: Drag and Drop links not working when datastoreprefix is different than application

AlexS 2021-01-14 15:12:01 UTC #5

Hello Ralf,
thank you, it worked
I still an issue with the link creating from Nextmatch, but his is another issue…
BR
Alex