Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/forum/src/ForumManagerInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\forum\ForumManagerInterface.
6	*/
7
8	namespace Drupal\forum;
9
10	use Drupal\Core\Session\AccountInterface;
11	use Drupal\node\NodeInterface;
12
13	/**
14	* Provides forum manager interface.
15	*/
16	interface ForumManagerInterface {
17
18	/**
19	* Gets list of forum topics.
20	*
21	* @param int $tid
22	* Term ID.
23	* @param \Drupal\Core\Session\AccountInterface $account
24	* Account to fetch topics for.
25	*
26	* @return array
27	* Array with keys 'topics' and 'header'.
28	*/
29	public function getTopics($tid, AccountInterface $account);
30
31	/**
32	* Utility method to fetch the child forums for a given forum.
33	*
34	* @param int $vid
35	* The forum vocabulary ID.
36	* @param int $tid
37	* The forum ID to fetch the children for.
38	*
39	* @return array
40	* Array of children.
41	*/
42	public function getChildren($vid, $tid);
43
44	/**
45	* Generates and returns the forum index.
46	*
47	* The forum index is a pseudo term that provides an overview of all forums.
48	*
49	* @return \Drupal\taxonomy\TermInterface
50	* A pseudo term representing the overview of all forums.
51	*/
52	public function getIndex();
53
54	/**
55	* Resets the ForumManager index and history.
56	*/
57	public function resetCache();
58
59	/**
60	* Fetches the parent forums for a given forum.
61	*
62	* @param int $tid
63	* Term ID.
64	*
65	* @return array
66	* Array of parent terms.
67	*
68	* @deprecated Scheduled to be removed in 9.0.x, see
69	* https://www.drupal.org/node/2371593.
70	*/
71	public function getParents($tid);
72
73	/**
74	* Checks whether a node can be used in a forum, based on its content type.
75	*
76	* @param \Drupal\node\NodeInterface $node
77	* A node entity.
78	*
79	* @return bool
80	* Boolean indicating if the node can be assigned to a forum.
81	*/
82	public function checkNodeType(NodeInterface $node);
83
84	/**
85	* Calculates the number of new posts in a forum that the user has not yet read.
86	*
87	* Nodes are new if they are newer than HISTORY_READ_LIMIT.
88	*
89	* @param int $term
90	* The term ID of the forum.
91	* @param int $uid
92	* The user ID.
93	*
94	* @return
95	* The number of new posts in the forum that have not been read by the user.
96	*/
97	public function unreadTopics($term, $uid);
98
99	}