Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/comment/src/CommentStatisticsInterface.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	* @file
4	* Contains \Drupal\comment\CommentStatisticsInterface.
5	*/
6
7	namespace Drupal\comment;
8
9	use Drupal\Core\Entity\FieldableEntityInterface;
10	use Drupal\Core\Entity\EntityInterface;
11
12	/**
13	* Provides an interface for storing and retrieving comment statistics.
14	*/
15	interface CommentStatisticsInterface {
16
17	/**
18	* Returns an array of ranking information for hook_ranking().
19	*
20	* @return array
21	* Array of ranking information as expected by hook_ranking().
22	*
23	* @see hook_ranking()
24	* @see comment_ranking()
25	*/
26	public function getRankingInfo();
27
28	/**
29	* Read comment statistics records for an array of entities.
30	*
31	* @param \Drupal\Core\Entity\EntityInterface[] $entities
32	* Array of entities on which commenting is enabled, keyed by id
33	* @param string $entity_type
34	* The entity type of the passed entities.
35	* @param bool $accurate
36	* (optional) Indicates if results must be completely up to date. If set to
37	* FALSE, a replica database will used if available. Defaults to TRUE.
38	*
39	* @return object[]
40	* Array of statistics records.
41	*/
42	public function read($entities, $entity_type, $accurate = TRUE);
43
44	/**
45	* Delete comment statistics records for an entity.
46	*
47	* @param \Drupal\Core\Entity\EntityInterface $entity
48	* The entity for which comment statistics should be deleted.
49	*/
50	public function delete(EntityInterface $entity);
51
52	/**
53	* Update or insert comment statistics records after a comment is added.
54	*
55	* @param \Drupal\comment\CommentInterface $comment
56	* The comment added or updated.
57	*/
58	public function update(CommentInterface $comment);
59
60	/**
61	* Find the maximum number of comments for the given entity type.
62	*
63	* Used to influence search rankings.
64	*
65	* @param string $entity_type
66	* The entity type to consider when fetching the maximum comment count for.
67	*
68	* @return int
69	* The maximum number of comments for and entity of the given type.
70	*
71	* @see comment_update_index()
72	*/
73	public function getMaximumCount($entity_type);
74
75	/**
76	* Insert an empty record for the given entity.
77	*
78	* @param \Drupal\Core\Entity\FieldableEntityInterface $entity
79	* The created entity for which a statistics record is to be initialized.
80	* @param array $fields
81	* Array of comment field definitions for the given entity.
82	*/
83	public function create(FieldableEntityInterface $entity, $fields);
84
85	}