makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 14:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/14638] New UCP hooks for subscriptions

Browse source 
Adds various event hooks to the Manage subscriptions page of the User
Control Panel. core.ucp_subscribed_post_data allows us to handle
additional post data from the form that unwatches subscriptions.
core.ucp_main_subscribed_forums_modify_query,
core.ucp_main_topiclist_count_modify_query and
core.ucp_main_topiclist_modify_query all modify the queries used to get
the list of subscribed forums and subscribed/bookmarked topics.
core.ucp_main_subscribed_forum_modify_template_vars and
core.ucp_main_topiclist_topic_modify_template_vars modify the template
variable array associated with each subscribed forum and topic row.

This is a backport to 3.1.x of the code in PR #4318.

PHPBB3-14638
This commit is contained in:
Wesley Fok 2016-08-03 13:15:21 -04:00
parent 734972cc3d
commit 2081a78095
1 changed files with 133 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

148
phpBB/includes/ucp/ucp_main.php
View file

@ -35,7 +35,7 @@ class ucp_main
function main($id, $mode)
{
global $config, $db, $user, $auth, $template, $phpbb_root_path, $phpEx;
global $config, $db, $user, $auth, $template, $phpbb_root_path, $phpEx, $phpbb_dispatcher;
global $request;
switch ($mode)
@ -215,13 +215,20 @@ class ucp_main
$unwatch = (isset($_POST['unwatch'])) ? true : false;
/**
* Read and potentially modify the post data used to remove subscriptions to forums/topics
*
* @event core.ucp_main_subscribed_post_data
* @since 3.1.10-RC1
*/
$phpbb_dispatcher->dispatch('core.ucp_main_subscribed_post_data');
if ($unwatch)
{
if (check_form_key('ucp_front_subscribed'))
{
$forums = array_keys(request_var('f', array(0 => 0)));
$topics = array_keys(request_var('t', array(0 => 0)));
$msg = '';
$forums = array_keys($request->variable('f', array(0 => 0)));
$topics = array_keys($request->variable('t', array(0 => 0)));
if (sizeof($forums) || sizeof($topics))
{
@ -300,6 +307,20 @@ class ucp_main
$tracking_topics = ($tracking_topics) ? tracking_unserialize($tracking_topics) : array();
}
/**
* Modify the query used to retrieve a list of subscribed forums
*
* @event core.ucp_main_subscribed_forums_modify_query
* @var array sql_array The subscribed forums query
* @var array forbidden_forums The list of forbidden forums
* @since 3.1.10-RC1
*/
$vars = array(
'sql_array',
'forbidden_forums',
);
extract($phpbb_dispatcher->trigger_event('core.ucp_main_subscribed_forums_modify_query', compact($vars)));
$sql = $db->sql_build_query('SELECT', $sql_array);
$result = $db->sql_query($sql);
@ -341,7 +362,7 @@ class ucp_main
$last_post_time = $last_post_url = '';
}
$template->assign_block_vars('forumrow', array(
$template_vars = array(
'FORUM_ID' => $forum_id,
'FORUM_IMG_STYLE' => $folder_image,
'FORUM_FOLDER_IMG' => $user->img($folder_image, $folder_alt),
@ -360,8 +381,36 @@ class ucp_main
'S_UNREAD_FORUM' => $unread_forum,
'U_LAST_POST' => $last_post_url,
'U_VIEWFORUM' => append_sid("{$phpbb_root_path}viewforum.$phpEx", 'f=' . $row['forum_id']))
'U_VIEWFORUM' => append_sid("{$phpbb_root_path}viewforum.$phpEx", 'f=' . $row['forum_id'])
);
/**
* Add template variables to a subscribed forum row.
*
* @event core.ucp_main_subscribed_forum_modify_template_vars
* @var array template_vars Array containing the template variables for the row
* @var array row Array containing the subscribed forum row data
* @var int forum_id Forum ID
* @var string folder_image Folder image
* @var string folder_alt Alt text for the folder image
* @var bool unread_forum Whether the forum has unread content or not
* @var string last_post_time The time of the most recent post, expressed as a formatted date string
* @var string last_post_url The URL of the most recent post in the forum
* @since 3.1.10-RC1
*/
$vars = array(
'template_vars',
'row',
'forum_id',
'folder_image',
'folder_alt',
'unread_forum',
'last_post_time',
'last_post_url',
);
extract($phpbb_dispatcher->trigger_event('core.ucp_main_subscribed_forum_modify_template_vars', compact($vars)));
$template->assign_block_vars('forumrow', $template_vars);
}
$db->sql_freeresult($result);
}
@ -401,7 +450,7 @@ class ucp_main
if (isset($_POST['unbookmark']))
{
$s_hidden_fields = array('unbookmark' => 1);
$topics = (isset($_POST['t'])) ? array_keys(request_var('t', array(0 => 0))) : array();
$topics = (isset($_POST['t'])) ? array_keys($request->variable('t', array(0 => 0))) : array();
$url = $this->u_action;
if (!sizeof($topics))
@ -457,7 +506,7 @@ class ucp_main
{
if (check_form_key('ucp_draft'))
{
$drafts = array_keys(request_var('d', array(0 => 0)));
$drafts = array_keys($request->variable('d', array(0 => 0)));
if (sizeof($drafts))
{
@ -480,8 +529,8 @@ class ucp_main
if ($submit && $edit)
{
$draft_subject = utf8_normalize_nfc(request_var('subject', '', true));
$draft_message = utf8_normalize_nfc(request_var('message', '', true));
$draft_subject = $request->variable('subject', '', true);
$draft_message = $request->variable('message', '', true);
if (check_form_key('ucp_draft'))
{
if ($draft_message && $draft_subject)
@ -643,11 +692,12 @@ class ucp_main
*/
function assign_topiclist($mode = 'subscribed', $forbidden_forum_ary = array())
{
global $user, $db, $template, $config, $cache, $auth, $phpbb_root_path, $phpEx, $phpbb_container;
global $user, $db, $template, $config, $cache, $auth, $phpbb_root_path, $phpEx, $phpbb_container, $request, $phpbb_dispatcher;
$table = ($mode == 'subscribed') ? TOPICS_WATCH_TABLE : BOOKMARKS_TABLE;
$start = request_var('start', 0);
/* @var $pagination \phpbb\pagination */
$pagination = $phpbb_container->get('pagination');
$table = ($mode == 'subscribed') ? TOPICS_WATCH_TABLE : BOOKMARKS_TABLE;
$start = $request->variable('start', 0);
// Grab icons
$icons = $cache->obtain_icons();
@ -664,6 +714,23 @@ class ucp_main
AND i.user_id = ' . $user->data['user_id'] . '
AND ' . $db->sql_in_set('t.forum_id', $forbidden_forum_ary, true, true),
);
/**
* Modify the query used to retrieve the count of subscribed/bookmarked topics
*
* @event core.ucp_main_topiclist_count_modify_query
* @var array sql_array The subscribed/bookmarked topics query
* @var array forbidden_forum_ary The list of forbidden forums
* @var string mode The type of topic list ('subscribed' or 'bookmarks')
* @since 3.1.10-RC1
*/
$vars = array(
'sql_array',
'forbidden_forum_ary',
'mode',
);
extract($phpbb_dispatcher->trigger_event('core.ucp_main_topiclist_count_modify_query', compact($vars)));
$sql = $db->sql_build_query('SELECT', $sql_array);
$result = $db->sql_query($sql);
$topics_count = (int) $db->sql_fetchfield('topics_count');
@ -732,6 +799,22 @@ class ucp_main
$sql_array['SELECT'] .= ', tp.topic_posted';
}
/**
* Modify the query used to retrieve the list of subscribed/bookmarked topics
*
* @event core.ucp_main_topiclist_modify_query
* @var array sql_array The subscribed/bookmarked topics query
* @var array forbidden_forum_ary The list of forbidden forums
* @var string mode The type of topic list ('subscribed' or 'bookmarks')
* @since 3.1.10-RC1
*/
$vars = array(
'sql_array',
'forbidden_forum_ary',
'mode',
);
extract($phpbb_dispatcher->trigger_event('core.ucp_main_topiclist_modify_query', compact($vars)));
$sql = $db->sql_build_query('SELECT', $sql_array);
$result = $db->sql_query_limit($sql, $config['topics_per_page'], $start);
@ -769,6 +852,7 @@ class ucp_main
}
}
/* @var $phpbb_content_visibility \phpbb\content_visibility */
$phpbb_content_visibility = $phpbb_container->get('content.visibility');
foreach ($topic_list as $topic_id)
@ -796,7 +880,7 @@ class ucp_main
$view_topic_url = append_sid("{$phpbb_root_path}viewtopic.$phpEx", $view_topic_url_params);
// Send vars to template
$template->assign_block_vars('topicrow', array(
$template_vars = array(
'FORUM_ID' => $forum_id,
'TOPIC_ID' => $topic_id,
'FIRST_POST_TIME' => $user->format_date($row['topic_time']),
@ -838,7 +922,41 @@ class ucp_main
'U_LAST_POST' => append_sid("{$phpbb_root_path}viewtopic.$phpEx", $view_topic_url_params . '&p=' . $row['topic_last_post_id']) . '#p' . $row['topic_last_post_id'],
'U_VIEW_TOPIC' => $view_topic_url,
'U_VIEW_FORUM' => append_sid("{$phpbb_root_path}viewforum.$phpEx", 'f=' . $forum_id),
));
);
/**
* Add template variables to a subscribed/bookmarked topic row.
*
* @event core.ucp_main_topiclist_topic_modify_template_vars
* @var array template_vars Array containing the template variables for the row
* @var array row Array containing the subscribed/bookmarked topic row data
* @var int forum_id ID of the forum containing the topic
* @var int topic_id Topic ID
* @var int replies Number of replies in the topic
* @var string topic_type Topic type
* @var string folder_img Folder image
* @var string folder_alt Alt text for the folder image
* @var array icons Array containing topic icons
* @var bool unread_topic Whether the topic has unread content or not
* @var string view_topic_url The URL of the topic
* @since 3.1.10-RC1
*/
$vars = array(
'template_vars',
'row',
'forum_id',
'topic_id',
'replies',
'topic_type',
'folder_img',
'folder_alt',
'icons',
'unread_topic',
'view_topic_url',
);
extract($phpbb_dispatcher->trigger_event('core.ucp_main_topiclist_topic_modify_template_vars', compact($vars)));
$template->assign_block_vars('topicrow', $template_vars);
$pagination->generate_template_pagination(append_sid("{$phpbb_root_path}viewtopic.$phpEx", 'f=' . $row['forum_id'] . "&t=$topic_id"), 'topicrow.pagination', 'start', $replies + 1, $config['posts_per_page'], 1, true, true);
}