Elgg / Elgg

mod/bookmarks/start.php

<?php
/**
 * Elgg Bookmarks plugin
 *
 * @package ElggBookmarks
 */

/**
 * Bookmark init
 *
 * @return void
 */
function bookmarks_init() {

	// menus
	elgg_register_menu_item('site', [
		'name' => 'bookmarks',
		'text' => elgg_echo('bookmarks'),
		'href' => 'bookmarks/all',
	]);

	elgg_register_plugin_hook_handler('register', 'menu:page', 'bookmarks_page_menu');
	elgg_register_plugin_hook_handler('register', 'menu:owner_block', 'bookmarks_owner_block_menu');

	elgg_register_page_handler('bookmarks', 'bookmarks_page_handler');

	elgg_extend_view('elgg.js', 'bookmarks.js');

	// Register for notifications
	elgg_register_notification_event('object', 'bookmarks', ['create']);
	elgg_register_plugin_hook_handler('prepare', 'notification:create:object:bookmarks', 'bookmarks_prepare_notification');

	// Register bookmarks view for ecml parsing
	elgg_register_plugin_hook_handler('get_views', 'ecml', 'bookmarks_ecml_views_hook');

	// Register a URL handler for bookmarks
	elgg_register_plugin_hook_handler('entity:url', 'object', 'bookmark_set_url');

	// Groups
	add_group_tool_option('bookmarks', elgg_echo('bookmarks:enablebookmarks'), true);
	elgg_extend_view('groups/tool_latest', 'bookmarks/group_module');

	// allow to be liked
	elgg_register_plugin_hook_handler('likes:is_likable', 'object:bookmarks', 'Elgg\Values::getTrue');
}

/**
 * Dispatcher for bookmarks.
 *
 * URLs take the form of
 *  All bookmarks:        bookmarks/all
 *  User's bookmarks:     bookmarks/owner/<username>
 *  Friends' bookmarks:   bookmarks/friends/<username>
 *  View bookmark:        bookmarks/view/<guid>/<title>
 *  New bookmark:         bookmarks/add/<guid> (container: user, group, parent)
 *  Edit bookmark:        bookmarks/edit/<guid>
 *  Group bookmarks:      bookmarks/group/<guid>/all
 *  Bookmarklet:          bookmarks/bookmarklet/<guid> (user)
 *
 * Title is ignored
 *
 * @param array $page URL segments
 * @return bool
 */
function bookmarks_page_handler($page) {

	if (!isset($page[0])) {
		$page[0] = 'all';
	}

	elgg_push_breadcrumb(elgg_echo('bookmarks'), 'bookmarks/all');

	switch ($page[0]) {
		case "all":
			echo elgg_view_resource('bookmarks/all');
			break;

		case "owner":
			echo elgg_view_resource('bookmarks/owner');
			break;

		case "friends":
			echo elgg_view_resource('bookmarks/friends');
			break;

		case "view":
			echo elgg_view_resource('bookmarks/view', [
				'guid' => $page[1],
			]);
			break;

		case "add":
			echo elgg_view_resource('bookmarks/add');
			break;

		case "edit":
			echo elgg_view_resource('bookmarks/edit', [
				'guid' => $page[1],
			]);
			break;

		case 'group':
			echo elgg_view_resource('bookmarks/owner');
			break;

		case "bookmarklet":
			echo elgg_view_resource('bookmarks/bookmarklet', [
				'container_guid' => $page[1],
			]);
			break;

		default:
			return false;
	}

	elgg_pop_context();
	return true;
}

/**
 * Populates the ->getUrl() method for bookmarked objects
 *
 * @param string $hook   'entity:url'
 * @param string $type   'object'
 * @param string $url    current return value
 * @param array  $params supplied params
 *
 * @return void|string bookmarked item URL
 */
function bookmark_set_url($hook, $type, $url, $params) {
	$entity = elgg_extract('entity', $params);
	if (!$entity instanceof ElggBookmark) {
		return;
	}
	
	$title = elgg_get_friendly_title($entity->title);
	return "bookmarks/view/{$entity->guid}/{$title}";
}

/**
 * Add a menu item to an ownerblock
 *
 * @param string         $hook   'register'
 * @param string         $type   'menu:owner_block'
 * @param ElggMenuItem[] $return current return value
 * @param array          $params supplied params
 *
 * @return ElggMenuItem[]
 */
