[ticket/13625] Adding multiple variables to core.viewforum_get_topic_data

Added topics_count, sort_days, sort_key and sort_dir to
core.viewforum_get_topic_data and adjusted the event's comment explaining
it's possible extended purpose now that it has more variables.

PHPBB3-13625
This commit is contained in:
brunoais 2015-02-16 11:31:05 +00:00
parent 088907fe8e
commit b934617a3b

View file

@ -391,15 +391,27 @@ $sql_array = array(
/** /**
* Event to modify the SQL query before the topic data is retrieved * Event to modify the SQL query before the topic data is retrieved
* *
* It may also be used to override the above assigned template vars
*
* @event core.viewforum_get_topic_data * @event core.viewforum_get_topic_data
* @var array forum_data Array with forum data * @var array forum_data Array with forum data
* @var array sql_array The SQL array to get the data of all topics * @var array sql_array The SQL array to get the data of all topics
* @var array topics_count The total number of topics for display
* @var array sort_days The oldest topic displayable in elapsed days
* @var array sort_key The sorting by. It is one of the first character of (in low case):
* Author, Post time, Replies, Subject, Views
* @var array sort_dir Either "a" for ascending or "d" for descending
* @since 3.1.0-a1 * @since 3.1.0-a1
* @change 3.1.0-RC4 Added forum_data var * @change 3.1.0-RC4 Added forum_data var
* @change 3.1.4-RC1 Added topics_count, sort_days, sort_key and sort_dir vars
*/ */
$vars = array( $vars = array(
'forum_data', 'forum_data',
'sql_array', 'sql_array',
'topics_count',
'sort_days',
'sort_key',
'sort_dir',
); );
extract($phpbb_dispatcher->trigger_event('core.viewforum_get_topic_data', compact($vars))); extract($phpbb_dispatcher->trigger_event('core.viewforum_get_topic_data', compact($vars)));