function bookmarks_owner_block_menu($hook, $type, $return, $params) {

	$entity = elgg_extract('entity', $params);
	
	if ($entity instanceof ElggUser) {
		$url = "bookmarks/owner/{$entity->username}";
		$item = new ElggMenuItem('bookmarks', elgg_echo('bookmarks'), $url);
		$return[] = $item;
	} elseif ($entity instanceof ElggGroup) {
		if ($entity->isToolEnabled('bookmarks')) {
			$url = "bookmarks/group/{$entity->guid}/all";
			$item = new ElggMenuItem('bookmarks', elgg_echo('bookmarks:group'), $url);
			$return[] = $item;
		}
	}
	
	return $return;
}

/**
 * Prepare a notification message about a new bookmark
 *
 * @param string                          $hook         Hook name
 * @param string                          $type         Hook type
 * @param Elgg\Notifications\Notification $notification The notification to prepare
 * @param array                           $params       Hook parameters
 * @return Elgg\Notifications\Notification
 */
function bookmarks_prepare_notification($hook, $type, $notification, $params) {
	$entity = $params['event']->getObject();
	$owner = $params['event']->getActor();
	$recipient = $params['recipient'];
	$language = $params['language'];
	$method = $params['method'];

	$descr = $entity->description;
	$title = $entity->title;

	$notification->subject = elgg_echo('bookmarks:notify:subject', [$title], $language);
	$notification->body = elgg_echo('bookmarks:notify:body', [
		$owner->name,
		$title,
		$entity->address,
		$descr,
		$entity->getURL()
	], $language);
	$notification->summary = elgg_echo('bookmarks:notify:summary', [$entity->title], $language);
	$notification->url = $entity->getURL();
	return $notification;
}

/**
 * Add a page menu menu
 *
 * @param string         $hook   'register'
 * @param string         $type   'menu:page'
 * @param ElggMenuItem[] $return current return value
 * @param array          $params supplied params
 *
 * @return void|ElggMenuItem[]
 */
function bookmarks_page_menu($hook, $type, $return, $params) {

The parameter $params is not used and could be removed.

The parameter $type is not used and could be removed.

The parameter $hook is not used and could be removed.

	if (!elgg_is_logged_in()) {
		return;
	}
	// only show bookmarklet in bookmark pages
	if (!elgg_in_context('bookmarks')) {
		return;
	}
	
	$page_owner = elgg_get_page_owner_entity();
	if (!$page_owner) {
		$page_owner = elgg_get_logged_in_user_entity();
	}
	
	if ($page_owner instanceof ElggGroup) {
		$title = elgg_echo('bookmarks:bookmarklet:group');
	} else {
		$title = elgg_echo('bookmarks:bookmarklet');
	}

	$return[] = ElggMenuItem::factory([
		'name' => 'bookmarklet',
		'text' => $title,
		'href' => 'bookmarks/bookmarklet/' . $page_owner->getGUID(),
	]);

	return $return;
}

/**
 * Return bookmarks views to parse for ecml
 *
 * @param string $hook   'get_views'
 * @param string $type   'ecml'
 * @param array  $return current return value
 * @param array  $params supplied params
 *
 * @return array
 */
function bookmarks_ecml_views_hook($hook, $type, $return, $params) {

The parameter $hook is not used and could be removed.

The parameter $type is not used and could be removed.

The parameter $params is not used and could be removed.

	$return['object/bookmarks'] = elgg_echo('item:object:bookmarks');
	return $return;
}

/**
 * Prepare the add/edit form variables
 *
 * @param ElggObject $bookmark A bookmark object.
 * @return array
 */
function bookmarks_prepare_form_vars($bookmark = null) {
	// input names => defaults
	$values = [
		'title' => get_input('title', ''), // bookmarklet support
		'address' => get_input('address', ''),
		'description' => '',
		'access_id' => ACCESS_DEFAULT,
		'tags' => '',
		'container_guid' => elgg_get_page_owner_guid(),
		'guid' => null,
		'entity' => $bookmark,
	];

	if ($bookmark) {
		foreach (array_keys($values) as $field) {
			if (isset($bookmark->$field)) {
				$values[$field] = $bookmark->$field;
			}
		}
	}

	if (elgg_is_sticky_form('bookmarks')) {
		$sticky_values = elgg_get_sticky_values('bookmarks');
		foreach ($sticky_values as $key => $value) {
			$values[$key] = $value;
		}
	}

	elgg_clear_sticky_form('bookmarks');

	return $values;
}

return function() {
	elgg_register_event_handler('init', 'system', 'bookmarks_init');
};